Otel Pipeline Improvements (#613)

* Embed the default span filters Signed-off-by: Pete Wall <pete.wall@grafana.com> * Make the resourcedetection component more configurable Signed-off-by: Pete Wall <pete.wall@grafana.com> * Update examples Signed-off-by: Pete Wall <pete.wall@grafana.com> * Fix yamllint config Signed-off-by: Pete Wall <pete.wall@grafana.com> --------- Signed-off-by: Pete Wall <pete.wall@grafana.com>
grafana · Sep 30, 2024 · a1ea119 · a1ea119
1 parent cc1ee57
commit a1ea119
Show file tree

Hide file tree

Showing 74 changed files with 316 additions and 414 deletions.
diff --git a/.yamllint.yml b/.yamllint.yml
@@ -5,10 +5,10 @@ yaml-files:
   - ".yamllint"
 
 ignore:
+  - .git
   - data-alloy
   - node_modules
-  - .git
-  - examples/**/output.yaml
+  - charts/k8s-monitoring-v1/docs/examples/**/output.yaml
   - charts/**/templates
 
 extends: default

diff --git a/charts/k8s-monitoring-v1/README.md b/charts/k8s-monitoring-v1/README.md
@@ -835,6 +835,8 @@ The Prometheus and Loki services may be hosted on the same cluster, or remotely
 | receivers.processors.k8sattributes.annotations | list | `[]` | Kubernetes annotations to extract and add to the attributes of the received telemetry data. |
 | receivers.processors.k8sattributes.labels | list | `[]` | Kubernetes labels to extract and add to the attributes of the received telemetry data. |
 | receivers.processors.k8sattributes.metadata | list | `["k8s.namespace.name","k8s.pod.name","k8s.deployment.name","k8s.statefulset.name","k8s.daemonset.name","k8s.cronjob.name","k8s.job.name","k8s.node.name","k8s.pod.uid","k8s.pod.start_time"]` | Kubernetes metadata to extract and add to the attributes of the received telemetry data. |
+| receivers.processors.resourcedetection.env | object | `{"enabled":true}` | Read resource information from the OTEL_RESOURCE_ATTRIBUTES environment variable. |
+| receivers.processors.resourcedetection.system | object | `{"enabled":true,"hostnameSources":["os"],"resourceAttributes":{}}` | Query the host machine to retrieve various resource attributes. |
 
 ### OTEL Receivers (gRPC)
 
@@ -908,7 +910,7 @@ The Prometheus and Loki services may be hosted on the same cluster, or remotely
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | traces.enabled | bool | `false` | Receive and forward traces. |
-| traces.receiver.filters | object | `{"span":[],"spanevent":[]}` | Apply a filter to traces received via the OTLP or OTLP HTTP receivers. ([docs](https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.filter/)) |
+| traces.receiver.filters | object | `{"span":["attributes[\"http.route\"] == \"/live\"","attributes[\"http.route\"] == \"/healthy\"","attributes[\"http.route\"] == \"/ready\""],"spanevent":[]}` | Apply a filter to traces received via the OTLP or OTLP HTTP receivers. ([docs](https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.filter/)) |
 | traces.receiver.transforms | object | `{"resource":[],"span":[],"spanevent":[]}` | Apply a transformation to traces received via the OTLP or OTLP HTTP receivers. ([docs](https://grafana.com/docs/alloy/latest/reference/components/otelcol.processor.transform/)) |
 
 ### Other Values

diff --git a/charts/k8s-monitoring-v1/docs/examples/alloy-autoscaling-and-storage/metrics.alloy b/charts/k8s-monitoring-v1/docs/examples/alloy-autoscaling-and-storage/metrics.alloy
@@ -36,7 +36,6 @@ otelcol.receiver.otlp "receiver" {
 
 // Processors
 otelcol.processor.transform "add_metric_datapoint_attributes" {
-  // Grafana Cloud Kubernetes monitoring expects Loki labels `cluster`, `pod`, and `namespace`
   error_mode = "ignore"
   metric_statements {
     context = "datapoint"
@@ -49,14 +48,13 @@ otelcol.processor.transform "add_metric_datapoint_attributes" {
     metrics = [otelcol.processor.k8sattributes.default.input]
   }
 }
-
 otelcol.processor.resourcedetection "default" {
-  detectors = ["env", "system"]
-
   system {
     hostname_sources = ["os"]
   }
 
+  detectors = ["env","system"]
+
   output {
     metrics = [otelcol.processor.transform.add_metric_datapoint_attributes.input]
     logs    = [otelcol.processor.k8sattributes.default.input]

diff --git a/charts/k8s-monitoring-v1/docs/examples/alloy-autoscaling-and-storage/output.yaml b/charts/k8s-monitoring-v1/docs/examples/alloy-autoscaling-and-storage/output.yaml
@@ -168,7 +168,6 @@ data:
 
     // Processors
     otelcol.processor.transform "add_metric_datapoint_attributes" {
-      // Grafana Cloud Kubernetes monitoring expects Loki labels `cluster`, `pod`, and `namespace`
       error_mode = "ignore"
       metric_statements {
         context = "datapoint"
@@ -181,14 +180,13 @@ data:
         metrics = [otelcol.processor.k8sattributes.default.input]
       }
     }
-
     otelcol.processor.resourcedetection "default" {
-      detectors = ["env", "system"]
-
       system {
         hostname_sources = ["os"]
       }
 
+      detectors = ["env","system"]
+
       output {
         metrics = [otelcol.processor.transform.add_metric_datapoint_attributes.input]
         logs    = [otelcol.processor.k8sattributes.default.input]
@@ -68571,7 +68569,6 @@ data:
 
     // Processors
     otelcol.processor.transform "add_metric_datapoint_attributes" {
-      // Grafana Cloud Kubernetes monitoring expects Loki labels `cluster`, `pod`, and `namespace`
       error_mode = "ignore"
       metric_statements {
         context = "datapoint"
@@ -68584,14 +68581,13 @@ data:
         metrics = [otelcol.processor.k8sattributes.default.input]
       }
     }
-
     otelcol.processor.resourcedetection "default" {
-      detectors = ["env", "system"]
-
       system {
         hostname_sources = ["os"]
       }
 
+      detectors = ["env","system"]
+
       output {
         metrics = [otelcol.processor.transform.add_metric_datapoint_attributes.input]
         logs    = [otelcol.processor.k8sattributes.default.input]

diff --git a/charts/k8s-monitoring-v1/docs/examples/application-observability/metrics.alloy b/charts/k8s-monitoring-v1/docs/examples/application-observability/metrics.alloy
@@ -37,7 +37,6 @@ otelcol.receiver.otlp "receiver" {
 
 // Processors
 otelcol.processor.transform "add_metric_datapoint_attributes" {
-  // Grafana Cloud Kubernetes monitoring expects Loki labels `cluster`, `pod`, and `namespace`
   error_mode = "ignore"
   metric_statements {
     context = "datapoint"
@@ -50,14 +49,13 @@ otelcol.processor.transform "add_metric_datapoint_attributes" {
     metrics = [otelcol.processor.k8sattributes.default.input]
   }
 }
-
 otelcol.processor.resourcedetection "default" {
-  detectors = ["env", "system"]
-
   system {
     hostname_sources = ["os"]
   }
 
+  detectors = ["env","system"]
+
   output {
     metrics = [otelcol.processor.transform.add_metric_datapoint_attributes.input]
     logs    = [otelcol.processor.k8sattributes.default.input]
@@ -135,6 +133,13 @@ otelcol.processor.transform "default" {
 
 otelcol.processor.filter "default" {
   error_mode = "ignore"
+  traces {
+    span = [
+      "attributes[\"http.route\"] == \"/live\"",
+      "attributes[\"http.route\"] == \"/healthy\"",
+      "attributes[\"http.route\"] == \"/ready\"",
+    ]
+  }
 
   output {
     metrics = [otelcol.processor.batch.batch_processor.input]

diff --git a/charts/k8s-monitoring-v1/docs/examples/application-observability/output.yaml b/charts/k8s-monitoring-v1/docs/examples/application-observability/output.yaml
@@ -211,7 +211,6 @@ data:
 
     // Processors
     otelcol.processor.transform "add_metric_datapoint_attributes" {
-      // Grafana Cloud Kubernetes monitoring expects Loki labels `cluster`, `pod`, and `namespace`
       error_mode = "ignore"
       metric_statements {
         context = "datapoint"
@@ -224,14 +223,13 @@ data:
         metrics = [otelcol.processor.k8sattributes.default.input]
       }
     }
-
     otelcol.processor.resourcedetection "default" {
-      detectors = ["env", "system"]
-
       system {
         hostname_sources = ["os"]
       }
 
+      detectors = ["env","system"]
+
       output {
         metrics = [otelcol.processor.transform.add_metric_datapoint_attributes.input]
         logs    = [otelcol.processor.k8sattributes.default.input]
@@ -309,6 +307,13 @@ data:
 
     otelcol.processor.filter "default" {
       error_mode = "ignore"
+      traces {
+        span = [
+          "attributes[\"http.route\"] == \"/live\"",
+          "attributes[\"http.route\"] == \"/healthy\"",
+          "attributes[\"http.route\"] == \"/ready\"",
+        ]
+      }
 
       output {
         metrics = [otelcol.processor.batch.batch_processor.input]
@@ -69773,7 +69778,6 @@ data:
 
     // Processors
     otelcol.processor.transform "add_metric_datapoint_attributes" {
-      // Grafana Cloud Kubernetes monitoring expects Loki labels `cluster`, `pod`, and `namespace`
       error_mode = "ignore"
       metric_statements {
         context = "datapoint"
@@ -69786,14 +69790,13 @@ data:
         metrics = [otelcol.processor.k8sattributes.default.input]
       }
     }
-
     otelcol.processor.resourcedetection "default" {
-      detectors = ["env", "system"]
-
       system {
         hostname_sources = ["os"]
       }
 
+      detectors = ["env","system"]
+
       output {
         metrics = [otelcol.processor.transform.add_metric_datapoint_attributes.input]
         logs    = [otelcol.processor.k8sattributes.default.input]
@@ -69871,6 +69874,13 @@ data:
 
     otelcol.processor.filter "default" {
       error_mode = "ignore"
+      traces {
+        span = [
+          "attributes[\"http.route\"] == \"/live\"",
+          "attributes[\"http.route\"] == \"/healthy\"",
+          "attributes[\"http.route\"] == \"/ready\"",
+        ]
+      }
 
       output {
         metrics = [otelcol.processor.batch.batch_processor.input]

diff --git a/charts/k8s-monitoring-v1/docs/examples/azure-aks/metrics.alloy b/charts/k8s-monitoring-v1/docs/examples/azure-aks/metrics.alloy
@@ -36,7 +36,6 @@ otelcol.receiver.otlp "receiver" {
 
 // Processors
 otelcol.processor.transform "add_metric_datapoint_attributes" {
-  // Grafana Cloud Kubernetes monitoring expects Loki labels `cluster`, `pod`, and `namespace`
   error_mode = "ignore"
   metric_statements {
     context = "datapoint"
@@ -49,14 +48,13 @@ otelcol.processor.transform "add_metric_datapoint_attributes" {
     metrics = [otelcol.processor.k8sattributes.default.input]
   }
 }
-
 otelcol.processor.resourcedetection "default" {
-  detectors = ["env", "system"]
-
   system {
     hostname_sources = ["os"]
   }
 
+  detectors = ["env","system"]
+
   output {
     metrics = [otelcol.processor.transform.add_metric_datapoint_attributes.input]
     logs    = [otelcol.processor.k8sattributes.default.input]

diff --git a/charts/k8s-monitoring-v1/docs/examples/azure-aks/output.yaml b/charts/k8s-monitoring-v1/docs/examples/azure-aks/output.yaml
@@ -168,7 +168,6 @@ data:
 
     // Processors
     otelcol.processor.transform "add_metric_datapoint_attributes" {
-      // Grafana Cloud Kubernetes monitoring expects Loki labels `cluster`, `pod`, and `namespace`
       error_mode = "ignore"
       metric_statements {
         context = "datapoint"
@@ -181,14 +180,13 @@ data:
         metrics = [otelcol.processor.k8sattributes.default.input]
       }
     }
-
     otelcol.processor.resourcedetection "default" {
-      detectors = ["env", "system"]
-
       system {
         hostname_sources = ["os"]
       }
 
+      detectors = ["env","system"]
+
       output {
         metrics = [otelcol.processor.transform.add_metric_datapoint_attributes.input]
         logs    = [otelcol.processor.k8sattributes.default.input]
@@ -68515,7 +68513,6 @@ data:
 
     // Processors
     otelcol.processor.transform "add_metric_datapoint_attributes" {
-      // Grafana Cloud Kubernetes monitoring expects Loki labels `cluster`, `pod`, and `namespace`
       error_mode = "ignore"
       metric_statements {
         context = "datapoint"
@@ -68528,14 +68525,13 @@ data:
         metrics = [otelcol.processor.k8sattributes.default.input]
       }
     }
-
     otelcol.processor.resourcedetection "default" {
-      detectors = ["env", "system"]
-
       system {
         hostname_sources = ["os"]
       }
 
+      detectors = ["env","system"]
+
       output {
         metrics = [otelcol.processor.transform.add_metric_datapoint_attributes.input]
         logs    = [otelcol.processor.k8sattributes.default.input]

diff --git a/charts/k8s-monitoring-v1/docs/examples/bearer-token-auth/metrics.alloy b/charts/k8s-monitoring-v1/docs/examples/bearer-token-auth/metrics.alloy
@@ -36,7 +36,6 @@ otelcol.receiver.otlp "receiver" {
 
 // Processors
 otelcol.processor.transform "add_metric_datapoint_attributes" {
-  // Grafana Cloud Kubernetes monitoring expects Loki labels `cluster`, `pod`, and `namespace`
   error_mode = "ignore"
   metric_statements {
     context = "datapoint"
@@ -49,14 +48,13 @@ otelcol.processor.transform "add_metric_datapoint_attributes" {
     metrics = [otelcol.processor.k8sattributes.default.input]
   }
 }
-
 otelcol.processor.resourcedetection "default" {
-  detectors = ["env", "system"]
-
   system {
     hostname_sources = ["os"]
   }
 
+  detectors = ["env","system"]
+
   output {
     metrics = [otelcol.processor.transform.add_metric_datapoint_attributes.input]
     logs    = [otelcol.processor.k8sattributes.default.input]

diff --git a/charts/k8s-monitoring-v1/docs/examples/bearer-token-auth/output.yaml b/charts/k8s-monitoring-v1/docs/examples/bearer-token-auth/output.yaml
@@ -167,7 +167,6 @@ data:
 
     // Processors
     otelcol.processor.transform "add_metric_datapoint_attributes" {
-      // Grafana Cloud Kubernetes monitoring expects Loki labels `cluster`, `pod`, and `namespace`
       error_mode = "ignore"
       metric_statements {
         context = "datapoint"
@@ -180,14 +179,13 @@ data:
         metrics = [otelcol.processor.k8sattributes.default.input]
       }
     }
-
     otelcol.processor.resourcedetection "default" {
-      detectors = ["env", "system"]
-
       system {
         hostname_sources = ["os"]
       }
 
+      detectors = ["env","system"]
+
       output {
         metrics = [otelcol.processor.transform.add_metric_datapoint_attributes.input]
         logs    = [otelcol.processor.k8sattributes.default.input]
@@ -68503,7 +68501,6 @@ data:
 
     // Processors
     otelcol.processor.transform "add_metric_datapoint_attributes" {
-      // Grafana Cloud Kubernetes monitoring expects Loki labels `cluster`, `pod`, and `namespace`
       error_mode = "ignore"
       metric_statements {
         context = "datapoint"
@@ -68516,14 +68513,13 @@ data:
         metrics = [otelcol.processor.k8sattributes.default.input]
       }
     }
-
     otelcol.processor.resourcedetection "default" {
-      detectors = ["env", "system"]
-
       system {
         hostname_sources = ["os"]
       }
 
+      detectors = ["env","system"]
+
       output {
         metrics = [otelcol.processor.transform.add_metric_datapoint_attributes.input]
         logs    = [otelcol.processor.k8sattributes.default.input]

diff --git a/charts/k8s-monitoring-v1/docs/examples/bearer-token-auth/values.yaml b/charts/k8s-monitoring-v1/docs/examples/bearer-token-auth/values.yaml
@@ -13,4 +13,4 @@ externalServices:
     host: https://loki.example.com
     basicAuth:
       username: 12345
-      password: "It's a secret to everyone"
+      password: "It's a secret to everyone"