Create Resource only once for tracing, logging, and metrics (#33698)

* Tests pass

* Add missing instrumentation options

* Readme

* Merging custom resource into default

* Clearer Resource Attribute priorities

* lint

* lint

* Fix broken link

* Removed resource param

Author: jeremydvoss

sdk/monitor/azure-monitor-opentelemetry/README.md

@@ -65,7 +65,7 @@ You can use `configure_azure_monitor` to set up instrumentation for your app to
 You can configure further with [OpenTelemetry environment variables][ot_env_vars] such as:
 | Environment Variable | Description |
 |-------------|----------------------|
-| [OTEL_SERVICE_NAME][ot_spec_service_name], [OTEL_RESOURCE_ATTRIBUTES][ot_spec_resource_attributes] | Specifies the OpenTelemetry [resource][ot_spec_resource] associated with your application. |
+| [OTEL_SERVICE_NAME][ot_spec_service_name], [OTEL_RESOURCE_ATTRIBUTES][ot_spec_resource_attributes] | Specifies the OpenTelemetry [Resource][ot_spec_resource] associated with your application. |
 | `OTEL_LOGS_EXPORTER` | If set to `None`, disables collection and export of logging telemetry. |
 | `OTEL_METRICS_EXPORTER` | If set to `None`, disables collection and export of metric telemetry. |
 | `OTEL_TRACES_EXPORTER` | If set to `None`, disables collection and export of distributed tracing telemetry. |

sdk/monitor/azure-monitor-opentelemetry/azure/monitor/opentelemetry/_configure.py

@@ -3,8 +3,6 @@
 # Licensed under the MIT License. See License in the project root for
 # license information.
 # --------------------------------------------------------------------------
-import os
-
 from logging import getLogger
 from typing import Dict, cast
 
@@ -16,7 +14,6 @@
     BaseInstrumentor,
 )
 from opentelemetry.metrics import set_meter_provider
-from opentelemetry.sdk.environment_variables import OTEL_EXPERIMENTAL_RESOURCE_DETECTORS
 from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
 from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
 from opentelemetry.sdk.metrics import MeterProvider
@@ -30,13 +27,12 @@
 from azure.core.tracing.ext.opentelemetry_span import OpenTelemetrySpan
 from azure.monitor.opentelemetry._constants import (
     _ALL_SUPPORTED_INSTRUMENTED_LIBRARIES,
-    _AZURE_APP_SERVICE_RESOURCE_DETECTOR_NAME,
     _AZURE_SDK_INSTRUMENTATION_NAME,
-    _AZURE_VM_RESOURCE_DETECTOR_NAME,
     DISABLE_LOGGING_ARG,
     DISABLE_METRICS_ARG,
     DISABLE_TRACING_ARG,
     LOGGER_NAME_ARG,
+    RESOURCE_ARG,
     SAMPLING_RATIO_ARG,
 )
 from azure.monitor.opentelemetry._types import ConfigurationValue
@@ -51,12 +47,6 @@
     _is_instrumentation_enabled,
 )
 
-
-_SUPPORTED_RESOURCE_DETECTORS = (
-    _AZURE_APP_SERVICE_RESOURCE_DETECTOR_NAME,
-    _AZURE_VM_RESOURCE_DETECTOR_NAME,
-)
-
 _logger = getLogger(__name__)
 
 
@@ -83,9 +73,6 @@ def configure_azure_monitor(**kwargs) -> None:
     disable_logging = configurations[DISABLE_LOGGING_ARG]
     disable_metrics = configurations[DISABLE_METRICS_ARG]
 
-    # Setup resources
-    _setup_resources()
-
     # Setup tracing pipeline
     if not disable_tracing:
         _setup_tracing(configurations)
@@ -103,17 +90,13 @@ def configure_azure_monitor(**kwargs) -> None:
     # instanstiated in the other setup steps
     _setup_instrumentations(configurations)
 
