Reference documentation for the HoneyHive Logger
/events
endpoints. With no external dependencies, it’s particularly well-suited for serverless execution and regulated environments with strict security requirements.
npm install @honeyhive/logger
start(options)
Object
): Configuration options for starting a session.
string
, required if not set via env): Your HoneyHive API key. Can be set via HH_API_KEY
env var.string
, required if not set via env): The project name. Can be set via HH_PROJECT
env var.string
, optional): Tag to filter sessions (e.g., “v1”, “au1i249c”). Defaults to project name.string
, optional): Environment identifier. Defaults to “dev” or HH_SOURCE
env var.Object
, optional): Configuration details like experiment versions, model names, etc.Object
, optional): Input parameters for the session.Object
, optional): Additional metadata for the session.Object
, optional): User-defined properties for the session.string
, optional): A valid UUIDv4 for correlation. Generated if not provided.string
, optional): HoneyHive API server URL. Defaults to “https://api.honeyhive.ai” or HH_API_URL
env var.boolean
, optional): Enable detailed error messages. Defaults to false.Promise<string>
: The session ID (UUIDv4)
Example:
log(options)
Object
): Configuration options for logging an event.
string
, required if not set via env): Your HoneyHive API key. Can be set via HH_API_KEY
env var.string
, required if not set via env): The project name. Can be set via HH_PROJECT
env var.string
, required): The session ID to log the event under.string
, required): Name of the event being logged.string
, optional): Type of event - “model”, “tool”, or “chain”. Defaults to “tool”.Object
, optional): Configuration details for the event.Object
, optional): Input parameters for the event.Object
, optional): Output data from the event.Object
, optional): Additional metadata for the event.number
, optional): Duration of the event in milliseconds. Defaults to 10.string
, optional): HoneyHive API server URL. Defaults to “https://api.honeyhive.ai” or HH_API_URL
env var.boolean
, optional): Enable detailed error messages. Defaults to false.Promise<string>
: The event ID (UUIDv4)
Example:
update(options)
Object
): Configuration options for updating an event or session.
string
, required if not set via env): Your HoneyHive API key. Can be set via HH_API_KEY
env var.string
, required): The ID to update (can be either a session_id or event_id).Object
, optional): Additional metadata to add.Object
, optional): User feedback data.Object
, optional): Computed metrics data.Object
, optional): Updated configuration data.Object
, optional): Additional output data.Object
, optional): Updated user-defined properties.number
, optional): Duration in milliseconds.string
, optional): HoneyHive API server URL. Defaults to “https://api.honeyhive.ai” or HH_API_URL
env var.boolean
, optional): Enable detailed error messages. Defaults to false.Promise<void>
Example:
verbose
mode is enabled, detailed error information is thrown as exceptions. In non-verbose mode, errors are logged to the console and functions return null
or void.
HH_API_KEY
: Your HoneyHive API keyHH_PROJECT
: Your project nameHH_SOURCE
: Environment identifierHH_API_URL
: HoneyHive API server URL