Skip to content

Defensively import and vendor experimental components #41245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions sdk/monitor/azure-monitor-opentelemetry/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@

### Other Changes

- Defensively import and vendor experimental components from OpenTelemetry and azure.core + upgrade dependencies to latest OpenTelemetry
([#41245](https://github.com/Azure/azure-sdk-for-python/pull/41245))

## 1.6.9 (2025-05-12)

### Features Added
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,10 @@
from logging import getLogger, Formatter
from typing import Dict, List, cast

from opentelemetry._events import _set_event_logger_provider
from opentelemetry._logs import set_logger_provider
from opentelemetry.instrumentation.dependencies import (
get_dist_dependency_conflicts,
)
from opentelemetry.instrumentation.instrumentor import ( # type: ignore
BaseInstrumentor,
)
from opentelemetry.metrics import set_meter_provider
from opentelemetry.sdk._events import EventLoggerProvider
from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
from opentelemetry.sdk.metrics import MeterProvider
from opentelemetry.sdk.metrics.export import PeriodicExportingMetricReader
from opentelemetry.sdk.metrics.view import View
Expand All @@ -32,8 +24,6 @@
entry_points,
)

from azure.core.settings import settings
from azure.core.tracing.ext.opentelemetry_span import OpenTelemetrySpan
from azure.monitor.opentelemetry._constants import (
_ALL_SUPPORTED_INSTRUMENTED_LIBRARIES,
_AZURE_SDK_INSTRUMENTATION_NAME,
Expand All @@ -58,7 +48,6 @@
)
from azure.monitor.opentelemetry.exporter import ( # pylint: disable=import-error,no-name-in-module
ApplicationInsightsSampler,
AzureMonitorLogExporter,
AzureMonitorMetricExporter,
AzureMonitorTraceExporter,
)
Expand All @@ -74,6 +63,9 @@
_get_configurations,
_is_instrumentation_enabled,
)
from azure.monitor.opentelemetry._utils.instrumentation import (
get_dist_dependency_conflicts,
)

_logger = getLogger(__name__)

Expand Down Expand Up @@ -156,42 +148,91 @@ def _setup_tracing(configurations: Dict[str, ConfigurationValue]):
)
tracer_provider.add_span_processor(bsp)
set_tracer_provider(tracer_provider)

if _is_instrumentation_enabled(configurations, _AZURE_SDK_INSTRUMENTATION_NAME):
settings.tracing_implementation = OpenTelemetrySpan
try:
from azure.core.settings import settings
from azure.core.tracing.ext.opentelemetry_span import OpenTelemetrySpan

settings.tracing_implementation = OpenTelemetrySpan
except ImportError as ex:
# This could possibly be due to breaking change in upstream OpenTelemetry
# Advise user to upgrade to latest OpenTelemetry version
_logger.warning( # pylint: disable=do-not-log-exceptions-if-not-debug
"Exception occurred when importing Azure SDK Tracing." \
"Please upgrade to the latest OpenTelemetry version: %s.",
ex,
)
except Exception as ex: # pylint: disable=broad-except
_logger.warning( # pylint: disable=do-not-log-exceptions-if-not-debug
"Exception occurred when setting Azure SDK Tracing: %s.",
ex,
)


def _setup_logging(configurations: Dict[str, ConfigurationValue]):
resource: Resource = configurations[RESOURCE_ARG] # type: ignore
logger_provider = LoggerProvider(resource=resource)
if configurations.get(ENABLE_LIVE_METRICS_ARG):
qlp = _QuickpulseLogRecordProcessor()
logger_provider.add_log_record_processor(qlp)
log_exporter = AzureMonitorLogExporter(**configurations)
log_record_processor = BatchLogRecordProcessor(
log_exporter,
)
logger_provider.add_log_record_processor(log_record_processor)
set_logger_provider(logger_provider)
logger_name: str = configurations[LOGGER_NAME_ARG] # type: ignore
logging_formatter: Formatter = configurations[LOGGING_FORMATTER_ARG] # type: ignore
logger = getLogger(logger_name)
# Only add OpenTelemetry LoggingHandler if logger does not already have the handler
# This is to prevent most duplicate logging telemetry
if not any(isinstance(handler, LoggingHandler) for handler in logger.handlers):
handler = LoggingHandler(logger_provider=logger_provider)
if logging_formatter:
try:
handler.setFormatter(logging_formatter)
except Exception as ex: # pylint: disable=broad-except
_logger.warning( # pylint: disable=do-not-log-exceptions-if-not-debug
"Exception occurred when adding logging Formatter: %s.",
ex,
)
logger.addHandler(handler)
# Setup logging
# Use try catch while signal is experimental
try:
from opentelemetry._logs import set_logger_provider
from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
from opentelemetry.sdk._logs.export import BatchLogRecordProcessor