-def _setup_resources():
-    os.environ.setdefault(
-        OTEL_EXPERIMENTAL_RESOURCE_DETECTORS,
-        ",".join(_SUPPORTED_RESOURCE_DETECTORS)
-    )
-
 
 def _setup_tracing(configurations: Dict[str, ConfigurationValue]):
+    resource = configurations[RESOURCE_ARG] # type: ignore
     sampling_ratio = configurations[SAMPLING_RATIO_ARG]
     tracer_provider = TracerProvider(
         sampler=ApplicationInsightsSampler(sampling_ratio=cast(float, sampling_ratio)),
+        resource=resource
     )
     set_tracer_provider(tracer_provider)
     trace_exporter = AzureMonitorTraceExporter(**configurations)
@@ -126,7 +109,8 @@ def _setup_tracing(configurations: Dict[str, ConfigurationValue]):
 
 
 def _setup_logging(configurations: Dict[str, ConfigurationValue]):
-    logger_provider = LoggerProvider()
+    resource = configurations[RESOURCE_ARG] # type: ignore
+    logger_provider = LoggerProvider(resource=resource)
     set_logger_provider(logger_provider)
     log_exporter = AzureMonitorLogExporter(**configurations)
     log_record_processor = BatchLogRecordProcessor(
@@ -139,10 +123,12 @@ def _setup_logging(configurations: Dict[str, ConfigurationValue]):
 
 
 def _setup_metrics(configurations: Dict[str, ConfigurationValue]):
+    resource = configurations[RESOURCE_ARG] # type: ignore
     metric_exporter = AzureMonitorMetricExporter(**configurations)
     reader = PeriodicExportingMetricReader(metric_exporter)
     meter_provider = MeterProvider(
         metric_readers=[reader],
+        resource=resource
     )
     set_meter_provider(meter_provider)
 

sdk/monitor/azure-monitor-opentelemetry/azure/monitor/opentelemetry/_constants.py

@@ -23,6 +23,7 @@
 DISABLE_TRACING_ARG = "disable_tracing"
 LOGGER_NAME_ARG = "logger_name"
 INSTRUMENTATION_OPTIONS_ARG = "instrumentation_options"
+RESOURCE_ARG = "resource"
 SAMPLING_RATIO_ARG = "sampling_ratio"
 
 

sdk/monitor/azure-monitor-opentelemetry/azure/monitor/opentelemetry/_util/configurations.py

@@ -16,24 +16,33 @@
 from opentelemetry.instrumentation.environment_variables import (
     OTEL_PYTHON_DISABLED_INSTRUMENTATIONS,
 )
-from opentelemetry.sdk.environment_variables import OTEL_TRACES_SAMPLER_ARG
+from opentelemetry.sdk.environment_variables import (
+    OTEL_EXPERIMENTAL_RESOURCE_DETECTORS,
+    OTEL_TRACES_SAMPLER_ARG,
+)
+from opentelemetry.sdk.resources import Resource
 
 from azure.monitor.opentelemetry._constants import (
+    _AZURE_APP_SERVICE_RESOURCE_DETECTOR_NAME,
+    _AZURE_VM_RESOURCE_DETECTOR_NAME,
     _FULLY_SUPPORTED_INSTRUMENTED_LIBRARIES,
     _PREVIEW_INSTRUMENTED_LIBRARIES,
     DISABLE_LOGGING_ARG,
     DISABLE_METRICS_ARG,
     DISABLE_TRACING_ARG,
     INSTRUMENTATION_OPTIONS_ARG,
     LOGGER_NAME_ARG,
+    RESOURCE_ARG,
     SAMPLING_RATIO_ARG,
 )
 from azure.monitor.opentelemetry._types import ConfigurationValue
 
 
 _INVALID_FLOAT_MESSAGE = "Value of %s must be a float. Defaulting to %s: %s"
-
-
+_SUPPORTED_RESOURCE_DETECTORS = (
+    _AZURE_APP_SERVICE_RESOURCE_DETECTOR_NAME,
+    _AZURE_VM_RESOURCE_DETECTOR_NAME,
+)
 # TODO: remove when sampler uses env var instead
 SAMPLING_RATIO_ENV_VAR = OTEL_TRACES_SAMPLER_ARG
 
@@ -51,6 +60,7 @@ def _get_configurations(**kwargs) -> Dict[str, ConfigurationValue]:
     _default_disable_metrics(configurations)
     _default_disable_tracing(configurations)
     _default_logger_name(configurations)
+    _default_resource(configurations)
     _default_sampling_ratio(configurations)
     _default_instrumentation_options(configurations)
 
@@ -86,6 +96,14 @@ def _default_logger_name(configurations):
         configurations[LOGGER_NAME_ARG] = ""
 
 
+def _default_resource(configurations):
+    environ.setdefault(
+        OTEL_EXPERIMENTAL_RESOURCE_DETECTORS,
+        ",".join(_SUPPORTED_RESOURCE_DETECTORS)
+    )
+    configurations[RESOURCE_ARG] = Resource.create()
+
+
 # TODO: remove when sampler uses env var instead
 def _default_sampling_ratio(configurations):
     default = 1.0

sdk/monitor/azure-monitor-opentelemetry/tests/configuration/test_configure.py

@@ -20,7 +20,6 @@
     _setup_instrumentations,
     _setup_logging,
     _setup_metrics,
-    _setup_resources,
     _setup_tracing,
     configure_azure_monitor,
 )
