Add IDs Generator to auto instrumentation config

Author: NathanielRN

Diff for: opentelemetry-api/setup.cfg

@@ -57,6 +57,8 @@ opentelemetry_tracer_provider =
 opentelemetry_propagator =
     tracecontext = opentelemetry.trace.propagation.tracecontext:TraceContextTextMapPropagator
     baggage = opentelemetry.baggage.propagation:BaggagePropagator
+opentelemetry_ids_generator =
+    random = opentelemetry.trace.ids_generator:RandomIdsGenerator
 
 [options.extras_require]
 test =

Diff for: opentelemetry-instrumentation/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Add IDs Generator as Configurable Property of Auto Instrumentation
+  ([#1404](https://github.com/open-telemetry/opentelemetry-python/pull/1404))
 - Added support for `OTEL_EXPORTER` to the `opentelemetry-instrument` command ([#1036](https://github.com/open-telemetry/opentelemetry-python/pull/1036))
 
 ## Version 0.14b0

Diff for: opentelemetry-instrumentation/README.rst

@@ -51,18 +51,10 @@ The command supports the following configuration options as CLI arguments and en
 * ``--exporter`` or ``OTEL_EXPORTER``
 
 Used to specify which trace exporter to use. Can be set to one or more
-<<<<<<< HEAD
 of the well-known exporter names (see below).
 
     - Defaults to `otlp`.
     - Can be set to `none` to disable automatic tracer initialization. 
-=======
-of the well-known exporter names (see below) or a fully
-qualified Python import path to a span  exporter implementation.
-
-    - Defaults to `otlp`.
-    - Can be set to `none` to disbale automatic tracer initialization. 
->>>>>>> Add true auto-instrumentation support to opentelemetry-instrument
 
 You can pass multiple values to configure multiple exporters e.g, ``zipkin,prometheus`` 
 
@@ -81,25 +73,22 @@ Well known trace exporter names:
 
 When present the value is passed on to the relevant exporter initializer as ``service_name`` argument.
 
+* ``--ids-generator`` or ``OTEL_IDS_GENERATOR``
+
+Used to specify which IDs Generator to use for the global Tracer Provider. By default, it
+will use the random IDs generator.
+
 The code in ``program.py`` needs to use one of the packages for which there is
 an OpenTelemetry integration. For a list of the available integrations please
 check `here <https://opentelemetry-python.readthedocs.io/en/stable/index.html#integrations>`_
 
 Examples
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-<<<<<<< HEAD
 
 ::
 
     opentelemetry-instrument -e otlp flask run --port=3000
 
-=======
-
-::
-
-    opentelemetry-instrument -e otlp flask run --port=3000
-
->>>>>>> Add true auto-instrumentation support to opentelemetry-instrument
 The above command will pass ``-e otlp`` to the instrument command and ``--port=3000`` to ``flask run``.
 
 ::
@@ -109,6 +98,13 @@ The above command will pass ``-e otlp`` to the instrument command and ``--port=3
 The above command will configure global trace provider, attach zipkin and otlp exporters to it and then
 start celery with the rest of the arguments. 
 
+::
+
+    opentelemetry-instrument -g random flask run --port=3000
+
+The above command will configure the global trace provider to use the Random IDs Generator, and then
+pass ``--port=3000`` to ``flask run``.
+
 References
 ----------
 

Diff for: opentelemetry-instrumentation/src/opentelemetry/instrumentation/auto_instrumentation/__init__.py

@@ -47,6 +47,19 @@ def parse_args():
         """,
     )
 
+    parser.add_argument(
+        "-g",
+        "--ids-generator",
+        required=False,
+        help="""
+        The IDs Generator to be used with the Tracer Provider.
+
+        Examples:
+
+            -g=random
+        """,
+    )
+
     parser.add_argument(
         "-s",
         "--service-name",
@@ -70,6 +83,8 @@ def load_config_from_cli_args(args):
         environ["OTEL_EXPORTER"] = args.exporter
     if args.service_name:
         environ["OTEL_SERVICE_NAME"] = args.service_name
+    if args.ids_generator:
+        environ["OTEL_IDS_GENERATOR"] = args.ids_generator
 
 
 def run() -> None:

Diff for: opentelemetry-instrumentation/src/opentelemetry/instrumentation/auto_instrumentation/components.py

@@ -34,6 +34,13 @@
 EXPORTER_OTLP_METRIC = "otlp_metric"
 _DEFAULT_EXPORTER = EXPORTER_OTLP
 
+RANDOM_IDS_GENERATOR = "random"
+_DEFAULT_IDS_GENERATOR = RANDOM_IDS_GENERATOR
+
+
+def get_ids_generator() -> str:
+    return Configuration().IDS_GENERATOR or _DEFAULT_IDS_GENERATOR
+
 
 def get_service_name() -> str:
     return Configuration().SERVICE_NAME or ""
@@ -55,10 +62,13 @@ def get_exporter_names() -> Sequence[str]:
     return names
 
 
-def init_tracing(exporters: Sequence[SpanExporter]):
+def init_tracing(
+    exporters: Sequence[SpanExporter], ids_generator: trace.IdsGenerator
+):
     service_name = get_service_name()
     provider = TracerProvider(
         resource=Resource.create({"service.name": service_name}),
+        ids_generator=ids_generator(),
     )
     trace.set_tracer_provider(provider)
 
@@ -110,10 +120,30 @@ def import_exporters(
     return trace_exporters, metric_exporters
 
 
+def import_ids_generator(ids_generator_name: str) -> trace.IdsGenerator:
+    ids_generator_impl = None
+
+    for id_generator in iter_entry_points("opentelemetry_ids_generator"):
+        if id_generator.name == ids_generator_name.strip():
+            ids_generator_impl = id_generator.load()
+            break
+    else:
+        raise RuntimeError(
+            "Requested IDs Generator not found: {0}".format(ids_generator_name)
+        )
+
+    if issubclass(ids_generator_impl, trace.IdsGenerator):
+        return ids_generator_impl
+
+    raise RuntimeError("{0} is not an IdsGenerator".format(ids_generator_name))
+
+
 def initialize_components():
     exporter_names = get_exporter_names()
     trace_exporters, metric_exporters = import_exporters(exporter_names)
-    init_tracing(trace_exporters)
+    ids_generator_name = get_ids_generator()
+    ids_generator = import_ids_generator(ids_generator_name)
+    init_tracing(trace_exporters, ids_generator)
 
     # We don't support automatic initialization for metric yet but have added
     # some boilerplate in order to make sure current implementation does not

Diff for: opentelemetry-instrumentation/src/opentelemetry/instrumentation/auto_instrumentation/sitecustomize.py

@@ -46,11 +46,7 @@ def initialize():
 if (
     hasattr(sys, "argv")
     and sys.argv[0].split(os.path.sep)[-1] == "celery"
-<<<<<<< HEAD
     and "worker" in sys.argv[1:]
-=======
-    and "worker" in sys.argv
->>>>>>> Add true auto-instrumentation support to opentelemetry-instrument
 ):
     from celery.signals import worker_process_init  # pylint:disable=E0401
 

Diff for: opentelemetry-instrumentation/tests/test_auto_tracing.py

@@ -20,10 +20,12 @@
 from opentelemetry.configuration import Configuration
 from opentelemetry.instrumentation.auto_instrumentation import components
 from opentelemetry.sdk.resources import Resource
+from opentelemetry.trace.ids_generator import RandomIdsGenerator
 
 
 class Provider:
-    def __init__(self, resource=None):
+    def __init__(self, resource=None, ids_generator=None):
+        self.ids_generator = ids_generator
         self.processor = None
         self.resource = resource
 
@@ -77,11 +79,12 @@ def tearDown(self):
     def test_trace_init_default(self):
         environ["OTEL_SERVICE_NAME"] = "my-test-service"
         Configuration._reset()
-        components.init_tracing({"zipkin": Exporter})
+        components.init_tracing({"zipkin": Exporter}, RandomIdsGenerator)
 
         self.assertEqual(self.set_provider_mock.call_count, 1)
         provider = self.set_provider_mock.call_args[0][0]
         self.assertIsInstance(provider, Provider)
+        self.assertIsInstance(provider.ids_generator, RandomIdsGenerator)
         self.assertIsInstance(provider.processor, Processor)
         self.assertIsInstance(provider.processor.exporter, Exporter)
         self.assertEqual(
@@ -91,11 +94,12 @@ def test_trace_init_default(self):
     def test_trace_init_otlp(self):
         environ["OTEL_SERVICE_NAME"] = "my-otlp-test-service"
         Configuration._reset()
-        components.init_tracing({"otlp": OTLPExporter})
+        components.init_tracing({"otlp": OTLPExporter}, RandomIdsGenerator)
 
         self.assertEqual(self.set_provider_mock.call_count, 1)
         provider = self.set_provider_mock.call_args[0][0]
         self.assertIsInstance(provider, Provider)
+        self.assertIsInstance(provider.ids_generator, RandomIdsGenerator)
         self.assertIsInstance(provider.processor, Processor)
         self.assertIsInstance(provider.processor.exporter, OTLPExporter)
         self.assertIsInstance(provider.resource, Resource)
@@ -104,3 +108,23 @@ def test_trace_init_otlp(self):
             "my-otlp-test-service",
         )
         del environ["OTEL_SERVICE_NAME"]
+
+    def test_trace_init_default_random_ids_generator(self):
+        environ["OTEL_SERVICE_NAME"] = "my-random-ids-generator-test-service"
+        Configuration._reset()
+        ids_generator_name = components.get_ids_generator()
+        ids_generator = components.import_ids_generator(ids_generator_name)
+        components.init_tracing({"otlp": OTLPExporter}, ids_generator)
+
+        self.assertEqual(self.set_provider_mock.call_count, 1)
+        provider = self.set_provider_mock.call_args[0][0]
+        self.assertIsInstance(provider, Provider)
+        self.assertIsInstance(provider.ids_generator, RandomIdsGenerator)
+        self.assertIsInstance(provider.processor, Processor)
+        self.assertIsInstance(provider.processor.exporter, OTLPExporter)
+        self.assertIsInstance(provider.resource, Resource)
+        self.assertEqual(
+            provider.resource.attributes.get("service.name"),
+            "my-random-ids-generator-test-service",
+        )
+        del environ["OTEL_SERVICE_NAME"]