organise general instrumentation config by semconv

open-telemetry · May 21, 2024 · 13e4b16 · 13e4b16
1 parent 188d2c6
commit 13e4b16
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 35 deletions.
diff --git a/examples/kitchen-sink.yaml b/examples/kitchen-sink.yaml
@@ -428,28 +428,33 @@ resource:
   schema_url: https://opentelemetry.io/schemas/1.16.0
 # Configure instrumentation
 instrumentation:
-  # Configure options common to multiple languages
-  common:
-    peer-service-mapping:
-      - peer: foo
-        service: bar
-      - peer: bar
-        service: bat
-    http-capture-headers:
+  # General SemConv options that may apply to multiple languages
+  general:
+    peer:
+      service-mapping:
+        - peer: foo
+          service: bar
+        - peer: bar
+          service: bat
+    http:
       client:
         request:
-          - X-Foo
+          capture-headers:
+            - X-Foo
         response:
-          - X-Foo-*
+          capture-headers:
+            - X-Foo
       server:
         request:
-          - X-Bar-*
+          capture-headers:
+            - X-Bar
         response:
-          - X-Bar
-    db-statement-sanitizer:
-      enabled: true
-      foo: bar
-  # Configure language-specific module options
+          capture-headers:
+            - X-Bar
+    db:
+      statement-sanitizer:
+        enabled: true
+  # Language-specific module options
   java:
     logback-appender:
       experimental:

diff --git a/schema/instrumentation.json b/schema/instrumentation.json
@@ -3,34 +3,47 @@
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "title": "Instrumentation",
     "type": "object",
-    "additionalProperties": true,
+    "additionalProperties": false,
     "properties": {
-        "common": {
+        "general": {
             "type": "object",
+            "additionalProperties": false,
             "properties": {
-                "peer-service-mapping": {
-                    "type": "array",
-                    "items": {
-                        "$ref": "#/$defs/PeerServiceMapping"
+                "peer": {
+                    "type": "object",
+                    "properties": {
+                        "service-mapping": {
+                            "type": "array",
+                            "items": {
+                                "$ref": "#/$defs/PeerServiceMapping"
+                            }
+                        }
                     }
                 },
-                "http-capture-headers": {
+                "http": {
                     "type": "object",
+                    "additionalProperties": false,
                     "properties": {
                         "client": {
-                            "$ref": "#/$defs/RequestResponseHeaders"
+                            "$ref": "#/$defs/RequestResponseCaptureHeaders"
                         },
                         "server": {
-                            "$ref": "#/$defs/RequestResponseHeaders"
+                            "$ref": "#/$defs/RequestResponseCaptureHeaders"
                         }
-                    },
-                    "additionalProperties": false
+                    }
                 },
-                "db-statement-sanitizer": {
+                "db": {
                     "type": "object",
+                    "additionalProperties": false,
                     "properties": {
-                        "enabled": {
-                            "type": "boolean"
+                        "statement-sanitizer": {
+                            "type": "object",
+                            "additionalProperties": false,
+                            "properties": {
+                                "enabled": {
+                                    "type": "boolean"
+                                }
+                            }
                         }
                     }
                 }
@@ -72,17 +85,26 @@
                 "type": "string"
             }
         },
-        "RequestResponseHeaders": {
+        "CaptureHeaders": {
             "type": "object",
+            "additionalProperties": false,
             "properties": {
-                "request": {
+                "capture-headers": {
                     "$ref": "#/$defs/ArrayOfHeaders"
+                }
+            }
+        },
+        "RequestResponseCaptureHeaders": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "request": {
+                    "$ref": "#/$defs/CaptureHeaders"
                 },
                 "response": {
-                    "$ref": "#/$defs/ArrayOfHeaders"
+                    "$ref": "#/$defs/CaptureHeaders"
                 }
-            },
-            "additionalProperties": false
+            }
         },
         "JavaModules": {},
         "JsModules": {},