refactor: remove service prefix from telemetry properties

Since we already dropped exact parity with OTel Collector settings with `ingress.grpc.tls.*`, we think it's preferable to remove the `service.` prefix from telemetry properties in the OTel Collector jobs. Signed-off-by: Carson Long <[email protected]>
cloudfoundry · Aug 18, 2023 · 0c0ed48 · 0c0ed48
1 parent 8285ad1
commit 0c0ed48
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 14 deletions.
diff --git a/jobs/otel-collector-windows/spec b/jobs/otel-collector-windows/spec
@@ -25,11 +25,11 @@ properties:
     description: "TLS server certificate for gRPC ingress"
   ingress.grpc.tls.key:
     description: "TLS server key for gRPC ingress"
-  service.telemetry.metrics.level:
-    description: "Level of metrics otel-collector exposes about itself"
+  telemetry.metrics.level:
+    description: "Level of metrics the collector exposes about itself"
     default: "basic"
-  service.telemetry.metrics.port:
-    description: "Port to serve otel-collector's internal metrics"
+  telemetry.metrics.port:
+    description: "Port to serve the collector's internal metrics"
     default: 14830
   metric_exporters:
     description: "Exporter configuration for aggregate metric egress"

diff --git a/jobs/otel-collector-windows/templates/config.yml.erb b/jobs/otel-collector-windows/templates/config.yml.erb
@@ -27,8 +27,8 @@ config = {
   "service"=>{
     "telemetry"=>{
       "metrics"=>{
-        "level"=>p('service.telemetry.metrics.level'),
-        "address"=>"127.0.0.1:#{p('service.telemetry.metrics.port')}"
+        "level"=>p('telemetry.metrics.level'),
+        "address"=>"127.0.0.1:#{p('telemetry.metrics.port')}"
       }
     },
     "pipelines"=>{"metrics"=>{"receivers"=>["otlp"], "exporters"=>metric_exporters.keys}}

diff --git a/jobs/otel-collector-windows/templates/prom_scraper_config.yml.erb b/jobs/otel-collector-windows/templates/prom_scraper_config.yml.erb
@@ -1,6 +1,6 @@
 <% if p('enabled') %>
 ---
-port: <%= p("service.telemetry.metrics.port") %>
+port: <%= p("telemetry.metrics.port") %>
 source_id: "otel-collector"
 instance_id: <%= spec.id || spec.index.to_s %>
 scheme: http

diff --git a/jobs/otel-collector/spec b/jobs/otel-collector/spec
@@ -26,11 +26,11 @@ properties:
     description: "TLS server certificate for gRPC ingress"
   ingress.grpc.tls.key:
     description: "TLS server key for gRPC ingress"
-  service.telemetry.metrics.level:
-    description: "Level of metrics otel-collector exposes about itself"
+  telemetry.metrics.level:
+    description: "Level of metrics the collector exposes about itself"
     default: "basic"
-  service.telemetry.metrics.port:
-    description: "Port to serve otel-collector's internal metrics"
+  telemetry.metrics.port:
+    description: "Port to serve the collector's internal metrics"
     default: 14830
   metric_exporters:
     description: "Exporter configuration for aggregate metric egress"

diff --git a/jobs/otel-collector/templates/config.yml.erb b/jobs/otel-collector/templates/config.yml.erb
@@ -27,8 +27,8 @@ config = {
   "service"=>{
     "telemetry"=>{
       "metrics"=>{
-        "level"=>p('service.telemetry.metrics.level'),
-        "address"=>"127.0.0.1:#{p('service.telemetry.metrics.port')}"
+        "level"=>p('telemetry.metrics.level'),
+        "address"=>"127.0.0.1:#{p('telemetry.metrics.port')}"
       }
     },
     "pipelines"=>{"metrics"=>{"receivers"=>["otlp"], "exporters"=>metric_exporters.keys}}

diff --git a/jobs/otel-collector/templates/prom_scraper_config.yml.erb b/jobs/otel-collector/templates/prom_scraper_config.yml.erb
@@ -1,6 +1,6 @@
 <% if p('enabled') %>
 ---
-port: <%= p("service.telemetry.metrics.port") %>
+port: <%= p("telemetry.metrics.port") %>
 source_id: "otel-collector"
 instance_id: <%= spec.id || spec.index.to_s %>
 scheme: http