Skip to Content
ReferenceLogging

Logging Reference

Gateway

The gateway writes JSON Lines to stdout.

Request event fields:

FieldDescription
request_idULID request identifier
timestampevent time
eventrequest or control event name
capabilitycapability name when available
api_key_nameAPI key name from config
http_statusresponse status
error_codestable error code or null
error_messagesame public value as the API response error.message, or null
duration_msrequest duration

Gateway stdout excludes submitted param values, SQL, DB credentials, agent raw detail, plaintext API keys, and agent private keys.

OpenAPI metadata events:

EventFieldsDescription
openapi_cachedpathsEmitted after gateway caches agent metadata. This is always summary-only.
openapi_snapshotpaths, openapiEmitted only when GATEWAY_EMIT_OPENAPI_SNAPSHOT=true. openapi contains the full cached OpenAPI document, including gateway-added servers, securitySchemes, and security.

openapi_snapshot contains unfiltered OpenAPI metadata for the connected agent. It still must not contain SQL or DB credentials, but it may contain public descriptions, parameter names, and result schema names from capability.yaml.

Agent

Agent local detail log:

onprest-agent.log

Rotation is controlled by:

logging: max_size: 10MB max_files: 3

max_size defaults to 10MB; max_files defaults to 3. Agent stdout is for process-level events. DB-specific runtime detail belongs in the local detail log. OS service managers may redirect agent stdout/stderr to separate process log files; those files do not replace onprest-agent.log.