Add Presets for opentelemetry-kube-stack

.github/workflows/kube-stack-test.yaml

@@ -21,11 +21,11 @@ jobs:
           create-kind-cluster: "true"
 
       # We'll need this eventually, but for now leave it commented.
-      # - name: Install cert-manager
-      #   run: |
-      #     kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.1/cert-manager.yaml
-      #     kubectl wait --timeout=5m --for=condition=available deployment cert-manager -n cert-manager
-      #     kubectl wait --timeout=5m --for=condition=available deployment cert-manager-webhook -n cert-manager
+      - name: Install cert-manager
+        run: |
+          kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.6.1/cert-manager.yaml
+          kubectl wait --timeout=5m --for=condition=available deployment cert-manager -n cert-manager
+          kubectl wait --timeout=5m --for=condition=available deployment cert-manager-webhook -n cert-manager
 
       - name: Run chart-testing (install)
         run: ct install --charts charts/opentelemetry-kube-stack

charts/opentelemetry-kube-stack/Chart.lock

@@ -4,6 +4,6 @@ dependencies:
   version: 0.0.0
 - name: opentelemetry-operator
   repository: https://open-telemetry.github.io/opentelemetry-helm-charts
-  version: 0.61.0
-digest: sha256:0eedb0c3014ffbab4516d2ef28e1254e699daa4f64980033783e44f2b5ceed3e
-generated: "2024-06-05T15:15:04.402697-04:00"
+  version: 0.63.0
+digest: sha256:31f544ae26a7c742da6a043d38190833eb9b0571dad072427ed6006d70887be0
+generated: "2024-06-24T11:36:56.631314-04:00"

charts/opentelemetry-kube-stack/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: opentelemetry-kube-stack
-version: 0.0.6
+version: 0.0.7
 description: |
   OpenTelemetry Quickstart chart for Kubernetes.
   Installs an operator and collector for an easy way to get started with Kubernetes observability.
@@ -13,12 +13,12 @@ maintainers:
   - name: dmitryax
   - name: TylerHelmuth
 icon: https://raw.githubusercontent.com/cncf/artwork/a718fa97fffec1b9fd14147682e9e3ac0c8817cb/projects/opentelemetry/icon/color/opentelemetry-icon-color.png
-appVersion: 0.101.0
+appVersion: 0.102.0
 dependencies:
   - name: crds
     version: "0.0.0"
     condition: crds.install
   - name: opentelemetry-operator
     repository: https://open-telemetry.github.io/opentelemetry-helm-charts
-    version: 0.61.0
+    version: 0.63.0
     condition: opentelemetry-operator.enabled

charts/opentelemetry-kube-stack/README.md

