Hanzo
OpenapiO11y

Lists a project's captured error events, newest first, optionally narrowed to…

Lists a project's captured error events, newest first, optionally narrowed to those whose message or exception text contains a search string.

GET /v1/o11y/sentinel/logs

Addresshttps://api.hanzo.ai/v1/o11y/sentinel/logs
MethodGET
Operationget_o11y_sentinel_logs
AuthAuthorization: Bearer $HANZO_API_KEY

Lists a project's captured error events, newest first, optionally narrowed to those whose message or exception text contains a search string.

Request

4 fields.

FieldInTypeRequiredDescription
projectquerystringyesProject is the project to read, as its id.
queryquerystringQuery narrows the page to events whose text contains it.
periodquerystringPeriod is the window to read, relative to now — 1h, 24h, 7d, 14d, 30d.
limitqueryintegerLimit caps how many events come back.

Response

StatusBodyMeaning
200o11y.O11yLogsOutok

200 body — 34 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yEvents
data.itemsbodyo11y.O11yEvent[]Items are the events, newest first.
data.items[].culpritbodystringCulprit is where it came from — the function or route blamed for it.
data.items[].environmentbodystringEnvironment is the deployment it happened in.
data.items[].eventIdbodystringEventID is its own id.
data.items[].fingerprintbodystringFingerprint is the grouping key that puts like errors in one issue.
data.items[].framesbodyo11y.O11yFrame[]Frames are the stack, innermost first.
data.items[].frames[].columnbodyintegerColumn is the column number.
data.items[].frames[].filebodystringFile is the file it is in.
data.items[].frames[].functionbodystringFunction is the function the frame is in.
data.items[].frames[].linebodyintegerLine is the line number.
data.items[].frames[].ownbodybooleanOwn marks a frame in the reporting application's own code rather than in a dependency or the runtime.
data.items[].handledbodybooleanHandled says whether the application caught it.
data.items[].levelbodystringLevel is its severity, e.g.
data.items[].messagebodystringMessage is the human-readable message.
data.items[].orgIdbodystringOrgID is the org that owns it.
data.items[].platformbodystringPlatform is the reporting runtime, e.g.
data.items[].projectIdbodystringProjectID is the project it was captured for.
data.items[].receivedAtbodystring (date-time)ReceivedAt is when it arrived here.
data.items[].releasebodystringRelease is the version that produced it.
data.items[].serverNamebodystringServerName is the host that reported it.
data.items[].serviceNamebodystringServiceName is the service that reported it.
data.items[].spanIdbodystringSpanID is the span it belonged to.
data.items[].tagsbodyobjectTags are the reporter's own key/value labels.
data.items[].tags.*bodystring
data.items[].timestampbodystring (date-time)Timestamp is when the error happened, as the reporter recorded it.
data.items[].traceIdbodystringTraceID is the trace it belonged to.
data.items[].transactionbodystringTransaction is the operation it happened in.
data.items[].typebodystringType is the exception type.
data.items[].userEmailbodystringUserEmail is that user's email, when attached.
data.items[].userIdbodystringUserID identifies the affected end user, when the reporter attached one.
data.items[].userIpbodystringUserIP is that user's address, when attached.
data.items[].valuebodystringValue is the exception value.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page