TRACE_HEADER_KEYS | @recallgraph/foxx-tracer

The HTTP header keys that are used to control tracing behaviour and for setting trace context.

Index

Enumeration members

BAGGAGE

BAGGAGE: = "x-baggage"

A JSON object containing key-value pairs that will set as the baggage for all spans recorded for this request.

FORCE_SAMPLE

FORCE_SAMPLE: = "x-force-sample"

An optional boolean that control whether the decision to record a trace should be forced, suppressed or be left to the application to decide. If true a sample is forced. If false no sample is taken. If left blank, the application decides based on the sampling-probability configuration parameter.

PARENT_SPAN_ID

PARENT_SPAN_ID: = "x-parent-span-id"

A span ID (belonging to an ongoing trace) under which to create the top level span of the traced request. This header must be accompanied by a non-emtpy TRACE_ID header. All spans generated with the application will now have this span ID as an ancestor.

TRACE_ID

TRACE_ID: = "x-trace-id"

The trace ID under which to record all new spans. If unspecified, a new trace is started and is assigned a randomly generated UUID.

Note that if a new trace is started by foxx-tracer, the subsequent root span's span ID will not be same as the generated trace ID.