@@ -6,6 +6,26 @@
 
 This Helm chart serves as a quickstart for OpenTelemetry in a Kubernetes environment. The chart installs an [OpenTelemetry Operator](https://github.com/open-telemetry/opentelemetry-operator) and a suite of collectors that help you get started with OpenTelemetry metrics, traces, and logs.
 
+## Features
+
+This chart installs the OpenTelemetry Operator and two collector pools with the following features:
+* Daemonset collector
+  * Kubernetes infrastructure metrics
+  * Applications logs
+  * OTLP trace receiver
+  * Kubernetes resource enrichment
+* Standalone collector
+  * Kubernetes events
+  * Cluster metrics
+
+## Usage
+
+For example usage of this chart, please look in the examples/ folder where you can see how you can set a custom OTLP exporter for your desired destination. The example configuration also shows how to enable Instrumentation and OpAMP Bridge resources.
+
+### scrape_configs_file Details
+
+By default, the daemonset collector will load in the daemon_scrape_configs.yaml file which collects prometheus metrics from applications on the same node that have the prometheus.io/scrape=true annotation, kubernetes node metrics, and cadvisor metrics. Users can disable this by settings collectors.daemon.scrape_configs_file: "" OR they can provide their own promethues scrape config file for the daemonset by supplying collectors.daemon.scrape_configs_file: "<your-file>.yaml"
+
 ## Prerequisites
 
 - Kubernetes 1.24+ is required for OpenTelemetry Operator installation

charts/opentelemetry-kube-stack/daemon_scrape_configs.yaml

@@ -0,0 +1,176 @@
+# Collect all metrics from pods on the daemon set's node with at least this annotation
+# prometheus.io/scrape: 'true'
+# This can be further customized by setting the following annotations:
+# prometheus.io/scheme: 'https'
+# prometheus.io/path: '/data/metrics'
+# prometheus.io/port: '80'
+- job_name: kubernetes-pods
+  scrape_interval: 30s
+  kubernetes_sd_configs:
+    - role: pod
+      selectors:
+        - role: pod
+          # only scrape data from pods running on the same node as collector
+          field: "spec.nodeName=$OTEL_K8S_NODE_NAME"
+  relabel_configs:
+    - source_labels: [__meta_kubernetes_pod_annotation_prometheus_io_scrape]
+      action: keep
+      regex: true
+    - source_labels:
+        [__meta_kubernetes_pod_annotation_prometheus_io_scrape_slow]
+      action: drop
+      regex: true
+    - source_labels: [__meta_kubernetes_pod_annotation_prometheus_io_scheme]
+      action: replace
+      regex: (https?)
+      target_label: __scheme__
+    - source_labels: [__meta_kubernetes_pod_annotation_prometheus_io_path]
+      action: replace
+      target_label: __metrics_path__
+      regex: (.+)
+    - source_labels:
+        [__address__, __meta_kubernetes_pod_annotation_prometheus_io_port]
+      action: replace
+      regex: ([^:]+)(?::\d+)?;(\d+)
+      # NOTE: otel collector uses env var replacement. $$ is used as a literal $.
+      replacement: $$1:$$2
+      target_label: __address__
+    - action: labelmap
+      regex: __meta_kubernetes_pod_annotation_prometheus_io_param_(.+)
+      replacement: __param_$$1
+    - action: labelmap
+      regex: __meta_kubernetes_pod_label_(.+)
+    - source_labels: [__meta_kubernetes_namespace]
+      action: replace
+      target_label: namespace
+    - source_labels: [__meta_kubernetes_pod_name]
+      action: replace
+      target_label: pod
+    - source_labels: [__meta_kubernetes_pod_phase]
+      regex: Pending|Succeeded|Failed|Completed
+      action: drop
+    - action: replace
+      source_labels: [__meta_kubernetes_pod_label_app_kubernetes_io_name]
+      target_label: job
+# This job is setup to scrape the node metrics on the same host as the daemonset
+# https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/29053
+- job_name: node-exporter
+  scrape_interval: 30s
+  relabel_configs:
+    - action: labelmap
+      regex: __meta_kubernetes_node_label_(.+)
+    - action: replace
+      regex: "(.*)"
+      replacement: "$1"
+      separator: ";"
+      source_labels:
+        - job
+      target_label: __tmp_prometheus_job_name
+  static_configs:
+    - targets:
+        - ${OTEL_K8S_NODE_IP}:9100
+# We still need to scrape kubelet's CAdvisor which isn't supported in any otel collector receiver
+# https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/29053
+- authorization:
+    credentials_file: "/var/run/secrets/kubernetes.io/serviceaccount/token"
+    type: Bearer
+  follow_redirects: true
+  honor_labels: true
+  honor_timestamps: true
+  job_name: kubelet
+  kubernetes_sd_configs:
+    - follow_redirects: true
+      role: node
+      selectors:
+        - role: node
+          # only scrape data from pods running on the same node as collector
+          field: "metadata.name=$OTEL_K8S_NODE_NAME"
+  metric_relabel_configs:
+    - action: drop
+      regex: container_cpu_(load_average_10s|system_seconds_total|user_seconds_total)
+      replacement: "$1"
+      separator: ";"
+      source_labels:
+        - __name__
+    - action: drop
+      regex: container_fs_(io_current|reads_merged_total|sector_reads_total|sector_writes_total|writes_merged_total)
+      replacement: "$1"
+      separator: ";"
+      source_labels:
+        - __name__
+    - action: drop
+      regex: container_memory_(mapped_file|swap)
+      replacement: "$1"
+      separator: ";"
+      source_labels:
+        - __name__
+    - action: drop
+      regex: container_(file_descriptors|tasks_state|threads_max)
+      replacement: "$1"
+      separator: ";"
+      source_labels:
+        - __name__
+    - action: drop
+      regex: container_spec.*
+      replacement: "$1"
+      separator: ";"
+      source_labels:
+        - __name__
+    - action: drop
+      regex: ".+;"
+      replacement: "$1"
+      separator: ";"
+      source_labels:
+        - id
+        - pod
+  metrics_path: "/metrics/cadvisor"
+  relabel_configs:
+    - action: replace
+      regex: "(.*)"
+      replacement: "$1"
+      separator: ";"
+      source_labels:
+        - job
+      target_label: __tmp_prometheus_job_name
+    - action: replace
+      replacement: "kubelet"
+      target_label: job
+    - action: replace
+      regex: "(.*)"
+      replacement: "${1}"
+      separator: ";"
+      source_labels:
+        - __meta_kubernetes_node_name
+      target_label: node
+    - action: replace
+      regex: "(.*)"
+      replacement: https-metrics
+      separator: ";"
+      target_label: endpoint
+    - action: replace
+      regex: "(.*)"
+      replacement: "$1"
+      separator: ";"
+      source_labels:
+        - __metrics_path__
+      target_label: metrics_path
+    - action: hashmod
+      modulus: 1
+      regex: "(.*)"
+      replacement: "$1"
+      separator: ";"
+      source_labels:
+        - __address__
+      target_label: __tmp_hash
+    - action: keep
+      regex: "$(SHARD)"
+      replacement: "$1"
+      separator: ";"
+      source_labels:
+        - __tmp_hash
+  scheme: https
+  scrape_interval: 15s
+  scrape_timeout: 10s
+  tls_config:
+    ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/ca.crt"
+    insecure_skip_verify: true

charts/opentelemetry-kube-stack/examples/cloud-demo/rendered/bridge.yaml

@@ -0,0 +1,62 @@
+---
+# Source: opentelemetry-kube-stack/templates/bridge.yaml
+apiVersion: opentelemetry.io/v1alpha1
+kind: OpAMPBridge
+metadata:
+  name: example
+  labels:
+    helm.sh/chart: opentelemetry-kube-stack-0.0.7
+    app.kubernetes.io/version: "0.102.0"
+    app.kubernetes.io/managed-by: Helm    
+  annotations:
+    "helm.sh/hook": post-install,post-upgrade
+    "helm.sh/hook-delete-policy": hook-failed
+spec:
+  endpoint: http://opamp-server:8080
+  capabilities:
+    AcceptsOpAMPConnectionSettings: true
+    AcceptsOtherConnectionSettings: true
+    AcceptsRemoteConfig: true
+    AcceptsRestartCommand: true
+    ReportsEffectiveConfig: true
+    ReportsHealth: true
+    ReportsOwnLogs: true
+    ReportsOwnMetrics: true
+    ReportsOwnTraces: true
+    ReportsRemoteConfig: true
+    ReportsStatus: true
+  replicas: 1
+  image: "ghcr.io/open-telemetry/opentelemetry-operator/operator-opamp-bridge:0.102.0"
+  upgradeStrategy: automatic
+  securityContext:
+    runAsNonRoot: true
+    runAsUser: 1000
+  resources:
+    limits:
+      cpu: 250m
+      memory: 256Mi
+    requests:
+      cpu: 250m
+      memory: 256Mi
+  env:
+  - name: OTEL_K8S_NODE_NAME
+    valueFrom:
+      fieldRef:
+        fieldPath: spec.nodeName
+  - name: OTEL_K8S_NAMESPACE
+    valueFrom:
+      fieldRef:
+        apiVersion: v1
+        fieldPath: metadata.namespace
+  - name: OTEL_K8S_POD_NAME
+    valueFrom:
+      fieldRef:
+        apiVersion: v1
+        fieldPath: metadata.name
+  - name: OTEL_K8S_POD_IP
+    valueFrom:
+      fieldRef:
+        apiVersion: v1
+        fieldPath: status.podIP
+  - name: OTEL_RESOURCE_ATTRIBUTES
+    value: "k8s.cluster.name=demo"