refactor(eventlog-live-otelcol): use YAML anchors to define defaults

Author: Wen Kokke

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "yaml.schemas": {
+    "./eventlog-live-otelcol/data/config.schema.json": "./eventlog-live-otelcol/data/default.yaml"
+  }
+}

eventlog-live-otelcol/data/config.schema.json

@@ -7,9 +7,11 @@
     "processors": {
       "type": "object",
       "properties": {
+        "defaults": { "#ref": "#/definitions/processor_defaults" },
         "metrics": {
           "type": "object",
           "properties": {
+            "defaults": { "#ref": "#/definitions/metric_defaults" },
             "blocks_size": { "$ref": "#/definitions/metric" },
             "capability_usage": { "$ref": "#/definitions/metric" },
             "heap_allocated": { "$ref": "#/definitions/metric" },
@@ -19,14 +21,17 @@
             "mem_current": { "$ref": "#/definitions/metric" },
             "mem_needed": { "$ref": "#/definitions/metric" },
             "mem_returned": { "$ref": "#/definitions/metric" }
-          }
+          },
+          "additionalProperties": false
         },
         "traces": {
           "type": "object",
           "properties": {
-            "capability_usage": { "$ref": "#/definitions/span" },
-            "thread_state": { "$ref": "#/definitions/span" }
-          }
+            "defaults": { "#ref": "#/definitions/trace_defaults" },
+            "capability_usage": { "$ref": "#/definitions/trace" },
+            "thread_state": { "$ref": "#/definitions/trace" }
+          },
+          "additionalProperties": false
         }
       }
     }
@@ -60,27 +65,46 @@
       "type": "string",
       "pattern": "^([0-9]+)(x)$"
     },
-    "processor": {
-      "type": "object",
+    "processor_defaults": {
+      "description": "An optional 'defaults' block for defining YAML anchors.",
       "properties": {
-        "description": { "type": "string" },
-        "enabled": { "type": "boolean" },
         "export": { "$ref": "#/definitions/export_strategy" },
-        "name": { "type": "string" }
-      }
+        "aggregate": { "$ref": "#/definitions/aggregation_strategy" }
+      },
+      "additionalProperties": false
     },
     "metric": {
-      "allOf": [
-        { "$ref": "#/definitions/processor" },
-        {
-          "properties": {
-            "aggregate": { "$ref": "#/definitions/aggregation_strategy" }
-          }
-        }
-      ]
+      "properties": {
+        "name": { "type": "string" },
+        "description": { "type": "string" },
+        "export": { "$ref": "#/definitions/export_strategy" },
+        "aggregate": { "$ref": "#/definitions/aggregation_strategy" }
+      },
+      "additionalProperties": false
     },
-    "span": {
-      "allOf": [{ "$ref": "#/definitions/processor" }]
+    "metric_defaults": {
+      "description": "An optional 'defaults' block for defining YAML anchors.",
+      "properties": {
+        "export": { "$ref": "#/definitions/export_strategy" },
+        "aggregate": { "$ref": "#/definitions/aggregation_strategy" }
+      },
+      "additionalProperties": false
+    },
+    "trace": {
+      "properties": {
+        "name": { "type": "string" },
+        "description": { "type": "string" },
+        "export": { "$ref": "#/definitions/export_strategy" }
+      },
+      "additionalProperties": false
+    },
+    "trace_defaultss": {
+      "description": "An optional 'defaults' block for defining YAML anchors.",
+      "properties": {
+        "export": { "$ref": "#/definitions/export_strategy" },
+        "aggregate": { "$ref": "#/definitions/aggregation_strategy" }
+      },
+      "additionalProperties": false
     }
   }
 }

eventlog-live-otelcol/data/default.yaml

@@ -49,51 +49,58 @@
 #
 processors:
   metrics:
+    defaults:
+      aggregate:
+        # one of [boolean, `${number}x`]
+        &default_aggregate 1x
+      export:
+        # one of [boolean, `${number}x`]
+        &default_export 60x
     blocks_size:
       name: ghc_eventlog_BlocksSize
       description: The current heap size, calculated by the allocated number of blocks.
-      aggregate: 1x # one of [boolean, `${number}x`]
-      export: 60x # one of [boolean, `${number}x`]
+      aggregate: *default_aggregate
+      export: *default_export
     capability_usage:
       name: ghc_eventlog_CapabilityUsageDuration
       description: The duration of each capability usage span.
-      aggregate: 1x # one of [boolean, `${number}x`]
-      export: 60x # one of [boolean, `${number}x`]
+      aggregate: *default_aggregate
+      export: *default_export
     heap_allocated:
       name: ghc_eventlog_HeapAllocated
       description: The size of a newly allocated chunk of heap.
-      aggregate: 1x # one of [boolean, `${number}x`]
-      export: 60x # one of [boolean, `${number}x`]
+      aggregate: *default_aggregate
+      export: *default_export
     heap_live:
       name: ghc_eventlog_HeapLive
       description: The current heap size, calculated by the allocated number of megablocks.
-      aggregate: 1x # one of [boolean, `${number}x`]
-      export: 60x # one of [boolean, `${number}x`]
+      aggregate: *default_aggregate
+      export: *default_export
     heap_prof_sample:
       name: ghc_eventlog_HeapProfSample
       description: A heap profile sample.
-      aggregate: 1x # one of [boolean, `${number}x`]
-      export: 60x # one of [boolean, `${number}x`]
+      aggregate: *default_aggregate
+      export: *default_export
     heap_size:
       name: ghc_eventlog_HeapSize
       description: The current heap size, calculated by the allocated number of megablocks.
-      aggregate: 1x # one of [boolean, `${number}x`]
-      export: 60x # one of [boolean, `${number}x`]
+      aggregate: *default_aggregate
+      export: *default_export
     mem_current:
       name: ghc_eventlog_MemCurrent
       description: The number of megablocks currently allocated.
-      aggregate: 1x # one of [boolean, `${number}x`]
-      export: 60x # one of [boolean, `${number}x`]
+      aggregate: *default_aggregate
+      export: *default_export
     mem_needed:
       name: ghc_eventlog_MemNeeded
       description: The number of megablocks currently needed.
-      aggregate: 1x # one of [boolean, `${number}x`]
-      export: 60x # one of [boolean, `${number}x`]
+      aggregate: *default_aggregate
+      export: *default_export
     mem_returned:
       name: ghc_eventlog_MemReturned
       description: The number of megablocks currently being returned to the OS.
-      aggregate: 1x # one of [boolean, `${number}x`]
-      export: 60x # one of [boolean, `${number}x`]
+      aggregate: *default_aggregate
+      export: *default_export
   traces:
     capability_usage:
       name: ghc_eventlog_CapabilityUsage