Hanzo
OpenapiO11y

Returns one trace's captured errors for a project — every error event that…

Returns one trace's captured errors for a project — every error event that carried the trace id, in the order the events plane holds them.

GET /v1/o11y/sentinel/traces/{id}

Addresshttps://api.hanzo.ai/v1/o11y/sentinel/traces/{id}
MethodGET
Operationget_o11y_sentinel_traces_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one trace's captured errors for a project — every error event that carried the trace id, in the order the events plane holds them.

Request

2 fields.

FieldInTypeRequiredDescription
idpathstringyesID is the trace id.
projectquerystringyesProject is the project the trace's errors belong to.

Response

StatusBodyMeaning
200o11y.O11yTraceOutok

200 body — 35 fields.

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