From 51f7e280786171c850145ba92c1af95c7073111e Mon Sep 17 00:00:00 2001 From: Jack Berg Date: Mon, 3 Mar 2025 13:19:23 -0600 Subject: [PATCH] Mark resource detectors experimental --- examples/kitchen-sink.yaml | 3 ++- schema/resource.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 9b458ece..c3c67870 100644 --- a/examples/kitchen-sink.yaml +++ b/examples/kitchen-sink.yaml @@ -679,7 +679,8 @@ resource: # If omitted or null, no resource attributes are added. attributes_list: "service.namespace=my-namespace,service.version=1.0.0" # Configure resource detectors. - detectors: + # This type is in development and subject to breaking changes in minor versions. + detectors/development: # Configure attributes provided by resource detectors. attributes: # Configure list of attribute key patterns to include from resource detectors. diff --git a/schema/resource.json b/schema/resource.json index 141b1c57..f999ffb9 100644 --- a/schema/resource.json +++ b/schema/resource.json @@ -10,8 +10,8 @@ "$ref": "#/$defs/AttributeNameValue" } }, - "detectors": { - "$ref": "#/$defs/Detectors" + "detectors/development": { + "$ref": "#/$defs/ExperimentalDetectors" }, "schema_url": { "type": ["string", "null"] @@ -61,7 +61,7 @@ "double_array" ] }, - "Detectors": { + "ExperimentalDetectors": { "type": "object", "additionalProperties": false, "properties": { diff --git a/schema/type_descriptions.yaml b/schema/type_descriptions.yaml index 0bf03a8d..f8b4b00f 100644 --- a/schema/type_descriptions.yaml +++ b/schema/type_descriptions.yaml @@ -66,7 +66,10 @@ The value is a list of comma separated key-value pairs matching the format of OTEL_RESOURCE_ATTRIBUTES. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details. If omitted or null, no resource attributes are added. - detectors: Configure resource detectors. + detectors/development: > + Configure resource detectors. + + This type is in development and subject to breaking changes in minor versions. schema_url: > Configure resource schema URL. @@ -78,7 +81,7 @@ property_descriptions: attributes: Configure attributes provided by resource detectors. path_patterns: - - .resource.detectors + - .resource.detectors/development - type: DetectorAttributes property_descriptions: @@ -97,7 +100,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 attributes are included. path_patterns: - - .resource.detectors.attributes + - .resource.detectors/development.attributes - type: AttributeLimits property_descriptions: