Incorporate resource detectors to auto instrumentation

This is an experimental feature.

Fixes #3172

Author: ocelotl

CHANGELOG.md

@@ -6,12 +6,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+
+- Incorporate resource detectors to auto instrumentation (experimental feature)
+  ([#3172](https://github.com/open-telemetry/opentelemetry-python/pull/3172))
 - PeriodicExportingMetricReader will continue if collection times out 
   ([#3100](https://github.com/open-telemetry/opentelemetry-python/pull/3100))
 - Fix formatting of ConsoleMetricExporter.
   ([#3197](https://github.com/open-telemetry/opentelemetry-python/pull/3197))
 
 ## Version 1.16.0/0.37b0 (2023-02-17)
+
 - Change ``__all__`` to be statically defined.
   ([#3143](https://github.com/open-telemetry/opentelemetry-python/pull/3143))
 - Remove the ability to set a global metric prefix for Prometheus exporter

opentelemetry-sdk/pyproject.toml

@@ -59,6 +59,10 @@ sdk_tracer_provider = "opentelemetry.sdk.trace:TracerProvider"
 [project.entry-points.opentelemetry_traces_exporter]
 console = "opentelemetry.sdk.trace.export:ConsoleSpanExporter"
 
+[project.entry-points.opentelemetry_resource_detector]
+otel = "opentelemetry.sdk.resources:OTELResourceDetector"
+process = "opentelemetry.sdk.resources:ProcessResourceDetector"
+
 [project.urls]
 Homepage = "https://github.com/open-telemetry/opentelemetry-python/tree/main/opentelemetry-sdk"
 

opentelemetry-sdk/src/opentelemetry/sdk/environment_variables.py

@@ -633,3 +633,12 @@
 
 The :envvar:`OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE` is the client certificate/chain trust for clients private key to use in mTLS communication in PEM format.
 """
+
+_OTEL_RESOURCE_DETECTORS = "_OTEL_RESOURCE_DETECTORS"
+"""
+.. envvar:: _OTEL_RESOURCE_DETECTORS
+
+The :envvar:`_OTEL_RESOURCE_DETECTORS` is a comma-separated string of names of
+resource detectors. These names must be the same as the names of entry points
+for the `opentelemetry-resource-detectors` entry point.
+"""

opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py

@@ -58,19 +58,20 @@
 import abc
 import concurrent.futures
 import logging
-import os
 import sys
 import typing
 from json import dumps
+from os import environ
 from urllib import parse
 
 from opentelemetry.attributes import BoundedAttributes
 from opentelemetry.sdk.environment_variables import (
+    _OTEL_RESOURCE_DETECTORS,
     OTEL_RESOURCE_ATTRIBUTES,
     OTEL_SERVICE_NAME,
 )
 from opentelemetry.semconv.resource import ResourceAttributes
-from opentelemetry.util._importlib_metadata import version
+from opentelemetry.util._importlib_metadata import entry_points, version
 from opentelemetry.util.types import AttributeValue
 
 LabelValue = AttributeValue
@@ -165,9 +166,23 @@ def create(
         """
         if not attributes:
             attributes = {}
-        resource = _DEFAULT_RESOURCE.merge(
-            OTELResourceDetector().detect()
-        ).merge(Resource(attributes, schema_url))
+
+        resource = _DEFAULT_RESOURCE
+
+        for resource_detector in environ.get(
+            _OTEL_RESOURCE_DETECTORS, "otel"
+        ).split(","):
+
+            resource = resource.merge(
+                entry_points(
+                    group="opentelemetry_resource_detector",
+                    name=resource_detector,
+                )[0]
+                .load()()
+                .detect()
+            )
+
+        resource = resource.merge(Resource(attributes, schema_url))
         if not resource.attributes.get(SERVICE_NAME, None):
             default_service_name = "unknown_service"
             process_executable_name = resource.attributes.get(
@@ -273,7 +288,7 @@ def detect(self) -> "Resource":
 class OTELResourceDetector(ResourceDetector):
     # pylint: disable=no-self-use
     def detect(self) -> "Resource":
-        env_resources_items = os.environ.get(OTEL_RESOURCE_ATTRIBUTES)
+        env_resources_items = environ.get(OTEL_RESOURCE_ATTRIBUTES)
         env_resource_map = {}
 
         if env_resources_items:
@@ -290,7 +305,7 @@ def detect(self) -> "Resource":
                 value_url_decoded = parse.unquote(value.strip())
                 env_resource_map[key.strip()] = value_url_decoded
 
-        service_name = os.environ.get(OTEL_SERVICE_NAME)
+        service_name = environ.get(OTEL_SERVICE_NAME)
         if service_name:
             env_resource_map[SERVICE_NAME] = service_name
         return Resource(env_resource_map)