Enables .NET OTEL Metrics Tests (#5535)

Co-authored-by: Zach Montoya <[email protected]>
Co-authored-by: Charles de Beauchesne <[email protected]>

Author: 3 people

manifests/dotnet.yml

@@ -585,7 +585,18 @@ tests/:
     test_otel_env_vars.py:
       Test_Otel_Env_Vars: v2.53.0
     test_otel_logs.py: missing_feature
-    test_otel_metrics.py: missing_feature
+    test_otel_metrics.py:
+      Test_Otel_Metrics_Api_Instrument: v3.29.0
+      Test_Otel_Metrics_Api_Meter: v3.29.0
+      Test_Otel_Metrics_Api_MeterProvider: v3.29.0
+      Test_Otel_Metrics_Configuration_Enabled: v3.29.0
+      Test_Otel_Metrics_Configuration_OTLP_Exporter_Metrics_Endpoint: v3.29.0
+      Test_Otel_Metrics_Configuration_OTLP_Exporter_Metrics_Headers: v3.29.0
+      Test_Otel_Metrics_Configuration_OTLP_Exporter_Metrics_Protocol: v3.29.0
+      Test_Otel_Metrics_Configuration_Temporality_Preference: v3.29.0
+      Test_Otel_Metrics_Host_Name: v3.29.0
+      Test_Otel_Metrics_Resource_Attributes: v3.29.0
+      Test_Otel_Metrics_Telemetry: v3.29.0
     test_otel_span_with_baggage.py:
       Test_Otel_Span_With_Baggage: missing_feature
     test_otel_tracer.py:

tests/parametric/test_otel_metrics.py

@@ -2,6 +2,7 @@
 import pytest
 
 from utils import context, features, missing_feature, scenarios
+
 from utils.docker_fixtures import TestAgentAPI
 from .conftest import APMLibrary
 
@@ -10,7 +11,8 @@
 
 DEFAULT_METER_NAME = "parametric-api"
 DEFAULT_METER_VERSION = "1.0.0"
-DEFAULT_SCHEMA_URL = "https://opentelemetry.io/schemas/1.27.0"
+# schema_url is not supported by .NET's System.Diagnostics.Metrics API
+DEFAULT_SCHEMA_URL = "" if context.library == "dotnet" else "https://opentelemetry.io/schemas/1.21.0"
 
 DEFAULT_INSTRUMENT_UNIT = "triggers"
 DEFAULT_INSTRUMENT_DESCRIPTION = "test_description"
@@ -104,7 +106,9 @@ def assert_scope_metric(
         expected_scope_attributes.items()
         == {item["key"]: item["value"]["string_value"] for item in scope_metric["scope"]["attributes"]}.items()
     )
-    assert scope_metric["schema_url"] == schema_url
+
+    if context.library != "dotnet":  # .NET does not support schema_url
+        assert scope_metric["schema_url"] == schema_url
 
 
 def assert_metric_info(metric: dict, name: str, unit: str, description: str):
@@ -121,7 +125,13 @@ def assert_sum_aggregation(
 
     for sum_data_point in sum_aggregation["data_points"]:
         if attributes == {item["key"]: item["value"]["string_value"] for item in sum_data_point["attributes"]}:
-            assert float(sum_data_point.get("as_int", 0)) == value
+            if "as_double" in sum_data_point:
+                actual_value = sum_data_point["as_double"]
+            elif "as_int" in sum_data_point:
+                actual_value = int(sum_data_point["as_int"])
+            else:
+                actual_value = None
+            assert actual_value == value
             assert (
                 attributes.items()
                 == {item["key"]: item["value"]["string_value"] for item in sum_data_point["attributes"]}.items()
@@ -135,7 +145,13 @@ def assert_sum_aggregation(
 def assert_gauge_aggregation(gauge_aggregation: dict, value: int, attributes: dict[str, str]):
     for gauge_data_point in gauge_aggregation["data_points"]:
         if attributes == {item["key"]: item["value"]["string_value"] for item in gauge_data_point["attributes"]}:
-            assert float(gauge_data_point.get("as_int", 0)) == value
+            if "as_double" in gauge_data_point:
+                actual_value = gauge_data_point["as_double"]
+            elif "as_int" in gauge_data_point:
+                actual_value = int(gauge_data_point["as_int"])
+            else:
+                actual_value = None
+            assert actual_value == value
             assert "time_unix_nano" in gauge_data_point
             return
 
@@ -195,7 +211,6 @@ def get_expected_bucket_counts(entries: list[int], bucket_boundaries: list[float
 @scenarios.parametric
 @features.otel_metrics_api
 @missing_feature(context.library == "cpp", reason="Not yet implemented", force_skip=True)
-@missing_feature(context.library == "dotnet", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "golang", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "java", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "php", reason="Not yet implemented", force_skip=True)
@@ -267,7 +282,6 @@ def test_otlp_metrics_disabled(
 @scenarios.parametric
 @features.otel_metrics_api
 @missing_feature(context.library == "cpp", reason="Not yet implemented", force_skip=True)
-@missing_feature(context.library == "dotnet", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "golang", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "java", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "php", reason="Not yet implemented", force_skip=True)
@@ -341,7 +355,6 @@ def test_otel_get_meter_by_distinct(
 @scenarios.parametric
 @features.otel_metrics_api
 @missing_feature(context.library == "cpp", reason="Not yet implemented", force_skip=True)
-@missing_feature(context.library == "dotnet", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "golang", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "java", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "php", reason="Not yet implemented", force_skip=True)
@@ -473,7 +486,11 @@ def test_otel_create_instruments_by_distinct(
 
         # Assert that the ScopeMetrics has the correct Scope, SchemaUrl, and Metrics data
         assert_scope_metric(
-            scope_metrics[0], DEFAULT_METER_NAME, DEFAULT_METER_VERSION, DEFAULT_SCHEMA_URL, DEFAULT_SCOPE_ATTRIBUTES
+            scope_metrics[0],
+            DEFAULT_METER_NAME,
+            DEFAULT_METER_VERSION,
+            DEFAULT_SCHEMA_URL,
+            DEFAULT_SCOPE_ATTRIBUTES,
         )
 
         # Instrument names are case-insensitive, so the measurements for 'name' and 'name_upper' will be recorded by the same Instrument,
@@ -562,7 +579,6 @@ def test_otel_create_instruments_by_distinct(
 @scenarios.parametric
 @features.otel_metrics_api
 @missing_feature(context.library == "cpp", reason="Not yet implemented", force_skip=True)
-@missing_feature(context.library == "dotnet", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "golang", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "java", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "php", reason="Not yet implemented", force_skip=True)
@@ -622,7 +638,11 @@ def test_otel_counter_add_non_negative_and_negative_values(
 
         # Assert that the ScopeMetrics has the correct Scope, SchemaUrl, and Metrics data
         assert_scope_metric(
-            scope_metrics[0], DEFAULT_METER_NAME, DEFAULT_METER_VERSION, DEFAULT_SCHEMA_URL, DEFAULT_SCOPE_ATTRIBUTES
+            scope_metrics[0],
+            DEFAULT_METER_NAME,
+            DEFAULT_METER_VERSION,
+            DEFAULT_SCHEMA_URL,
+            DEFAULT_SCOPE_ATTRIBUTES,
         )
 
         metric = scope_metrics[0]["metrics"][0]
@@ -669,7 +689,11 @@ def test_otel_counter_add_non_negative_values_with_different_tags(
 
         # Assert that the ScopeMetrics has the correct Scope, SchemaUrl, and Metrics data
         assert_scope_metric(
-            scope_metrics[0], DEFAULT_METER_NAME, DEFAULT_METER_VERSION, DEFAULT_SCHEMA_URL, DEFAULT_SCOPE_ATTRIBUTES
+            scope_metrics[0],
+            DEFAULT_METER_NAME,
+            DEFAULT_METER_VERSION,
+            DEFAULT_SCHEMA_URL,
+            DEFAULT_SCOPE_ATTRIBUTES,
         )
 
         metric = scope_metrics[0]["metrics"][0]
@@ -723,7 +747,11 @@ def test_otel_updowncounter_add_multiple_values(self, test_agent: TestAgentAPI,
 
         # Assert that the ScopeMetrics has the correct Scope, SchemaUrl, and Metrics data
         assert_scope_metric(
-            scope_metrics[0], DEFAULT_METER_NAME, DEFAULT_METER_VERSION, DEFAULT_SCHEMA_URL, DEFAULT_SCOPE_ATTRIBUTES
+            scope_metrics[0],
+            DEFAULT_METER_NAME,
+            DEFAULT_METER_VERSION,
+            DEFAULT_SCHEMA_URL,
+            DEFAULT_SCOPE_ATTRIBUTES,
         )
 
         metric = find_metric_by_name(scope_metrics[0], name)
@@ -772,7 +800,11 @@ def test_otel_updowncounter_add_multiple_values_with_different_tags(
 
         # Assert that the ScopeMetrics has the correct Scope, SchemaUrl, and Metrics data
         assert_scope_metric(
-            scope_metrics[0], DEFAULT_METER_NAME, DEFAULT_METER_VERSION, DEFAULT_SCHEMA_URL, DEFAULT_SCOPE_ATTRIBUTES
+            scope_metrics[0],
+            DEFAULT_METER_NAME,
+            DEFAULT_METER_VERSION,
+            DEFAULT_SCHEMA_URL,
+            DEFAULT_SCOPE_ATTRIBUTES,
         )
 
         metric = find_metric_by_name(scope_metrics[0], name)
@@ -824,7 +856,11 @@ def test_otel_gauge_record_multiple_values(self, test_agent: TestAgentAPI, test_
 
         # Assert that the ScopeMetrics has the correct Scope, SchemaUrl, and Metrics data
         assert_scope_metric(
-            scope_metrics[0], DEFAULT_METER_NAME, DEFAULT_METER_VERSION, DEFAULT_SCHEMA_URL, DEFAULT_SCOPE_ATTRIBUTES
+            scope_metrics[0],
+            DEFAULT_METER_NAME,
+            DEFAULT_METER_VERSION,
+            DEFAULT_SCHEMA_URL,
+            DEFAULT_SCOPE_ATTRIBUTES,
         )
 
         metric = find_metric_by_name(scope_metrics[0], name)
@@ -865,7 +901,11 @@ def test_otel_gauge_record_multiple_values_with_different_tags(
 
         # Assert that the ScopeMetrics has the correct Scope, SchemaUrl, and Metrics data
         assert_scope_metric(
-            scope_metrics[0], DEFAULT_METER_NAME, DEFAULT_METER_VERSION, DEFAULT_SCHEMA_URL, DEFAULT_SCOPE_ATTRIBUTES
+            scope_metrics[0],
+            DEFAULT_METER_NAME,
+            DEFAULT_METER_VERSION,
+            DEFAULT_SCHEMA_URL,
+            DEFAULT_SCOPE_ATTRIBUTES,
         )
 
         metric = find_metric_by_name(scope_metrics[0], name)
@@ -916,7 +956,11 @@ def test_otel_histogram_add_non_negative_and_negative_values(
 
         # Assert that the ScopeMetrics has the correct Scope, SchemaUrl, and Metrics data
         assert_scope_metric(
-            scope_metrics[0], DEFAULT_METER_NAME, DEFAULT_METER_VERSION, DEFAULT_SCHEMA_URL, DEFAULT_SCOPE_ATTRIBUTES
+            scope_metrics[0],
+            DEFAULT_METER_NAME,
+            DEFAULT_METER_VERSION,
+            DEFAULT_SCHEMA_URL,
+            DEFAULT_SCOPE_ATTRIBUTES,
         )
 
         metric = find_metric_by_name(scope_metrics[0], name)
@@ -970,7 +1014,11 @@ def test_otel_histogram_add_non_negative_values_with_different_tags(
 
         # Assert that the ScopeMetrics has the correct Scope, SchemaUrl, and Metrics data
         assert_scope_metric(
-            scope_metrics[0], DEFAULT_METER_NAME, DEFAULT_METER_VERSION, DEFAULT_SCHEMA_URL, DEFAULT_SCOPE_ATTRIBUTES
+            scope_metrics[0],
+            DEFAULT_METER_NAME,
+            DEFAULT_METER_VERSION,
+            DEFAULT_SCHEMA_URL,
+            DEFAULT_SCOPE_ATTRIBUTES,
         )
 
         metric = find_metric_by_name(scope_metrics[0], name)
@@ -1023,7 +1071,11 @@ def test_otel_asynchronous_counter_constant_callback_value(
 
         # Assert that the ScopeMetrics has the correct Scope, SchemaUrl, and Metrics data
         assert_scope_metric(
-            scope_metrics[0], DEFAULT_METER_NAME, DEFAULT_METER_VERSION, DEFAULT_SCHEMA_URL, DEFAULT_SCOPE_ATTRIBUTES
+            scope_metrics[0],
+            DEFAULT_METER_NAME,
+            DEFAULT_METER_VERSION,
+            DEFAULT_SCHEMA_URL,
+            DEFAULT_SCOPE_ATTRIBUTES,
         )
 
         metric = find_metric_by_name(scope_metrics[0], name)
@@ -1060,7 +1112,11 @@ def test_otel_asynchronous_updowncounter_constant_callback_value(
 
         # Assert that the ScopeMetrics has the correct Scope, SchemaUrl, and Metrics data
         assert_scope_metric(
-            scope_metrics[0], DEFAULT_METER_NAME, DEFAULT_METER_VERSION, DEFAULT_SCHEMA_URL, DEFAULT_SCOPE_ATTRIBUTES
+            scope_metrics[0],
+            DEFAULT_METER_NAME,
+            DEFAULT_METER_VERSION,
+            DEFAULT_SCHEMA_URL,
+            DEFAULT_SCOPE_ATTRIBUTES,
         )
 
         metric = find_metric_by_name(scope_metrics[0], name)
@@ -1095,7 +1151,11 @@ def test_otel_asynchronous_gauge_constant_callback_value(self, test_agent: TestA
 
         # Assert that the ScopeMetrics has the correct Scope, SchemaUrl, and Metrics data
         assert_scope_metric(
-            scope_metrics[0], DEFAULT_METER_NAME, DEFAULT_METER_VERSION, DEFAULT_SCHEMA_URL, DEFAULT_SCOPE_ATTRIBUTES
+            scope_metrics[0],
+            DEFAULT_METER_NAME,
+            DEFAULT_METER_VERSION,
+            DEFAULT_SCHEMA_URL,
+            DEFAULT_SCOPE_ATTRIBUTES,
         )
 
         metric = find_metric_by_name(scope_metrics[0], name)
@@ -1106,7 +1166,6 @@ def test_otel_asynchronous_gauge_constant_callback_value(self, test_agent: TestA
 @scenarios.parametric
 @features.otel_metrics_api
 @missing_feature(context.library == "cpp", reason="Not yet implemented", force_skip=True)
-@missing_feature(context.library == "dotnet", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "golang", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "java", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "php", reason="Not yet implemented", force_skip=True)
@@ -1299,7 +1358,6 @@ def test_otel_aggregation_temporality(
 @scenarios.parametric
 @features.otel_metrics_api
 @missing_feature(context.library == "cpp", reason="Not yet implemented", force_skip=True)
-@missing_feature(context.library == "dotnet", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "golang", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "java", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "php", reason="Not yet implemented", force_skip=True)
@@ -1458,7 +1516,6 @@ def test_otlp_metrics_custom_endpoint_grpc(
 @features.otel_metrics_api
 @scenarios.parametric
 @missing_feature(context.library == "cpp", reason="Not yet implemented", force_skip=True)
-@missing_feature(context.library == "dotnet", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "golang", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "java", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "php", reason="Not yet implemented", force_skip=True)
@@ -1541,7 +1598,6 @@ def test_custom_metrics_http_headers_included_in_otlp_export(
 @features.otel_metrics_api
 @scenarios.parametric
 @missing_feature(context.library == "cpp", reason="Not yet implemented", force_skip=True)
-@missing_feature(context.library == "dotnet", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "golang", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "java", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "php", reason="Not yet implemented", force_skip=True)
@@ -1619,7 +1675,6 @@ def test_otlp_protocol_grpc(self, test_agent: TestAgentAPI, test_library: APMLib
 @features.otel_metrics_api
 @scenarios.parametric
 @missing_feature(context.library == "cpp", reason="Not yet implemented", force_skip=True)
-@missing_feature(context.library == "dotnet", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "golang", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "java", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "nodejs", reason="Does not support DD_HOSTNAME")
@@ -1634,6 +1689,9 @@ class Test_Otel_Metrics_Host_Name:
     - Resource attributes set through environment variable OTEL_RESOURCE_ATTRIBUTES are preserved
     """
 
+    @missing_feature(
+        context.library == "dotnet", reason="DD_HOSTNAME to host.name resource attribute mapping not yet implemented"
+    )
     @pytest.mark.parametrize(
         "library_env",
         [
@@ -1721,7 +1779,6 @@ def test_hostname_omitted(self, test_agent: TestAgentAPI, test_library: APMLibra
 @scenarios.parametric
 @features.otel_metrics_api
 @missing_feature(context.library == "cpp", reason="Not yet implemented", force_skip=True)
-@missing_feature(context.library == "dotnet", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "golang", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "java", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "php", reason="Not yet implemented", force_skip=True)
@@ -1873,7 +1930,6 @@ def test_dd_env_vars_override_otel(self, test_agent: TestAgentAPI, test_library:
 @features.otel_metrics_api
 @scenarios.parametric
 @missing_feature(context.library == "cpp", reason="Not yet implemented", force_skip=True)
-@missing_feature(context.library == "dotnet", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "golang", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "java", reason="Not yet implemented", force_skip=True)
 @missing_feature(context.library == "php", reason="Not yet implemented", force_skip=True)
@@ -1913,7 +1969,6 @@ def test_telemetry_default_configurations(
         configurations_by_name = test_agent.wait_for_telemetry_configurations()
 
         for expected_env, expected_value in [
-            ("OTEL_EXPORTER_OTLP_TIMEOUT", 10000),
             ("OTEL_EXPORTER_OTLP_METRICS_TIMEOUT", 10000),
             ("OTEL_METRIC_EXPORT_INTERVAL", 10000),
             ("OTEL_METRIC_EXPORT_TIMEOUT", 7500),
@@ -2038,6 +2093,10 @@ def test_telemetry_exporter_metrics_configurations(
                 f"Expected {expected_env} to be {expected_value}, configuration: {config}"
             )
 
+    @missing_feature(
+        context.library == "dotnet",
+        reason="OTel metrics telemetry metrics (otel.metrics_export_attempts) not yet fully flushed in time",
+    )
     @pytest.mark.parametrize(
         "library_env",
         [
@@ -2081,6 +2140,10 @@ def test_telemetry_metrics_http_protobuf(
             assert "protocol:http" in metric.get("tags")
             assert "encoding:protobuf" in metric.get("tags")
 
+    @missing_feature(
+        context.library == "dotnet",
+        reason="OTel metrics telemetry metrics (otel.metrics_export_attempts) not yet fully flushed in time",
+    )
     @missing_feature(context.library == "nodejs", reason="Does not support grpc", force_skip=True)
     @pytest.mark.parametrize(
         "library_env",