Class DatadogPropagator

java.lang.Object
codes.grow.packages.datadogapm.DatadogPropagator
All Implemented Interfaces:
io.opentelemetry.context.propagation.TextMapPropagator

public final class DatadogPropagator extends Object implements io.opentelemetry.context.propagation.TextMapPropagator
Datadog header propagation (x-datadog-*) with ddtrace's conflict rules (API.md section 3, DECISIONS.md #5). Implemented from Datadog's documented header format; no ddtrace code is used.

Injects and extracts x-datadog-trace-id (low 64 bits, decimal), x-datadog-parent-id (decimal), x-datadog-sampling-priority (1/0) and, for 128-bit ids, x-datadog-tags: _dd.p.tid=<high 64 bits hex>.

Conflict rules on extract (ddtrace's behaviour with style order datadog,tracecontext): when the carrier also holds a valid traceparent,

The rules apply whatever position datadog has in the propagator list; DatadogTracing.orderPropagators(java.util.List<java.lang.String>) puts tracecontext first so an existing tracestate is kept.

  • Field Details

    • TRACE_ID_HEADER

      public static final String TRACE_ID_HEADER
      x-datadog-trace-id: low 64 bits of the trace id, unsigned decimal.
      See Also:
    • PARENT_ID_HEADER

      public static final String PARENT_ID_HEADER
      x-datadog-parent-id: span id, unsigned decimal.
      See Also:
    • SAMPLING_PRIORITY_HEADER

      public static final String SAMPLING_PRIORITY_HEADER
      x-datadog-sampling-priority: 1 sampled, 0 not sampled.
      See Also:
    • TAGS_HEADER

      public static final String TAGS_HEADER
      x-datadog-tags: propagated tags, e.g. _dd.p.tid=<high 64 bits hex>.
      See Also:
    • ORIGIN_HEADER

      public static final String ORIGIN_HEADER
      x-datadog-origin: origin of the trace (synthetics, rum, ...).
      See Also:
    • NAME

      public static final String NAME
      Name of this propagator in TracingConfig propagator lists.
      See Also:
  • Method Details

    • getInstance

      public static DatadogPropagator getInstance()
      The shared instance.
      Returns:
      propagator
    • extractDatadogContext

      public static <C> Optional<io.opentelemetry.api.trace.SpanContext> extractDatadogContext(C carrier, io.opentelemetry.context.propagation.TextMapGetter<C> getter)
      Reads the Datadog headers of a carrier into a remote span context. A missing sampling priority counts as sampled.
      Type Parameters:
      C - carrier type
      Parameters:
      carrier - carrier
      getter - getter
      Returns:
      the context, or empty when the headers are missing or invalid
    • extractDatadogContext

      public static Optional<io.opentelemetry.api.trace.SpanContext> extractDatadogContext(Map<String,String> headers)
      extractDatadogContext(Object, TextMapGetter) for a string map (keys match case-insensitively).
      Parameters:
      headers - headers
      Returns:
      the context, or empty
    • inject

      public <C> void inject(io.opentelemetry.context.Context context, C carrier, io.opentelemetry.context.propagation.TextMapSetter<C> setter)
      Specified by:
      inject in interface io.opentelemetry.context.propagation.TextMapPropagator
    • extract

      public <C> io.opentelemetry.context.Context extract(io.opentelemetry.context.Context context, C carrier, io.opentelemetry.context.propagation.TextMapGetter<C> getter)
      Specified by:
      extract in interface io.opentelemetry.context.propagation.TextMapPropagator
    • fields

      public List<String> fields()
      Specified by:
      fields in interface io.opentelemetry.context.propagation.TextMapPropagator
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • terminatedContext

      public static Optional<DatadogPropagator.TerminatedContext> terminatedContext(io.opentelemetry.context.Context context)
      The W3C context that lost against Datadog headers during extract.
      Parameters:
      context - extracted context
      Returns:
      the terminated context, or empty
    • terminatedContextLinks

      public static List<io.opentelemetry.sdk.trace.data.LinkData> terminatedContextLinks(io.opentelemetry.context.Context context)
      The span links for a span started from an extracted context: one link to the terminated W3C context (reason=terminated_context, context_headers=tracecontext), or none. Add them (for example with SpanBuilder.addLink) when you export spans without DatadogTracing.initTracing().
      Parameters:
      context - extracted context
      Returns:
      zero or one link