from azure.monitor.opentelemetry.exporter import ( # pylint: disable=import-error,no-name-in-module
AzureMonitorLogExporter
)

# Setup EventLoggerProvider
event_provider = EventLoggerProvider(logger_provider)
_set_event_logger_provider(event_provider, False)
resource: Resource = configurations[RESOURCE_ARG] # type: ignore
logger_provider = LoggerProvider(resource=resource)
if configurations.get(ENABLE_LIVE_METRICS_ARG):
qlp = _QuickpulseLogRecordProcessor()
logger_provider.add_log_record_processor(qlp)
log_exporter = AzureMonitorLogExporter(**configurations)
log_record_processor = BatchLogRecordProcessor(
log_exporter,
)
logger_provider.add_log_record_processor(log_record_processor)
set_logger_provider(logger_provider)
logger_name: str = configurations[LOGGER_NAME_ARG] # type: ignore
logging_formatter: Formatter = configurations[LOGGING_FORMATTER_ARG] # type: ignore
logger = getLogger(logger_name)
# Only add OpenTelemetry LoggingHandler if logger does not already have the handler
# This is to prevent most duplicate logging telemetry
if not any(isinstance(handler, LoggingHandler) for handler in logger.handlers):
handler = LoggingHandler(logger_provider=logger_provider)
if logging_formatter:
try:
handler.setFormatter(logging_formatter)
except Exception as ex: # pylint: disable=broad-except
_logger.warning( # pylint: disable=do-not-log-exceptions-if-not-debug
"Exception occurred when adding logging Formatter: %s.",
ex,
)
logger.addHandler(handler)

# Setup Events
try:
from opentelemetry._events import _set_event_logger_provider
from opentelemetry.sdk._events import EventLoggerProvider

event_provider = EventLoggerProvider(logger_provider)
_set_event_logger_provider(event_provider, False)
except ImportError as ex:
# If the events is not available, we will not set it up.
# This could possibly be due to breaking change in upstream OpenTelemetry
# Advise user to upgrade to latest OpenTelemetry version
_logger.warning( # pylint: disable=do-not-log-exceptions-if-not-debug
"Exception occurred when setting up Events. Please upgrade to the latest OpenTelemetry version: %s.",
ex,
)
except ImportError as ex:
# If the events is not available, we will not set it up.
# This could possibly be due to breaking change in upstream OpenTelemetry
# Advise user to upgrade to latest OpenTelemetry version
_logger.warning( # pylint: disable=do-not-log-exceptions-if-not-debug
"Exception occurred when setting up Logging. Please upgrade to the latest OpenTelemetry version: %s.",
ex,
)


def _setup_metrics(configurations: Dict[str, ConfigurationValue]):
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License in the project root for
# license information.
# --------------------------------------------------------------------------

from __future__ import annotations

from logging import getLogger
from typing import Collection

from packaging.requirements import InvalidRequirement, Requirement

from opentelemetry.util._importlib_metadata import (
Distribution,
PackageNotFoundError,
version,
)

logger = getLogger(__name__)

# --------------------Instrumentation------------------------------

# The below classes/functions are vendored from upstream OpenTelemetry Python due to being experimental.
# Due to possible breaking changes in the upstream code, we have decided to vendor this code

# TODO: Remove this vendored code once the upstream code is stable and released.
# Original breaking PR: https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3202
# Tracking issue: https://github.com/open-telemetry/opentelemetry-python-contrib/issues/3434

class DependencyConflict:
required: str | None = None
found: str | None = None

def __init__(self, required: str | None, found: str | None = None):
self.required = required
self.found = found

def __str__(self):
return f'DependencyConflict: requested: "{self.required}" but found: "{self.found}"'


def get_dist_dependency_conflicts(
dist: Distribution,
) -> DependencyConflict | None:
instrumentation_deps = []
extra = "extra"
instruments = "instruments"
instruments_marker = {extra: instruments}
if dist.requires:
for dep in dist.requires:
if extra not in dep or instruments not in dep:
continue

req = Requirement(dep)
if req.marker.evaluate(instruments_marker): # type: ignore
instrumentation_deps.append(req)

return get_dependency_conflicts(instrumentation_deps)


def get_dependency_conflicts(
deps: Collection[str | Requirement],
) -> DependencyConflict | None:
for dep in deps:
if isinstance(dep, Requirement):
req = dep
else:
try:
req = Requirement(dep)
except InvalidRequirement as exc:
logger.warning(
'error parsing dependency, reporting as a conflict: "%s" - %s',
dep,
exc,
)
return DependencyConflict(dep)

try:
dist_version = version(req.name)
except PackageNotFoundError:
return DependencyConflict(dep) # type: ignore

if not req.specifier.contains(dist_version):
return DependencyConflict(dep, f"{req.name} {dist_version}") # type: ignore
return None
Loading