From ebb5dba5735425e8785ac55450cad6f7aa1b9f2d Mon Sep 17 00:00:00 2001 From: jack-berg <34418638+jack-berg@users.noreply.github.com> Date: Thu, 6 Mar 2025 16:52:06 -0600 Subject: [PATCH] Mark prometheus exporter as experimental (#180) --- examples/kitchen-sink.yaml | 3 ++- schema/meter_provider.json | 6 +++--- schema/type_descriptions.yaml | 9 ++++++--- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/examples/kitchen-sink.yaml b/examples/kitchen-sink.yaml index 8af7ca6..708fefb 100644 --- a/examples/kitchen-sink.yaml +++ b/examples/kitchen-sink.yaml @@ -174,7 +174,8 @@ meter_provider: # Configure exporter. exporter: # Configure exporter to be prometheus. - prometheus: + # This type is in development and subject to breaking changes in minor versions. + prometheus/development: # Configure host. # If omitted or null, localhost is used. host: localhost diff --git a/schema/meter_provider.json b/schema/meter_provider.json index 0bee0ed..512956f 100644 --- a/schema/meter_provider.json +++ b/schema/meter_provider.json @@ -151,8 +151,8 @@ "minProperties": 1, "maxProperties": 1, "properties": { - "prometheus": { - "$ref": "#/$defs/PrometheusMetricExporter" + "prometheus/development": { + "$ref": "#/$defs/ExperimentalPrometheusMetricExporter" } }, "patternProperties": { @@ -181,7 +181,7 @@ "type": ["object", "null"], "additionalProperties": false }, - "PrometheusMetricExporter": { + "ExperimentalPrometheusMetricExporter": { "type": ["object", "null"], "additionalProperties": false, "properties": { diff --git a/schema/type_descriptions.yaml b/schema/type_descriptions.yaml index 92ed349..e9e96df 100644 --- a/schema/type_descriptions.yaml +++ b/schema/type_descriptions.yaml @@ -466,7 +466,10 @@ - type: MetricExporter property_descriptions: - prometheus: Configure exporter to be prometheus. + prometheus/development: > + Configure exporter to be prometheus. + + This type is in development and subject to breaking changes in minor versions. otlp_http: Configure exporter to be OTLP with HTTP transport. otlp_grpc: Configure exporter to be OTLP with gRPC transport. otlp_file/development: > @@ -501,7 +504,7 @@ If omitted or null, false is used. with_resource_constant_labels: Configure Prometheus Exporter to add resource attributes as metrics attributes. path_patterns: - - .meter_provider.readers[].pull.exporter.prometheus + - .meter_provider.readers[].pull.exporter.prometheus/development - type: PrometheusIncludeExclude property_descriptions: included: > @@ -519,7 +522,7 @@ * If the value of the attribute key matches the wildcard pattern, where '?' matches any single character and '*' matches any number of characters including none. If omitted, .included resource attributes are included. path_patterns: - - .meter_provider.readers[].pull.exporter.prometheus.with_resource_constant_labels + - .meter_provider.readers[].pull.exporter.prometheus/development.with_resource_constant_labels - type: View property_descriptions: