Skip to content

Added changes for rate limited sampler (azure-distro changes) #41976

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.

Sign up for GitHub

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+229 −22
Draft

Added changes for rate limited sampler (azure-distro changes) #41976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de65c50
RateLimitedSampler distro changes
rads-1996 Jul 10, 2025
c9c635d
Fixed formatting errors
rads-1996 Jul 10, 2025
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
1 change: 1 addition & 0 deletions sdk/monitor/azure-monitor-opentelemetry/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## 1.6.11 (Unreleased)

### Features Added
- Added RateLimited Sampler Config changes

### Breaking Changes

Expand Down
18 changes: 14 additions & 4 deletions sdk/monitor/azure-monitor-opentelemetry/azure/monitor/opentelemetry/_configure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
LOGGING_FORMATTER_ARG,
RESOURCE_ARG,
SAMPLING_RATIO_ARG,
SAMPLING_TRACES_PER_SECOND_ARG,
SPAN_PROCESSORS_ARG,
VIEWS_ARG,
)
Expand All @@ -50,6 +51,7 @@
ApplicationInsightsSampler,
AzureMonitorMetricExporter,
AzureMonitorTraceExporter,
RateLimitedSampler,
)
from azure.monitor.opentelemetry.exporter._utils import ( # pylint: disable=import-error,no-name-in-module
_is_attach_enabled,
Expand Down Expand Up @@ -133,10 +135,18 @@ def configure_azure_monitor(**kwargs) -> None: # pylint: disable=C4758

def _setup_tracing(configurations: Dict[str, ConfigurationValue]):
resource: 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
)
if SAMPLING_TRACES_PER_SECOND_ARG in configurations:
sampling_traces_per_second = configurations[SAMPLING_TRACES_PER_SECOND_ARG]
tracer_provider = TracerProvider(
sampler=RateLimitedSampler(sampling_traces_per_second=cast(float, sampling_traces_per_second)), resource=resource
)
else:
sampling_ratio = configurations[SAMPLING_RATIO_ARG]
tracer_provider = TracerProvider(
sampler=ApplicationInsightsSampler(sampling_ratio=cast(float, sampling_ratio)), resource=resource
)


for span_processor in configurations[SPAN_PROCESSORS_ARG]: # type: ignore
tracer_provider.add_span_processor(span_processor) # type: ignore
if configurations.get(ENABLE_LIVE_METRICS_ARG):
Expand Down
4 changes: 3 additions & 1 deletion sdk/monitor/azure-monitor-opentelemetry/azure/monitor/opentelemetry/_constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@
SAMPLING_RATIO_ARG = "sampling_ratio"
SPAN_PROCESSORS_ARG = "span_processors"
VIEWS_ARG = "views"

RATE_LIMITED_SAMPLER = "microsoft.rate_limited"
FIXED_PERCENTAGE_SAMPLER = "microsoft.fixed.percentage"
SAMPLING_TRACES_PER_SECOND_ARG = "sampling_traces_per_second"

# --------------------Autoinstrumentation Configuration------------------------------------------

Expand Down
54 changes: 44 additions & 10 deletions sdk/monitor/azure-monitor-opentelemetry/azure/monitor/opentelemetry/_utils/configurations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
from opentelemetry.sdk.environment_variables import (
OTEL_EXPERIMENTAL_RESOURCE_DETECTORS,
OTEL_TRACES_SAMPLER_ARG,
OTEL_TRACES_SAMPLER
)
from opentelemetry.sdk.resources import Resource

Expand All @@ -37,25 +38,25 @@
LOGGING_FORMATTER_ARG,
RESOURCE_ARG,
SAMPLING_RATIO_ARG,
SAMPLING_TRACES_PER_SECOND_ARG,
SPAN_PROCESSORS_ARG,
VIEWS_ARG,
RATE_LIMITED_SAMPLER,
FIXED_PERCENTAGE_SAMPLER,
)
from azure.monitor.opentelemetry._types import ConfigurationValue
from azure.monitor.opentelemetry._version import VERSION


_INVALID_FLOAT_MESSAGE = "Value of %s must be a float. Defaulting to %s: %s"
_INVALID_TRACES_PER_SECOND_MESSAGE = "Value of %s must be a positive number for traces per second. 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


_logger = getLogger(__name__)


def _get_configurations(**kwargs) -> Dict[str, ConfigurationValue]:
configurations = {}

Expand Down Expand Up @@ -120,21 +121,54 @@ def _default_resource(configurations):
configurations[RESOURCE_ARG] = Resource.create(configurations[RESOURCE_ARG].attributes)


# TODO: remove when sampler uses env var instead
def _default_sampling_ratio(configurations):
default = 1.0
if SAMPLING_RATIO_ENV_VAR in environ:

if environ.get(OTEL_TRACES_SAMPLER_ARG) is not None:
try:
if float(environ[OTEL_TRACES_SAMPLER_ARG]) < 0:
_logger.error("Invalid value for OTEL_TRACES_SAMPLER_ARG. It should be a non-negative number.")
except ValueError:
pass
else:
_logger.error("OTEL_TRACES_SAMPLER_ARG is not set.")

# Check if rate-limited sampler is configured
if environ.get(OTEL_TRACES_SAMPLER) == RATE_LIMITED_SAMPLER:
Comment on lines +127 to +137
Copy link
Preview

Copilot AI Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This block logs errors for missing or unset OTEL_TRACES_SAMPLER_ARG even when no custom sampler is requested. Consider only validating or logging when OTEL_TRACES_SAMPLER is set to a non-default value to avoid confusing error noise.

Suggested change
if environ.get(OTEL_TRACES_SAMPLER_ARG) is not None:
try:
if float(environ[OTEL_TRACES_SAMPLER_ARG]) < 0:
_logger.error("Invalid value for OTEL_TRACES_SAMPLER_ARG. It should be a non-negative number.")
except ValueError:
pass
else:
_logger.error("OTEL_TRACES_SAMPLER_ARG is not set.")
# Check if rate-limited sampler is configured
if environ.get(OTEL_TRACES_SAMPLER) == RATE_LIMITED_SAMPLER:
# Check if rate-limited sampler is configured
if environ.get(OTEL_TRACES_SAMPLER) == RATE_LIMITED_SAMPLER:
if environ.get(OTEL_TRACES_SAMPLER_ARG) is not None:
try:
if float(environ[OTEL_TRACES_SAMPLER_ARG]) < 0:
_logger.error("Invalid value for OTEL_TRACES_SAMPLER_ARG. It should be a non-negative number.")
except ValueError:
pass
else:
_logger.error("OTEL_TRACES_SAMPLER_ARG is not set.")

Copilot uses AI. Check for mistakes.

try:
default = float(environ[OTEL_TRACES_SAMPLER_ARG])
_logger.info(f"Using rate limited sampler: {default} traces per second")
except ValueError as e:
_logger.error( # pylint: disable=C
_INVALID_TRACES_PER_SECOND_MESSAGE,
OTEL_TRACES_SAMPLER_ARG,
default,
e,
)
configurations[SAMPLING_TRACES_PER_SECOND_ARG] = default
elif environ.get(OTEL_TRACES_SAMPLER) == FIXED_PERCENTAGE_SAMPLER:
try:
default = float(environ[SAMPLING_RATIO_ENV_VAR])
default = float(environ[OTEL_TRACES_SAMPLER_ARG])
_logger.info(f"Using sampling ratio: {default}")
except ValueError as e:
_logger.error( # pylint: disable=C
_INVALID_FLOAT_MESSAGE,
SAMPLING_RATIO_ENV_VAR,
OTEL_TRACES_SAMPLER_ARG,
default,
e,
)
configurations[SAMPLING_RATIO_ARG] = default

configurations[SAMPLING_RATIO_ARG] = default
else:
# Default behavior - always set sampling_ratio
configurations[SAMPLING_RATIO_ARG] = default
_logger.error( # pylint: disable=C
"Invalid argument for the sampler to be used for tracing. "
"Supported values are %s and %s. Defaulting to %s: %s",
RATE_LIMITED_SAMPLER,
FIXED_PERCENTAGE_SAMPLER,
OTEL_TRACES_SAMPLER,
OTEL_TRACES_SAMPLER_ARG,
)

def _default_instrumentation_options(configurations):
otel_disabled_instrumentations = _get_otel_disabled_instrumentations()
Expand Down
174 changes: 167 additions & 7 deletions sdk/monitor/azure-monitor-opentelemetry/tests/utils/test_configurations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,20 @@
from unittest import TestCase
from unittest.mock import patch