@@ -39,12 +38,8 @@ class TestConfigure(unittest.TestCase):
     @patch(
         "azure.monitor.opentelemetry._configure._setup_tracing",
     )
-    @patch(
-        "azure.monitor.opentelemetry._configure._setup_resources",
-    )
     def test_configure_azure_monitor(
         self,
-        resource_mock,
         tracing_mock,
         logging_mock,
         metrics_mock,
@@ -54,7 +49,6 @@ def test_configure_azure_monitor(
             "connection_string": "test_cs",
         }
         configure_azure_monitor(**kwargs)
-        resource_mock.assert_called_once()
         tracing_mock.assert_called_once()
         logging_mock.assert_called_once()
         metrics_mock.assert_called_once()
@@ -72,16 +66,12 @@ def test_configure_azure_monitor(
     @patch(
         "azure.monitor.opentelemetry._configure._setup_tracing",
     )
-    @patch(
-        "azure.monitor.opentelemetry._configure._setup_resources",
-    )
     @patch(
         "azure.monitor.opentelemetry._configure._get_configurations",
     )
     def test_configure_azure_monitor_disable_tracing(
         self,
         config_mock,
-        resource_mock,
         tracing_mock,
         logging_mock,
         metrics_mock,
@@ -106,7 +96,6 @@ def test_configure_azure_monitor_disable_tracing(
         }
         config_mock.return_value = configurations
         configure_azure_monitor()
-        resource_mock.assert_called_once()
         tracing_mock.assert_not_called()
         logging_mock.assert_called_once_with(configurations)
         metrics_mock.assert_called_once_with(configurations)
@@ -124,16 +113,12 @@ def test_configure_azure_monitor_disable_tracing(
     @patch(
         "azure.monitor.opentelemetry._configure._setup_tracing",
     )
-    @patch(
-        "azure.monitor.opentelemetry._configure._setup_resources",
-    )
     @patch(
         "azure.monitor.opentelemetry._configure._get_configurations",
     )
     def test_configure_azure_monitor_disable_logging(
         self,
         config_mock,
-        resource_mock,
         tracing_mock,
         logging_mock,
         metrics_mock,
@@ -147,7 +132,6 @@ def test_configure_azure_monitor_disable_logging(
         }
         config_mock.return_value = configurations
         configure_azure_monitor()
-        resource_mock.assert_called_once()
         tracing_mock.assert_called_once_with(configurations)
         logging_mock.assert_not_called()
         metrics_mock.assert_called_once_with(configurations)
@@ -165,16 +149,12 @@ def test_configure_azure_monitor_disable_logging(
     @patch(
         "azure.monitor.opentelemetry._configure._setup_tracing",
     )
-    @patch(
-        "azure.monitor.opentelemetry._configure._setup_resources",
-    )
     @patch(
         "azure.monitor.opentelemetry._configure._get_configurations",
     )
     def test_configure_azure_monitor_disable_metrics(
         self,
         config_mock,
-        resource_mock,
         tracing_mock,
         logging_mock,
         metrics_mock,
@@ -188,44 +168,11 @@ def test_configure_azure_monitor_disable_metrics(
         }
         config_mock.return_value = configurations
         configure_azure_monitor()
-        resource_mock.assert_called_once()
         tracing_mock.assert_called_once_with(configurations)
         logging_mock.assert_called_once_with(configurations)
         metrics_mock.assert_not_called()
         instrumentation_mock.assert_called_once_with(configurations)
 
-    @patch.dict("os.environ", {}, clear=True)
-    def test_setup_resources(self):
-        _setup_resources()
-        self.assertEqual(
-            os.environ["OTEL_EXPERIMENTAL_RESOURCE_DETECTORS"],
-            "azure_app_service,azure_vm"
-        )
-
-    @patch.dict("os.environ", {"OTEL_EXPERIMENTAL_RESOURCE_DETECTORS": ""})
-    def test_setup_resources_empty_string(self):
-        _setup_resources()
-        self.assertEqual(
-            os.environ["OTEL_EXPERIMENTAL_RESOURCE_DETECTORS"],
-            ""
-        )
-
-    @patch.dict("os.environ", {"OTEL_EXPERIMENTAL_RESOURCE_DETECTORS": "test_detector"})
-    def test_setup_resources_existing_detectors(self):
-        _setup_resources()
-        self.assertEqual(
-            os.environ["OTEL_EXPERIMENTAL_RESOURCE_DETECTORS"],
-            "test_detector"
-        )
-
-    @patch.dict("os.environ", {"OTEL_EXPERIMENTAL_RESOURCE_DETECTORS": "azure_vm,test_detector, azure_app_service"})
-    def test_setup_resources_azure_and_existing_detectors(self):
-        _setup_resources()
-        self.assertEqual(
-            os.environ["OTEL_EXPERIMENTAL_RESOURCE_DETECTORS"],
-            "azure_vm,test_detector, azure_app_service"
-        )
-
     @patch(
         "azure.monitor.opentelemetry._configure.settings",
     )
@@ -274,11 +221,13 @@ def test_setup_tracing(
                 "azure_sdk": {"enabled": True}
             },
             "sampling_ratio": 0.5,
+            "resource": "test_resource",
         }
         _setup_tracing(configurations)
         sampler_mock.assert_called_once_with(sampling_ratio=0.5)
         tp_mock.assert_called_once_with(
             sampler=sampler_init_mock,
+            resource="test_resource"
         )
         set_tracer_provider_mock.assert_called_once_with(tp_init_mock)
         get_tracer_provider_mock.assert_called()
@@ -336,10 +285,11 @@ def test_setup_logging(
         configurations = {
             "connection_string": "test_cs",
             "logger_name": "test",
+            "resource": "test_resource",
         }
         _setup_logging(configurations)
 
-        lp_mock.assert_called_once_with()
+        lp_mock.assert_called_once_with(resource="test_resource")
         set_logger_provider_mock.assert_called_once_with(lp_init_mock)
         get_logger_provider_mock.assert_called()
         log_exporter_mock.assert_called_once_with(**configurations)
@@ -386,10 +336,12 @@ def test_setup_metrics(
 
         configurations = {
             "connection_string": "test_cs",
+            "resource": "test_resource",
         }
         _setup_metrics(configurations)
         mp_mock.assert_called_once_with(
             metric_readers=[reader_init_mock],
+            resource="test_resource"
         )
         set_meter_provider_mock.assert_called_once_with(mp_init_mock)
         metric_exporter_mock.assert_called_once_with(**configurations)