fix: update attribute_keys to include type

This updates the stream's `attribute_keys` configuration to an include/exclude style object that currently only supports `included`. This is in hope to support `excluded` in the future once the specification allows it. Fixes open-telemetry#98 Signed-off-by: Alex Boten <223565+codeboten@users.noreply.github.com>
codeboten · Aug 19, 2024 · 387251b · 387251b
1 parent a6b2d44
commit 387251b
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 * Adding initial instrumentation configuration schema
 * Split MetricExporter into PullMetricExporter and PushMetricExporter and ensure only PushMetricExporters can be associated with PeriodicMetricReader [#110](https://github.com/open-telemetry/opentelemetry-configuration/pull/110)
+* Update `attribute_keys` from array to to Include type
 
 ## [v0.2.0] - 2024-05-08
 

diff --git a/examples/kitchen-sink.yaml b/examples/kitchen-sink.yaml
@@ -249,8 +249,10 @@ meter_provider:
             record_min_max: true
         # Configure attribute keys retained in the resulting stream(s).
         attribute_keys:
-          - key1
-          - key2
+          # Configure list of attribute key patterns attribute keys retained in the resulting stream(s).
+          included:
+            - key1
+            - key2
 
 # Configure text map context propagators.
 #

diff --git a/schema/common.json b/schema/common.json
@@ -31,6 +31,18 @@
                 }
             }
         },
+        "Include": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "included": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            }
+        },
         "Otlp": {
             "type": ["object", "null"],
             "additionalProperties": false,

diff --git a/schema/meter_provider.json b/schema/meter_provider.json
@@ -302,10 +302,7 @@
                             }
                         },
                         "attribute_keys": {
-                            "type": "array",
-                            "items": {
-                                "type": ["string", "null"]
-                            }
+                            "$ref": "common.json#/$defs/Include"
                         }
                     }
                 }