feat: add support for forwarding cluster events as json logs (#327)

* feat: add support for forwarding cluster events as json logs * docs: expand docs and examples to add the new log format field for cluster events
grafana · Jan 8, 2024 · 01f28c9 · 01f28c9
1 parent 5866e58
commit 01f28c9
Show file tree

Hide file tree

Showing 36 changed files with 60 additions and 0 deletions.
diff --git a/charts/k8s-monitoring/README.md b/charts/k8s-monitoring/README.md
@@ -162,6 +162,7 @@ The Prometheus and Loki services may be hosted on the same cluster, or remotely
 | global.image.registry | string | `""` | Global image registry to use if it needs to be overriden for some specific use cases (e.g local registries, custom images, ...) |
 | kube-state-metrics.enabled | bool | `true` | Should this helm chart deploy Kube State Metrics to the cluster. Set this to false if your cluster already has Kube State Metrics, or if you do not want to scrape metrics from Kube State Metrics. |
 | logs.cluster_events.enabled | bool | `true` | Scrape Kubernetes cluster events |
+| logs.cluster_events.logFormat | string | `"logfmt"` | Log format used to forward cluster events. Allowed values: `logfmt` (default), `json`. |
 | logs.cluster_events.namespaces | list | `[]` | List of namespaces to watch for events (`[]` means all namespaces) |
 | logs.enabled | bool | `true` | Capture and forward logs |
 | logs.extraConfig | string | `""` | Extra configuration that will be added to Grafana Agent Logs configuration file. This cannot be used to modify the generated configuration values, only append new components. See [Adding custom Flow configuration](#adding-custom-flow-configuration) for an example. |

diff --git a/charts/k8s-monitoring/templates/agent_config/_cluster_events.river.txt b/charts/k8s-monitoring/templates/agent_config/_cluster_events.river.txt
@@ -3,6 +3,7 @@
 // Cluster Events
 loki.source.kubernetes_events "cluster_events" {
   job_name   = "integrations/kubernetes/eventhandler"
+  log_format = "{{ .logFormat }}"
 {{- if .namespaces }}
   namespaces = {{ .namespaces | toJson }}
 {{- end }}

diff --git a/charts/k8s-monitoring/values.schema.json b/charts/k8s-monitoring/values.schema.json
@@ -385,6 +385,13 @@
                         "enabled": {
                             "type": "boolean"
                         },
+                        "logFormat": {
+                            "type": "string",
+                            "enum": [
+                                "logfmt",
+                                "json"
+                            ]
+                        },
                         "namespaces": {
                             "type": "array"
                         }

diff --git a/charts/k8s-monitoring/values.yaml b/charts/k8s-monitoring/values.yaml
@@ -726,6 +726,9 @@ logs:
     # -- Scrape Kubernetes cluster events
     enabled: true
 
+    # -- Log format used to forward cluster events. Allowed values: `logfmt` (default), `json`.
+    logFormat: "logfmt"
+
     # -- List of namespaces to watch for events (`[]` means all namespaces)
     namespaces: []
 

diff --git a/examples/control-plane-metrics/events.river b/examples/control-plane-metrics/events.river
diff --git a/examples/control-plane-metrics/output.yaml b/examples/control-plane-metrics/output.yaml
diff --git a/examples/custom-config/events.river b/examples/custom-config/events.river
diff --git a/examples/custom-config/output.yaml b/examples/custom-config/output.yaml
diff --git a/examples/default-values/events.river b/examples/default-values/events.river
diff --git a/examples/default-values/output.yaml b/examples/default-values/output.yaml
diff --git a/examples/eks-fargate/events.river b/examples/eks-fargate/events.river
diff --git a/examples/eks-fargate/output.yaml b/examples/eks-fargate/output.yaml
diff --git a/examples/extra-rules/events.river b/examples/extra-rules/events.river
diff --git a/examples/extra-rules/output.yaml b/examples/extra-rules/output.yaml
diff --git a/examples/gke-autopilot/events.river b/examples/gke-autopilot/events.river
diff --git a/examples/gke-autopilot/output.yaml b/examples/gke-autopilot/output.yaml
diff --git a/examples/ibm-cloud/events.river b/examples/ibm-cloud/events.river
diff --git a/examples/ibm-cloud/output.yaml b/examples/ibm-cloud/output.yaml
diff --git a/examples/logs-only/events.river b/examples/logs-only/events.river
diff --git a/examples/logs-only/output.yaml b/examples/logs-only/output.yaml
diff --git a/examples/openshift-compatible/events.river b/examples/openshift-compatible/events.river
diff --git a/examples/openshift-compatible/output.yaml b/examples/openshift-compatible/output.yaml
diff --git a/examples/otel-metrics-service/events.river b/examples/otel-metrics-service/events.river
diff --git a/examples/otel-metrics-service/output.yaml b/examples/otel-metrics-service/output.yaml
diff --git a/examples/private-image-registry/events.river b/examples/private-image-registry/events.river
diff --git a/examples/private-image-registry/output.yaml b/examples/private-image-registry/output.yaml
diff --git a/examples/proxies/events.river b/examples/proxies/events.river
diff --git a/examples/proxies/output.yaml b/examples/proxies/output.yaml
diff --git a/examples/service-integrations/events.river b/examples/service-integrations/events.river
diff --git a/examples/service-integrations/output.yaml b/examples/service-integrations/output.yaml
diff --git a/examples/specific-namespace/events.river b/examples/specific-namespace/events.river
diff --git a/examples/specific-namespace/output.yaml b/examples/specific-namespace/output.yaml
diff --git a/examples/traces-enabled/events.river b/examples/traces-enabled/events.river
diff --git a/examples/traces-enabled/output.yaml b/examples/traces-enabled/output.yaml