mirror of
https://github.com/open-telemetry/opentelemetry-python-contrib.git
synced 2025-07-28 20:52:57 +08:00
59a737c285
* Add key predicate to baggage span processor * add changelog entry * fix linting * more linter fixes --------- Co-authored-by: Diego Hurtado <ocelotl@users.noreply.github.com>
168 lines
7.0 KiB
Python
168 lines
7.0 KiB
Python
# Copyright The OpenTelemetry Authors
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import re
|
|
import unittest
|
|
|
|
from opentelemetry.baggage import get_all as get_all_baggage
|
|
from opentelemetry.baggage import set_baggage
|
|
from opentelemetry.context import attach, detach
|
|
from opentelemetry.processor.baggage import (
|
|
ALLOW_ALL_BAGGAGE_KEYS,
|
|
BaggageSpanProcessor,
|
|
)
|
|
from opentelemetry.sdk.trace import TracerProvider
|
|
from opentelemetry.sdk.trace.export import SpanProcessor
|
|
from opentelemetry.trace import Span, Tracer
|
|
|
|
|
|
class BaggageSpanProcessorTest(unittest.TestCase):
|
|
def test_check_the_baggage(self):
|
|
self.assertIsInstance(
|
|
BaggageSpanProcessor(ALLOW_ALL_BAGGAGE_KEYS), SpanProcessor
|
|
)
|
|
|
|
def test_set_baggage_attaches_to_child_spans_and_detaches_properly_with_context(
|
|
self,
|
|
):
|
|
tracer_provider = TracerProvider()
|
|
tracer_provider.add_span_processor(
|
|
BaggageSpanProcessor(ALLOW_ALL_BAGGAGE_KEYS)
|
|
)
|
|
|
|
# tracer has no baggage to start
|
|
tracer = tracer_provider.get_tracer("my-tracer")
|
|
self.assertIsInstance(tracer, Tracer)
|
|
self.assertEqual(get_all_baggage(), {})
|
|
# set baggage in context
|
|
ctx = set_baggage("queen", "bee")
|
|
with tracer.start_as_current_span(
|
|
name="bumble", context=ctx
|
|
) as bumble_span:
|
|
# span should have baggage key-value pair in context
|
|
self.assertEqual(get_all_baggage(ctx), {"queen": "bee"})
|
|
# span should have baggage key-value pair in attribute
|
|
self.assertEqual(bumble_span._attributes["queen"], "bee")
|
|
with tracer.start_as_current_span(
|
|
name="child_span", context=ctx
|
|
) as child_span:
|
|
self.assertIsInstance(child_span, Span)
|
|
# child span should have baggage key-value pair in context
|
|
self.assertEqual(get_all_baggage(ctx), {"queen": "bee"})
|
|
# child span should have baggage key-value pair in attribute
|
|
self.assertEqual(child_span._attributes["queen"], "bee")
|
|
|
|
def test_baggage_span_processor_with_string_prefix(
|
|
self,
|
|
):
|
|
tracer_provider = TracerProvider()
|
|
tracer_provider.add_span_processor(
|
|
BaggageSpanProcessor(self.has_prefix)
|
|
)
|
|
|
|
# tracer has no baggage to start
|
|
tracer = tracer_provider.get_tracer("my-tracer")
|
|
self.assertIsInstance(tracer, Tracer)
|
|
self.assertEqual(get_all_baggage(), {})
|
|
# set baggage in context
|
|
ctx = set_baggage("queen", "bee")
|
|
with tracer.start_as_current_span(
|
|
name="bumble", context=ctx
|
|
) as bumble_span:
|
|
# span should have baggage key-value pair in context
|
|
self.assertEqual(get_all_baggage(ctx), {"queen": "bee"})
|
|
# span should have baggage key-value pair in attribute
|
|
self.assertEqual(bumble_span._attributes["queen"], "bee")
|
|
with tracer.start_as_current_span(
|
|
name="child_span", context=ctx
|
|
) as child_span:
|
|
self.assertIsInstance(child_span, Span)
|
|
# child span should have baggage key-value pair in context
|
|
self.assertEqual(get_all_baggage(ctx), {"queen": "bee"})
|
|
# child span should have baggage key-value pair in attribute
|
|
self.assertEqual(child_span._attributes["queen"], "bee")
|
|
|
|
def test_baggage_span_processor_with_regex(
|
|
self,
|
|
):
|
|
tracer_provider = TracerProvider()
|
|
tracer_provider.add_span_processor(
|
|
BaggageSpanProcessor(self.matches_regex)
|
|
)
|
|
|
|
# tracer has no baggage to start
|
|
tracer = tracer_provider.get_tracer("my-tracer")
|
|
self.assertIsInstance(tracer, Tracer)
|
|
self.assertEqual(get_all_baggage(), {})
|
|
# set baggage in context
|
|
ctx = set_baggage("queen", "bee")
|
|
with tracer.start_as_current_span(
|
|
name="bumble", context=ctx
|
|
) as bumble_span:
|
|
# span should have baggage key-value pair in context
|
|
self.assertEqual(get_all_baggage(ctx), {"queen": "bee"})
|
|
# span should have baggage key-value pair in attribute
|
|
self.assertEqual(bumble_span._attributes["queen"], "bee")
|
|
with tracer.start_as_current_span(
|
|
name="child_span", context=ctx
|
|
) as child_span:
|
|
self.assertIsInstance(child_span, Span)
|
|
# child span should have baggage key-value pair in context
|
|
self.assertEqual(get_all_baggage(ctx), {"queen": "bee"})
|
|
# child span should have baggage key-value pair in attribute
|
|
self.assertEqual(child_span._attributes["queen"], "bee")
|
|
|
|
def test_set_baggage_attaches_to_child_spans_and_detaches_properly_with_token(
|
|
self,
|
|
):
|
|
tracer_provider = TracerProvider()
|
|
tracer_provider.add_span_processor(
|
|
BaggageSpanProcessor(ALLOW_ALL_BAGGAGE_KEYS)
|
|
)
|
|
|
|
# tracer has no baggage to start
|
|
tracer = tracer_provider.get_tracer("my-tracer")
|
|
self.assertIsInstance(tracer, Tracer)
|
|
self.assertEqual(get_all_baggage(), {})
|
|
# create a context token and set baggage
|
|
honey_token = attach(set_baggage("bumble", "bee"))
|
|
self.assertEqual(get_all_baggage(), {"bumble": "bee"})
|
|
# in a new span, ensure the baggage is there
|
|
with tracer.start_as_current_span("parent") as span:
|
|
self.assertEqual(get_all_baggage(), {"bumble": "bee"})
|
|
self.assertEqual(span._attributes["bumble"], "bee")
|
|
# create a second context token and set more baggage
|
|
moar_token = attach(set_baggage("moar", "bee"))
|
|
self.assertEqual(
|
|
get_all_baggage(), {"bumble": "bee", "moar": "bee"}
|
|
)
|
|
# in a child span, ensure all baggage is there as attributes
|
|
with tracer.start_as_current_span("child") as child_span:
|
|
self.assertEqual(
|
|
get_all_baggage(), {"bumble": "bee", "moar": "bee"}
|
|
)
|
|
self.assertEqual(child_span._attributes["bumble"], "bee")
|
|
self.assertEqual(child_span._attributes["moar"], "bee")
|
|
detach(moar_token)
|
|
detach(honey_token)
|
|
self.assertEqual(get_all_baggage(), {})
|
|
|
|
@staticmethod
|
|
def has_prefix(baggage_key: str) -> bool:
|
|
return baggage_key.startswith("que")
|
|
|
|
@staticmethod
|
|
def matches_regex(baggage_key: str) -> bool:
|
|
return re.match(r"que.*", baggage_key) is not None
|