from opentelemetry.instrumentation.environment_variables import (
OTEL_PYTHON_DISABLED_INSTRUMENTATIONS,
from opentelemetry.sdk.environment_variables import (
OTEL_EXPERIMENTAL_RESOURCE_DETECTORS,
OTEL_TRACES_SAMPLER_ARG,
OTEL_TRACES_SAMPLER
)
from opentelemetry.instrumentation.environment_variables import (
OTEL_PYTHON_DISABLED_INSTRUMENTATIONS,)
from azure.monitor.opentelemetry._utils.configurations import (
SAMPLING_RATIO_ENV_VAR,
_get_configurations,
)
from azure.monitor.opentelemetry._constants import (
RATE_LIMITED_SAMPLER,
FIXED_PERCENTAGE_SAMPLER,
)
from opentelemetry.environment_variables import (
OTEL_LOGS_EXPORTER,
OTEL_METRICS_EXPORTER,
Expand Down Expand Up @@ -134,7 +141,7 @@ def test_get_configurations_defaults(self, resource_create_mock):
"os.environ",
{
OTEL_PYTHON_DISABLED_INSTRUMENTATIONS: "flask,requests,fastapi,azure_sdk",
SAMPLING_RATIO_ENV_VAR: "0.5",
OTEL_TRACES_SAMPLER_ARG: "0.5",
OTEL_TRACES_EXPORTER: "None",
OTEL_LOGS_EXPORTER: "none",
OTEL_METRICS_EXPORTER: "NONE",
Expand Down Expand Up @@ -166,12 +173,13 @@ def test_get_configurations_env_vars(self, resource_create_mock):
self.assertEqual(configurations["resource"].attributes, TEST_DEFAULT_RESOURCE.attributes)
self.assertEqual(environ[OTEL_EXPERIMENTAL_RESOURCE_DETECTORS], "custom_resource_detector")
resource_create_mock.assert_called_once_with()
self.assertEqual(configurations["sampling_ratio"], 0.5)
self.assertEqual(configurations["sampling_ratio"], 1.0)

@patch.dict(
"os.environ",
{
SAMPLING_RATIO_ENV_VAR: "Half",
OTEL_TRACES_SAMPLER: FIXED_PERCENTAGE_SAMPLER,
OTEL_TRACES_SAMPLER_ARG: "Half",
OTEL_TRACES_EXPORTER: "False",
OTEL_LOGS_EXPORTER: "no",
OTEL_METRICS_EXPORTER: "True",
Expand All @@ -181,7 +189,6 @@ def test_get_configurations_env_vars(self, resource_create_mock):
@patch("opentelemetry.sdk.resources.Resource.create", return_value=TEST_DEFAULT_RESOURCE)
def test_get_configurations_env_vars_validation(self, resource_create_mock):
configurations = _get_configurations()

self.assertTrue("connection_string" not in configurations)
self.assertEqual(configurations["disable_logging"], False)
self.assertEqual(configurations["disable_metrics"], False)
Expand Down Expand Up @@ -260,3 +267,156 @@ def test_merge_instrumentation_options_extra_args(self, resource_create_mock):
"urllib3": {"enabled": True},
},
)
@patch.dict(
"os.environ",
{
OTEL_PYTHON_DISABLED_INSTRUMENTATIONS: "flask,requests,fastapi,azure_sdk",
OTEL_TRACES_SAMPLER: RATE_LIMITED_SAMPLER,
OTEL_TRACES_SAMPLER_ARG: "0.5",
OTEL_TRACES_EXPORTER: "None",
OTEL_LOGS_EXPORTER: "none",
OTEL_METRICS_EXPORTER: "NONE",
OTEL_EXPERIMENTAL_RESOURCE_DETECTORS: "custom_resource_detector",
},
clear=True,
)
@patch("opentelemetry.sdk.resources.Resource.create", return_value=TEST_DEFAULT_RESOURCE)
def test_get_configurations_env_vars_rate_limited(self, resource_create_mock):
configurations = _get_configurations()

self.assertTrue("connection_string" not in configurations)
self.assertEqual(configurations["disable_logging"], True)
self.assertEqual(configurations["disable_metrics"], True)
self.assertEqual(configurations["disable_tracing"], True)
self.assertEqual(
configurations["instrumentation_options"],
{
"azure_sdk": {"enabled": False},
"django": {"enabled": True},
"fastapi": {"enabled": False},
"flask": {"enabled": False},
"psycopg2": {"enabled": True},
"requests": {"enabled": False},
"urllib": {"enabled": True},
"urllib3": {"enabled": True},
},
)
self.assertEqual(configurations["resource"].attributes, TEST_DEFAULT_RESOURCE.attributes)
self.assertEqual(environ[OTEL_EXPERIMENTAL_RESOURCE_DETECTORS], "custom_resource_detector")
resource_create_mock.assert_called_once_with()
self.assertEqual(configurations["sampling_traces_per_second"], 0.5)

@patch.dict(
"os.environ",
{
OTEL_PYTHON_DISABLED_INSTRUMENTATIONS: "flask,requests,fastapi,azure_sdk",
OTEL_TRACES_SAMPLER_ARG: "34",
OTEL_TRACES_EXPORTER: "None",
OTEL_LOGS_EXPORTER: "none",
OTEL_METRICS_EXPORTER: "NONE",
OTEL_EXPERIMENTAL_RESOURCE_DETECTORS: "custom_resource_detector",
},
clear=True,
)
@patch("opentelemetry.sdk.resources.Resource.create", return_value=TEST_DEFAULT_RESOURCE)
def test_get_configurations_env_vars_no_preference(self, resource_create_mock):
configurations = _get_configurations()

self.assertTrue("connection_string" not in configurations)
self.assertEqual(configurations["disable_logging"], True)
self.assertEqual(configurations["disable_metrics"], True)
self.assertEqual(configurations["disable_tracing"], True)
self.assertEqual(
configurations["instrumentation_options"],
{
"azure_sdk": {"enabled": False},
"django": {"enabled": True},
"fastapi": {"enabled": False},
"flask": {"enabled": False},
"psycopg2": {"enabled": True},
"requests": {"enabled": False},
"urllib": {"enabled": True},
"urllib3": {"enabled": True},
},
)
self.assertEqual(configurations["resource"].attributes, TEST_DEFAULT_RESOURCE.attributes)
self.assertEqual(environ[OTEL_EXPERIMENTAL_RESOURCE_DETECTORS], "custom_resource_detector")
resource_create_mock.assert_called_once_with()
self.assertEqual(configurations["sampling_ratio"], 1.0)

@patch.dict(
"os.environ",
{
OTEL_PYTHON_DISABLED_INSTRUMENTATIONS: "flask,requests,fastapi,azure_sdk",
OTEL_TRACES_SAMPLER_ARG: "2 traces per second",
OTEL_TRACES_EXPORTER: "None",
OTEL_LOGS_EXPORTER: "none",
OTEL_METRICS_EXPORTER: "NONE",
OTEL_EXPERIMENTAL_RESOURCE_DETECTORS: "custom_resource_detector",
},
clear=True,
)
@patch("opentelemetry.sdk.resources.Resource.create", return_value=TEST_DEFAULT_RESOURCE)
def test_get_configurations_env_vars_check_default(self, resource_create_mock):
configurations = _get_configurations()

self.assertTrue("connection_string" not in configurations)
self.assertEqual(configurations["disable_logging"], True)
self.assertEqual(configurations["disable_metrics"], True)
self.assertEqual(configurations["disable_tracing"], True)
self.assertEqual(
configurations["instrumentation_options"],
{
"azure_sdk": {"enabled": False},
"django": {"enabled": True},
"fastapi": {"enabled": False},
"flask": {"enabled": False},
"psycopg2": {"enabled": True},
"requests": {"enabled": False},
"urllib": {"enabled": True},
"urllib3": {"enabled": True},
},
)
self.assertEqual(configurations["resource"].attributes, TEST_DEFAULT_RESOURCE.attributes)
self.assertEqual(environ[OTEL_EXPERIMENTAL_RESOURCE_DETECTORS], "custom_resource_detector")
resource_create_mock.assert_called_once_with()
self.assertEqual(configurations["sampling_ratio"], 1.0)

@patch.dict(
"os.environ",
{
OTEL_PYTHON_DISABLED_INSTRUMENTATIONS: "flask,requests,fastapi,azure_sdk",
OTEL_TRACES_SAMPLER: FIXED_PERCENTAGE_SAMPLER,
OTEL_TRACES_SAMPLER_ARG: "0.9",
OTEL_TRACES_EXPORTER: "None",
OTEL_LOGS_EXPORTER: "none",
OTEL_METRICS_EXPORTER: "NONE",
OTEL_EXPERIMENTAL_RESOURCE_DETECTORS: "custom_resource_detector",
},
clear=True,
)
@patch("opentelemetry.sdk.resources.Resource.create", return_value=TEST_DEFAULT_RESOURCE)
def test_get_configurations_env_vars_fixed_percentage(self, resource_create_mock):
configurations = _get_configurations()

self.assertTrue("connection_string" not in configurations)
self.assertEqual(configurations["disable_logging"], True)
self.assertEqual(configurations["disable_metrics"], True)
self.assertEqual(configurations["disable_tracing"], True)
self.assertEqual(
configurations["instrumentation_options"],
{
"azure_sdk": {"enabled": False},
"django": {"enabled": True},
"fastapi": {"enabled": False},
"flask": {"enabled": False},
"psycopg2": {"enabled": True},
"requests": {"enabled": False},
"urllib": {"enabled": True},
"urllib3": {"enabled": True},
},
)
self.assertEqual(configurations["resource"].attributes, TEST_DEFAULT_RESOURCE.attributes)
self.assertEqual(environ[OTEL_EXPERIMENTAL_RESOURCE_DETECTORS], "custom_resource_detector")
resource_create_mock.assert_called_once_with()
self.assertEqual(configurations["sampling_ratio"], 0.9)
Loading