tracecontext.py 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  1. # Copyright The OpenTelemetry Authors
  2. # SPDX-License-Identifier: Apache-2.0
  3. #
  4. import re
  5. from opentelemetry import trace
  6. from opentelemetry.context.context import Context
  7. from opentelemetry.propagators import textmap
  8. from opentelemetry.trace import format_span_id, format_trace_id
  9. from opentelemetry.trace.span import TraceState
  10. class TraceContextTextMapPropagator(textmap.TextMapPropagator):
  11. """Extracts and injects using w3c TraceContext's headers."""
  12. _TRACEPARENT_HEADER_NAME = "traceparent"
  13. _TRACESTATE_HEADER_NAME = "tracestate"
  14. _TRACEPARENT_HEADER_FORMAT = (
  15. "^[ \t]*([0-9a-f]{2})-([0-9a-f]{32})-([0-9a-f]{16})-([0-9a-f]{2})"
  16. + "(-.*)?[ \t]*$"
  17. )
  18. _TRACEPARENT_HEADER_FORMAT_RE = re.compile(_TRACEPARENT_HEADER_FORMAT)
  19. def extract(
  20. self,
  21. carrier: textmap.CarrierT,
  22. context: Context | None = None,
  23. getter: textmap.Getter[textmap.CarrierT] = textmap.default_getter,
  24. ) -> Context:
  25. """Extracts SpanContext from the carrier.
  26. See `opentelemetry.propagators.textmap.TextMapPropagator.extract`
  27. """
  28. if context is None:
  29. context = Context()
  30. header = getter.get(carrier, self._TRACEPARENT_HEADER_NAME)
  31. if not header:
  32. return context
  33. match = re.search(self._TRACEPARENT_HEADER_FORMAT_RE, header[0])
  34. if not match:
  35. return context
  36. version: str = match.group(1)
  37. trace_id: str = match.group(2)
  38. span_id: str = match.group(3)
  39. trace_flags: str = match.group(4)
  40. if trace_id == "0" * 32 or span_id == "0" * 16:
  41. return context
  42. if version == "00":
  43. if match.group(5): # type: ignore
  44. return context
  45. if version == "ff":
  46. return context
  47. tracestate_headers = getter.get(carrier, self._TRACESTATE_HEADER_NAME)
  48. if tracestate_headers is None:
  49. tracestate = None
  50. else:
  51. tracestate = TraceState.from_header(tracestate_headers)
  52. span_context = trace.SpanContext(
  53. trace_id=int(trace_id, 16),
  54. span_id=int(span_id, 16),
  55. is_remote=True,
  56. trace_flags=trace.TraceFlags(int(trace_flags, 16)),
  57. trace_state=tracestate,
  58. )
  59. return trace.set_span_in_context(
  60. trace.NonRecordingSpan(span_context), context
  61. )
  62. def inject(
  63. self,
  64. carrier: textmap.CarrierT,
  65. context: Context | None = None,
  66. setter: textmap.Setter[textmap.CarrierT] = textmap.default_setter,
  67. ) -> None:
  68. """Injects SpanContext into the carrier.
  69. See `opentelemetry.propagators.textmap.TextMapPropagator.inject`
  70. """
  71. span = trace.get_current_span(context)
  72. span_context = span.get_span_context()
  73. if span_context == trace.INVALID_SPAN_CONTEXT:
  74. return
  75. traceparent_string = f"00-{format_trace_id(span_context.trace_id)}-{format_span_id(span_context.span_id)}-{span_context.trace_flags:02x}"
  76. setter.set(carrier, self._TRACEPARENT_HEADER_NAME, traceparent_string)
  77. if span_context.trace_state:
  78. tracestate_string = span_context.trace_state.to_header()
  79. setter.set(
  80. carrier, self._TRACESTATE_HEADER_NAME, tracestate_string
  81. )
  82. @property
  83. def fields(self) -> set[str]:
  84. """Returns a set with the fields set in `inject`.
  85. See
  86. `opentelemetry.propagators.textmap.TextMapPropagator.fields`
  87. """
  88. return {self._TRACEPARENT_HEADER_NAME, self._TRACESTATE_HEADER_NAME}