Implement CreateKey Functionality (open-telemetry#1853)

Author: euniceek

.github/workflows/test.yml

@@ -10,7 +10,7 @@ env:
   # Otherwise, set variable to the commit of your branch on
   # opentelemetry-python-contrib which is compatible with these Core repo
   # changes.
-  CONTRIB_REPO_SHA: 01bb63fb8cc429a17f1fb0c93f7ac72a3fc7b4fc
+  CONTRIB_REPO_SHA: 82c4f600872a72fedaebad758f0d5588dfb53a00
 
 jobs:
   build:

CHANGELOG.md

@@ -18,6 +18,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added 
 - Allow span limits to be set programatically via TracerProvider.
   ([#1877](https://github.com/open-telemetry/opentelemetry-python/pull/1877))
+- Added support for CreateKey functionality.
+  ([#1853](https://github.com/open-telemetry/opentelemetry-python/pull/1853))
 
 ### Changed
 - Updated get_tracer to return an empty string when passed an invalid name

docs-requirements.txt

@@ -8,6 +8,7 @@ sphinx-jekyll-builder
 # doesn't work for pkg_resources.
 ./opentelemetry-api
 ./opentelemetry-semantic-conventions
+./opentelemetry-python-contrib/opentelemetry-instrumentation
 ./opentelemetry-sdk
 
 # Required by instrumentation and exporter packages

opentelemetry-api/src/opentelemetry/baggage/__init__.py

@@ -15,10 +15,10 @@
 import typing
 from types import MappingProxyType
 
-from opentelemetry.context import get_value, set_value
+from opentelemetry.context import create_key, get_value, set_value
 from opentelemetry.context.context import Context
 
-_BAGGAGE_KEY = "baggage"
+_BAGGAGE_KEY = create_key("baggage")
 
 
 def get_all(

opentelemetry-api/src/opentelemetry/context/__init__.py

@@ -15,6 +15,7 @@
 import logging
 import threading
 import typing
+import uuid
 from functools import wraps
 from os import environ
 
@@ -68,6 +69,18 @@ def wrapper(  # type: ignore[misc]
     return typing.cast(_F, wrapper)  # type: ignore[misc]
 
 
+def create_key(keyname: str) -> str:
+    """To allow cross-cutting concern to control access to their local state,
+    the RuntimeContext API provides a function which takes a keyname as input,
+    and returns a unique key.
+    Args:
+        keyname: The key name is for debugging purposes and is not required to be unique.
+    Returns:
+        A unique string representing the newly created key.
+    """
+    return keyname + "-" + str(uuid.uuid4())
+
+
 def get_value(key: str, context: typing.Optional[Context] = None) -> "object":
     """To access the local state of a concern, the RuntimeContext API
     provides a function which takes a context and a key as input,

opentelemetry-api/src/opentelemetry/trace/__init__.py

@@ -85,7 +85,7 @@
 from opentelemetry.context.context import Context
 from opentelemetry.environment_variables import OTEL_PYTHON_TRACER_PROVIDER
 from opentelemetry.trace.propagation import (
-    SPAN_KEY,
+    _SPAN_KEY,
     get_current_span,
     set_span_in_context,
 )
@@ -517,7 +517,7 @@ def use_span(
             this mechanism if it was previously set manually.
     """
     try:
-        token = context_api.attach(context_api.set_value(SPAN_KEY, span))
+        token = context_api.attach(context_api.set_value(_SPAN_KEY, span))
         try:
             yield span
         finally:

opentelemetry-api/src/opentelemetry/trace/propagation/__init__.py

@@ -13,11 +13,12 @@
 # limitations under the License.
 from typing import Optional
 
-from opentelemetry.context import get_value, set_value
+from opentelemetry.context import create_key, get_value, set_value
 from opentelemetry.context.context import Context
 from opentelemetry.trace.span import INVALID_SPAN, Span
 
 SPAN_KEY = "current-span"
+_SPAN_KEY = create_key("current-span")
 
 
 def set_span_in_context(
@@ -30,7 +31,7 @@ def set_span_in_context(
         context: a Context object. if one is not passed, the
             default current context is used instead.
     """
-    ctx = set_value(SPAN_KEY, span, context=context)
+    ctx = set_value(_SPAN_KEY, span, context=context)
     return ctx
 
 
@@ -44,7 +45,7 @@ def get_current_span(context: Optional[Context] = None) -> Span:
     Returns:
         The Span set in the context if it exists. INVALID_SPAN otherwise.
     """
-    span = get_value(SPAN_KEY, context=context)
+    span = get_value(_SPAN_KEY, context=context)
     if span is None or not isinstance(span, Span):
         return INVALID_SPAN
     return span

opentelemetry-api/tests/context/test_context.py

@@ -18,27 +18,39 @@
 from opentelemetry.context.context import Context
 
 
-def do_work() -> None:
-    context.attach(context.set_value("say", "bar"))
+def _do_work() -> str:
+    key = context.create_key("say")
+    context.attach(context.set_value(key, "bar"))
+    return key
 
 
 class TestContext(unittest.TestCase):
     def setUp(self):
         context.attach(Context())
 
+    def test_context_key(self):
+        key1 = context.create_key("say")
+        key2 = context.create_key("say")
+        self.assertNotEqual(key1, key2)
+        first = context.set_value(key1, "foo")
+        second = context.set_value(key2, "bar")
+        self.assertEqual(context.get_value(key1, context=first), "foo")
+        self.assertEqual(context.get_value(key2, context=second), "bar")
+
     def test_context(self):
-        self.assertIsNone(context.get_value("say"))
+        key1 = context.create_key("say")
+        self.assertIsNone(context.get_value(key1))
         empty = context.get_current()
-        second = context.set_value("say", "foo")
-        self.assertEqual(context.get_value("say", context=second), "foo")
+        second = context.set_value(key1, "foo")
+        self.assertEqual(context.get_value(key1, context=second), "foo")
 
-        do_work()
-        self.assertEqual(context.get_value("say"), "bar")
+        key2 = _do_work()
+        self.assertEqual(context.get_value(key2), "bar")
         third = context.get_current()
 
-        self.assertIsNone(context.get_value("say", context=empty))
-        self.assertEqual(context.get_value("say", context=second), "foo")
-        self.assertEqual(context.get_value("say", context=third), "bar")
+        self.assertIsNone(context.get_value(key1, context=empty))
+        self.assertEqual(context.get_value(key1, context=second), "foo")
+        self.assertEqual(context.get_value(key2, context=third), "bar")
 
     def test_set_value(self):
         first = context.set_value("a", "yyy")

opentelemetry-sdk/setup.cfg

@@ -44,6 +44,7 @@ include_package_data = True
 install_requires =
     opentelemetry-api == 1.4.0.dev0
     opentelemetry-semantic-conventions == 0.23.dev0
+    opentelemetry-instrumentation == 0.23.dev0
 
 [options.packages.find]
 where = src

opentelemetry-sdk/src/opentelemetry/sdk/trace/export/__init__.py

@@ -22,6 +22,7 @@
 from typing import Optional
 
 from opentelemetry.context import Context, attach, detach, set_value
+from opentelemetry.instrumentation.utils import _SUPPRESS_INSTRUMENTATION_KEY
 from opentelemetry.sdk.environment_variables import (
     OTEL_BSP_EXPORT_TIMEOUT,
     OTEL_BSP_MAX_EXPORT_BATCH_SIZE,
@@ -86,7 +87,7 @@ def on_start(
     def on_end(self, span: ReadableSpan) -> None:
         if not span.context.trace_flags.sampled:
             return
-        token = attach(set_value("suppress_instrumentation", True))
+        token = attach(set_value(_SUPPRESS_INSTRUMENTATION_KEY, True))
         try:
             self.span_exporter.export((span,))
         # pylint: disable=broad-except
@@ -326,7 +327,7 @@ def _export_batch(self) -> int:
         while idx < self.max_export_batch_size and self.queue:
             self.spans_list[idx] = self.queue.pop()
             idx += 1
-        token = attach(set_value("suppress_instrumentation", True))
+        token = attach(set_value(_SUPPRESS_INSTRUMENTATION_KEY, True))
         try:
             # Ignore type b/c the Optional[None]+slicing is too "clever"
             # for mypy