Interface APMTraceApiGetPrunedTraceByIDRequest

Hierarchy

  • APMTraceApiGetPrunedTraceByIDRequest

Properties

expandSpanId?: number

Span ID to expand and preserve in the pruned tree even when its branch would normally be summarized.

forceSource?: string

Force the trace to be loaded from a specific source. When unset, the API picks the source automatically.

includePath?: string[]

Restrict the pruned tree to spans matching the given key:value pairs. Values may be passed as repeated query parameters.

onlyServiceEntrySpans?: boolean

When set to true, only service entry spans are included in the pruned tree.

tagExclude?: string[]

Regex patterns of tag keys whose values must be excluded from the pruned spans. Values may be passed as repeated query parameters.

tagInclude?: string[]

Regex patterns of tag keys whose values must be included in the pruned spans. Values may be passed as repeated query parameters.

timeHint?: number

Optional Unix time hint, in seconds, used to optimize the lookup of the trace in long-term storage.

traceId: string

The trace ID. Accepts either a hexadecimal string of up to 32 characters (128-bit trace ID) or a decimal string of up to 39 digits. Hexadecimal IDs are case-insensitive, and shorter values are left-padded with zeros. Use the trace_id attribute of a span returned by the Search spans or Get a list of spans endpoints. Values in any other format, such as UUIDs, return 400 Bad Request. A well-formed ID with no matching trace returns 404 Not Found.

Generated using TypeDoc