Merge branch 'main' into feat/datapoint-flags

Author: herin049

CHANGELOG.md

@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+- `opentelemetry-sdk`: fix multi-processor `force_flush` skipping remaining processors when one returns `None`
+  ([#5179](https://github.com/open-telemetry/opentelemetry-python/pull/5179))
 - Apply fixes for `UP` ruff rule
   ([#5133](https://github.com/open-telemetry/opentelemetry-python/pull/5133))
 - Switch to SPDX license headers and add CI enforcement
@@ -46,12 +48,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#5135](https://github.com/open-telemetry/opentelemetry-python/pull/5135))
 - ci: wait for tracecontext server readiness instead of a fixed sleep in `scripts/tracecontext-integration-test.sh`
   ([#5149](https://github.com/open-telemetry/opentelemetry-python/pull/5149))
+- `opentelemetry-api`: update `EnvironmentGetter` and `EnvironmentSetter` to use normalized environment variable names
+  ([#5119](https://github.com/open-telemetry/opentelemetry-python/pull/5119))
 - `opentelemetry-sdk`: only load entrypoints for resource detectors if they are configured via `OTEL_EXPERIMENTAL_RESOURCE_DETECTORS`
   ([#5145](https://github.com/open-telemetry/opentelemetry-python/pull/5145))
 - `opentelemetry-exporter-otlp-json-common`: add 'opentelemetry-exporter-otlp-json-common' package for OTLP JSON exporters
   ([#4996](https://github.com/open-telemetry/opentelemetry-python/pull/4996))
 - `opentelemetry-exporter-otlp-proto-grpc`: make retryable gRPC error codes configurable for gRPC exporters
   ([#4917](https://github.com/open-telemetry/opentelemetry-python/pull/4917))
+- `opentelemetry-sdk`: add sampler plugin loading to declarative file configuration via the `opentelemetry_sampler` entry point group, matching the spec's PluginComponentProvider mechanism
+  ([#5095](https://github.com/open-telemetry/opentelemetry-python/pull/5095))
+- Add `registry` keyword argument to `PrometheusMetricReader` to allow passing a custom Prometheus registry
+  ([#5055](https://github.com/open-telemetry/opentelemetry-python/pull/5055))
+- Add ability to selectively enable exporting of SDK internal metrics with the `OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED` environment variable.
+  ([#5151](https://github.com/open-telemetry/opentelemetry-python/pull/5151))
+- `opentelemetry-api`, `opentelemetry-sdk`: add support for 'random-trace-id' flags in W3C traceparent header trace flags. Implementations of `IdGenerator` that do randomly generate the 56 least significant bits, should also implement a `is_trace_id_random` methods that returns `True`.
+  ([#4854](https://github.com/open-telemetry/opentelemetry-python/pull/4854))
 - [BREAKING] `opentelemetry-sdk`, `opentelemetry-exporter-otlp-proto-common`: Add support for metric data-point flags
   ([#4916](https://github.com/open-telemetry/opentelemetry-python/pull/4916))
 

CONTRIBUTING.md

@@ -234,7 +234,14 @@ git commit
 git push fork feature
 ```
 
-Open a pull request against the main `opentelemetry-python` repo.
+Open a pull request (PR) against the main `opentelemetry-python` repo.
+
+A descriptive PR title will help the community better triage and review your changes. Make sure to prefix with the name(s) of the package/subdirectory/domain that your PR updates. Following any of these examples will help:
+
+* "opentelemetry-sdk: make test_force_flush_late_by_timeout less flaky on pypy/windows"
+* "opentelemetry-exporter-otlp-proto-http: enable typechecking"
+* "docs: replace TODO placeholders with API and SDK overview descriptions"
+* "feat(config): Add TracerProvider support for declarative config"
 
 Pull requests are also tested for their compatibility with packages distributed
 by OpenTelemetry in the [OpenTelemetry Python Contrib Repository](https://github.com/open-telemetry/opentelemetry-python.git).

codegen/opentelemetry-codegen-json/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "opentelemetry-codegen-json"
-dynamic = ["version"]
+version = "0.0.0" # Not published to PyPI
 description = "Protobuf plugin to generate JSON serializers and deserializers for OpenTelemetry protobuf messages"
 readme = "README.rst"
 license = "Apache-2.0"

codegen/opentelemetry-codegen-json/src/opentelemetry/codegen/json/generator.py

@@ -23,7 +23,6 @@
     is_int64_type,
     to_json_field_name,
 )
-from opentelemetry.codegen.json.version import __version__ as GENERATOR_VERSION
 from opentelemetry.codegen.json.writer import CodeWriter
 
 _logger = logging.getLogger(__name__)
@@ -1046,9 +1045,7 @@ def generate_code(
     Returns:
         Dictionary mapping output file paths to generated code
     """
-    generator = OtlpJsonGenerator(
-        request, package_transform, version=GENERATOR_VERSION
-    )
+    generator = OtlpJsonGenerator(request, package_transform, version="0.0.0")
     return generator.generate_all()
 
 

codegen/opentelemetry-codegen-json/src/opentelemetry/codegen/json/plugin.py

@@ -11,7 +11,6 @@
 from google.protobuf.compiler import plugin_pb2 as plugin
 
 from opentelemetry.codegen.json.generator import generate_plugin_response
-from opentelemetry.codegen.json.version import __version__
 
 _logger = logging.getLogger(__name__)
 
@@ -24,7 +23,7 @@ def code_generation() -> Iterator[
     Context manager for handling the code generation process.
     """
     if len(sys.argv) > 1 and sys.argv[1] in ("-V", "--version"):
-        print("opentelemetry-codegen-json " + __version__)
+        print("opentelemetry-codegen-json 0.0.0")
         sys.exit(0)
 
     data = sys.stdin.buffer.read()

codegen/opentelemetry-codegen-json/src/opentelemetry/codegen/json/version/__init__.py

@@ -14,6 +14,6 @@ requests==2.32.3
 ruamel.yaml==0.17.21
 asgiref==3.7.2
 psutil==7.2.2
-GitPython==3.1.47
+GitPython==3.1.50
 pre-commit==3.7.0
 ruff==0.14.1

dev-requirements.txt

@@ -5,10 +5,10 @@
 
 from collections import Counter
 from collections.abc import Iterator
-from contextlib import contextmanager
+from contextlib import AbstractContextManager, contextmanager
 from dataclasses import dataclass
 from time import perf_counter
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Protocol
 
 from opentelemetry.metrics import MeterProvider, get_meter_provider
 from opentelemetry.semconv._incubating.attributes.otel_attributes import (
@@ -46,6 +46,18 @@ class ExportResult:
     error_attrs: Attributes = None
 
 
+class ExporterMetricsT(Protocol):
+    def export_operation(
+        self, num_items: int
+    ) -> AbstractContextManager[ExportResult]: ...
+
+
+class NoOpExporterMetrics:
+    @contextmanager
+    def export_operation(self, num_items: int) -> Iterator[ExportResult]:
+        yield ExportResult()
+
+
 class ExporterMetrics:
     def __init__(
         self,
@@ -75,14 +87,14 @@ def __init__(
             elif endpoint.scheme == "http":
                 port = 80
 
-        component_type = (
-            component_type or OtelComponentTypeValues("unknown_otlp_exporter")
-        ).value
-        count = _component_counter[component_type]
-        _component_counter[component_type] = count + 1
+        component_type_value = (
+            component_type.value if component_type else "unknown_otlp_exporter"
+        )
+        count = _component_counter[component_type_value]
+        _component_counter[component_type_value] = count + 1
         self._standard_attrs: dict[str, AttributeValue] = {
-            OTEL_COMPONENT_TYPE: component_type,
-            OTEL_COMPONENT_NAME: f"{component_type}/{count}",
+            OTEL_COMPONENT_TYPE: component_type_value,
+            OTEL_COMPONENT_NAME: f"{component_type_value}/{count}",
         }
         if endpoint.hostname:
             self._standard_attrs[SERVER_ADDRESS] = endpoint.hostname
@@ -121,3 +133,21 @@ def export_operation(self, num_items: int) -> Iterator[ExportResult]:
                 else exported_attrs
             )
             self._duration.record(end_time - start_time, duration_attrs)
+
+
+def create_exporter_metrics(
+    component_type: OtelComponentTypeValues | None,
+    signal: Literal["traces", "metrics", "logs"],
+    endpoint: UrlParseResult,
+    meter_provider: MeterProvider | None,
+    enabled: bool,
+) -> ExporterMetricsT:
+    if not enabled:
+        return NoOpExporterMetrics()
+
+    return ExporterMetrics(
+        component_type,
+        signal,
+        endpoint,
+        meter_provider,
+    )

exporter/opentelemetry-exporter-otlp-proto-common/src/opentelemetry/exporter/otlp/proto/common/_exporter_metrics.py

@@ -0,0 +1,59 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+import unittest
+from unittest.mock import Mock, patch
+from urllib.parse import urlparse
+
+from opentelemetry.exporter.otlp.proto.common._exporter_metrics import (
+    ExporterMetrics,
+    NoOpExporterMetrics,
+    create_exporter_metrics,
+)
+from opentelemetry.semconv._incubating.attributes.otel_attributes import (
+    OtelComponentTypeValues,
+)
+
+
+class TestExporterMetrics(unittest.TestCase):
+    def test_factory_returns_noop_when_disabled(self):
+        meter_provider = Mock()
+
+        with patch(
+            "opentelemetry.exporter.otlp.proto.common."
+            "_exporter_metrics.get_meter_provider"
+        ) as get_meter_provider:
+            metrics = create_exporter_metrics(
+                OtelComponentTypeValues.OTLP_HTTP_SPAN_EXPORTER,
+                "traces",
+                urlparse("http://localhost:4318/v1/traces"),
+                meter_provider,
+                False,
+            )
+
+        self.assertIsInstance(metrics, NoOpExporterMetrics)
+        meter_provider.get_meter.assert_not_called()
+        get_meter_provider.assert_not_called()
+
+    def test_factory_returns_exporter_metrics_when_enabled(self):
+        meter_provider = Mock()
+        meter_provider.get_meter.return_value = Mock()
+
+        metrics = create_exporter_metrics(
+            OtelComponentTypeValues.OTLP_HTTP_SPAN_EXPORTER,
+            "traces",
+            urlparse("http://localhost:4318/v1/traces"),
+            meter_provider,
+            True,
+        )
+
+        self.assertIsInstance(metrics, ExporterMetrics)
+        meter_provider.get_meter.assert_called_once_with("opentelemetry-sdk")
+
+    def test_noop_export_operation_yields_result(self):
+        metrics = NoOpExporterMetrics()
+
+        with metrics.export_operation(1) as result:
+            result.error = RuntimeError("error")
+
+        self.assertIsInstance(result.error, RuntimeError)

exporter/opentelemetry-exporter-otlp-proto-common/tests/test_exporter_metrics.py

@@ -46,7 +46,7 @@
     ssl_channel_credentials,
 )
 from opentelemetry.exporter.otlp.proto.common._exporter_metrics import (
-    ExporterMetrics,
+    create_exporter_metrics,
 )
 from opentelemetry.exporter.otlp.proto.common._internal import (
     _get_resource_data,
@@ -93,6 +93,7 @@
     OTEL_EXPORTER_OTLP_HEADERS,
     OTEL_EXPORTER_OTLP_INSECURE,
     OTEL_EXPORTER_OTLP_TIMEOUT,
+    OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED,
 )
 from opentelemetry.sdk.metrics.export import MetricExportResult, MetricsData
 from opentelemetry.sdk.resources import Resource as SDKResource
@@ -395,11 +396,15 @@ def __init__(
         self._component_type = component_type
         self._signal: Literal["traces", "metrics", "logs"] = signal
         self._parsed_url = parsed_url
-        self._metrics = ExporterMetrics(
+        self._metrics = create_exporter_metrics(
             self._component_type,
             signal,
             parsed_url,
             meter_provider,
+            os.environ.get(OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED, "")
+            .strip()
+            .lower()
+            == "true",
         )
 
         self._initialize_channel_and_stub()
@@ -557,9 +562,13 @@ def _exporting(self) -> str:
         pass
 
     def _set_meter_provider(self, meter_provider: MeterProvider) -> None:
-        self._metrics = ExporterMetrics(
+        self._metrics = create_exporter_metrics(
             self._component_type,
             self._signal,
             self._parsed_url,
             meter_provider,
+            os.environ.get(OTEL_PYTHON_SDK_INTERNAL_METRICS_ENABLED, "")
+            .strip()
+            .lower()
+            == "true",
         )