[collector] Update readme

charts/opentelemetry-collector/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: opentelemetry-collector
-version: 0.66.1
+version: 0.66.2
 description: OpenTelemetry Collector Helm chart for Kubernetes
 type: application
 home: https://opentelemetry.io/

charts/opentelemetry-collector/README.md

@@ -24,6 +24,8 @@ helm install my-opentelemetry-collector open-telemetry/opentelemetry-collector -
 
 Where the `mode` value needs to be set to one of `daemonset`, `deployment` or `statefulset`.
 
+For an in-depth walk through getting started in Kubernetes using this helm chart, see [OpenTelemetry Kubernetes Getting Started](https://opentelemetry.io/docs/kubernetes/getting-started/).
+
 ## Upgrading
 
 See [UPGRADING.md](UPGRADING.md).
@@ -56,11 +58,9 @@ By default collector has the following receivers enabled:
 - **traces**: OTLP, zipkin and jaeger (thrift and grpc).
 - **logs**: OTLP (to enable container logs, see [Configuration for Kubernetes container logs](#configuration-for-kubernetes-container-logs)).
 
-There are two ways to configure collector pipelines, which can be used together as well.
-
-### Basic top level configuration
+### Basic Top Level Configuration
 
-Default components can be removed with `null`.  When changing a pipeline, you must explicitly list all the components that are in the pipeline, including any default components.
+The Collector's configuration is set via the `config` section. Default components can be removed with `null`. Remember that lists in helm are not merged, so if you want to modify any default list you must specify all items, including any default items you want to keep.
 
 *Example*: Disable metrics and logging pipelines and non-otlp receivers:
 
@@ -79,23 +79,15 @@ config:
       logs: null
 ```
 
-*Example*: Add host metrics receiver:
-
-```yaml
-mode: daemonset
-
-presets:
-  hostMetrics:
-    enabled: true
-```
+The chart also provides several presets, detailed below, to help configure important Kubernetes components. For more details on each component, see [Kubernetes Collector Components](https://opentelemetry.io/docs/kubernetes/collector/components/).
 
-### Configuration for Kubernetes container logs
+### Configuration for Kubernetes Container Logs
 
 The collector can be used to collect logs sent to standard output by Kubernetes containers.
 This feature is disabled by default. It has the following requirements:
 
 - It needs agent collector to be deployed.
-- It requires the [contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) version
+- It requires the [contrib](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib) version
 of the collector image.
 
 To enable this feature, set the  `presets.logsCollection.enabled` property to `true`.
@@ -150,13 +142,13 @@ config:
           - otlphttp
 ```
 
-### Configuration for Kubernetes attributes processor
+### Configuration for Kubernetes Attributes Processor
 
-The collector can be configured to add Kubernetes metadata to logs, metrics and traces.
+The collector can be configured to add Kubernetes metadata, such as pod name and namespace name, as resource attributes to incoming logs, metrics and traces. 
 
 This feature is disabled by default. It has the following requirements:
 
-- It requires [k8sattributesprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/k8sattributesprocessor) processor to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) version of the collector image.
+- It requires [k8sattributesprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/k8sattributesprocessor) processor to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib) version of the collector image.
 
 To enable this feature, set the  `presets.kubernetesAttributes.enabled` property to `true`.
 Here is an example `values.yaml`:
@@ -166,6 +158,10 @@ mode: daemonset
 presets:
   kubernetesAttributes:
     enabled: true
+    # You can also configure the preset to add all of the associated pod's labels and annotations to you telemetry.
+    # The label/annotation name will become the resource attribute's key.
+    extractAllPodLabels: true
+    extractAllPodAnnotations: true
 ```
 
 ### Configuration for Kubernetes Cluster Metrics
@@ -174,7 +170,7 @@ The collector can be configured to collects cluster-level metrics from the Kuber
 
 This feature is disabled by default. It has the following requirements:
 
-- It requires [k8sclusterreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/k8sclusterreceiver) to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) version of the collector image.
+- It requires [k8sclusterreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/k8sclusterreceiver) to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib) version of the collector image.
 - It requires statefulset or deployment mode with a single replica.
 
 To enable this feature, set the  `presets.clusterMetrics.enabled` property to `true`.
@@ -189,13 +185,13 @@ presets:
     enabled: true
 ```
 
-### Configuration for retrieving Kubelet metrics
+### Configuration for Retrieving Kubelet Metrics
 
 The collector can be configured to collect Kubelet metrics.
 
 This feature is disabled by default. It has the following requirements:
 
-- It requires [kubeletstats](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/kubeletstatsreceiver) receiver to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) version of the collector image.
+- It requires [kubeletstats](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/kubeletstatsreceiver) receiver to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib) version of the collector image.
 
 To enable this feature, set the  `presets.kubeletMetrics.enabled` property to `true`.
 Here is an example `values.yaml`:
@@ -207,7 +203,44 @@ presets:
     enabled: true
 ```
 
-### CRDs
+### Configuration for Retrieving Kubernetes Events
+
+The collector can be configured to collect Kubernetes events.
+
+This feature is disabled by default. It has the following requirements:
+
+- It requires [k8sobjects](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/k8sobjectsreceiver) receiver to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib) version of the collector image.
+
+To enable this feature, set the  `presets.kubernetesEvents.enabled` property to `true`.
+Here is an example `values.yaml`:
+
+```yaml
+mode: deployment
+replicaCount: 1
+presets:
+  kubernetesEvents:
+    enabled: true
+```
+
+### Configuration for Host Metrics
+
+The collector can be configured to collect host metrics for Kubernetes nodes.
+
+This feature is disabled by default. It has the following requirements:
+
+- It requires [hostmetrics](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetrics) receiver to be included in the collector, such as [contrib](https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib) version of the collector image.
+
+To enable this feature, set the  `presets.hostMetrics.enabled` property to `true`.
+Here is an example `values.yaml`:
+
+```yaml
+mode: daemonset
+presets:
+  hostMetrics:
+    enabled: true
+```
+
+## CRDs
 
 At this time, Prometheus CRDs are supported but other CRDs are not.
 

charts/opentelemetry-collector/examples/daemonset-and-deployment/rendered/configmap-agent.yaml

@@ -5,7 +5,7 @@ kind: ConfigMap
 metadata:
   name: example-opentelemetry-collector-agent
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"

charts/opentelemetry-collector/examples/daemonset-and-deployment/rendered/configmap.yaml

@@ -5,7 +5,7 @@ kind: ConfigMap
 metadata:
   name: example-opentelemetry-collector
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"

charts/opentelemetry-collector/examples/daemonset-and-deployment/rendered/daemonset.yaml

@@ -5,7 +5,7 @@ kind: DaemonSet
 metadata:
   name: example-opentelemetry-collector-agent
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"
@@ -21,7 +21,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: 7b64dbf926d340af8ec9128cc1583068a1d05b2158b7e7e977d4b7eafa56d71e
+        checksum/config: 1d3c1bda5cb0d96d6b141ee4e5b8ff914fee6c62c6388ca5413e6113b4ec1fbb
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/daemonset-and-deployment/rendered/deployment.yaml

@@ -5,7 +5,7 @@ kind: Deployment
 metadata:
   name: example-opentelemetry-collector
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"
@@ -23,7 +23,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: dffaf024a9279aa1e00b119107a2175df969a592a20465c9ec33ac71869ba4fb
+        checksum/config: 45115c8c454d58aeb2ac93b2109b3790aa86236e5e97c65f79133477f275372c
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/daemonset-and-deployment/rendered/service.yaml

@@ -5,7 +5,7 @@ kind: Service
 metadata:
   name: example-opentelemetry-collector
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"

charts/opentelemetry-collector/examples/daemonset-and-deployment/rendered/serviceaccount.yaml

@@ -5,7 +5,7 @@ kind: ServiceAccount
 metadata:
   name: example-opentelemetry-collector
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"

charts/opentelemetry-collector/examples/daemonset-collector-logs/rendered/configmap-agent.yaml

@@ -5,7 +5,7 @@ kind: ConfigMap
 metadata:
   name: example-opentelemetry-collector-agent
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"

charts/opentelemetry-collector/examples/daemonset-collector-logs/rendered/daemonset.yaml

@@ -5,7 +5,7 @@ kind: DaemonSet
 metadata:
   name: example-opentelemetry-collector-agent
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"
@@ -21,7 +21,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: ee598808417675e3315b0cb4ad5a70ff47c181b5eafde83ab7235d307b8af150
+        checksum/config: 4330d689ccdc658d07457fda6cf3c869e5680b391d9af7fc8cb6e5786bdd2e37
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/daemonset-collector-logs/rendered/serviceaccount.yaml

@@ -5,7 +5,7 @@ kind: ServiceAccount
 metadata:
   name: example-opentelemetry-collector
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"

charts/opentelemetry-collector/examples/daemonset-hostmetrics/rendered/configmap-agent.yaml

@@ -5,7 +5,7 @@ kind: ConfigMap
 metadata:
   name: example-opentelemetry-collector-agent
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"

charts/opentelemetry-collector/examples/daemonset-hostmetrics/rendered/daemonset.yaml

@@ -5,7 +5,7 @@ kind: DaemonSet
 metadata:
   name: example-opentelemetry-collector-agent
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"
@@ -21,7 +21,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: 992f0c19a9609e475dfeaf377f031f659384e98d8e31455826eecaf06a8380f0
+        checksum/config: 3302aeae562111e74014876cbaa6b0aa4f592e73d011b6fcb8513828d410827b
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/daemonset-hostmetrics/rendered/serviceaccount.yaml

@@ -5,7 +5,7 @@ kind: ServiceAccount
 metadata:
   name: example-opentelemetry-collector
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"

charts/opentelemetry-collector/examples/daemonset-lifecycle-hooks/rendered/configmap-agent.yaml

@@ -5,7 +5,7 @@ kind: ConfigMap
 metadata:
   name: example-opentelemetry-collector-agent
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"

charts/opentelemetry-collector/examples/daemonset-lifecycle-hooks/rendered/daemonset.yaml

@@ -5,7 +5,7 @@ kind: DaemonSet
 metadata:
   name: example-opentelemetry-collector-agent
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"
@@ -21,7 +21,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: e27c8cf2fc5b45f0161308346afb23e8a240c7a69f11ad7c9ea7f62101a965dc
+        checksum/config: 83853683de291251b2300379c3c80e6af3079c8846faf1aa3f80f832e2e2205d
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/daemonset-lifecycle-hooks/rendered/serviceaccount.yaml

@@ -5,7 +5,7 @@ kind: ServiceAccount
 metadata:
   name: example-opentelemetry-collector
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"

charts/opentelemetry-collector/examples/daemonset-only/rendered/configmap-agent.yaml

@@ -5,7 +5,7 @@ kind: ConfigMap
 metadata:
   name: example-opentelemetry-collector-agent
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"

charts/opentelemetry-collector/examples/daemonset-only/rendered/daemonset.yaml

@@ -5,7 +5,7 @@ kind: DaemonSet
 metadata:
   name: example-opentelemetry-collector-agent
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"
@@ -21,7 +21,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: e27c8cf2fc5b45f0161308346afb23e8a240c7a69f11ad7c9ea7f62101a965dc
+        checksum/config: 83853683de291251b2300379c3c80e6af3079c8846faf1aa3f80f832e2e2205d
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector

charts/opentelemetry-collector/examples/daemonset-only/rendered/serviceaccount.yaml

@@ -5,7 +5,7 @@ kind: ServiceAccount
 metadata:
   name: example-opentelemetry-collector
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"

charts/opentelemetry-collector/examples/deployment-only/rendered/configmap.yaml

@@ -5,7 +5,7 @@ kind: ConfigMap
 metadata:
   name: example-opentelemetry-collector
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"

charts/opentelemetry-collector/examples/deployment-only/rendered/deployment.yaml

@@ -5,7 +5,7 @@ kind: Deployment
 metadata:
   name: example-opentelemetry-collector
   labels:
-    helm.sh/chart: opentelemetry-collector-0.66.1
+    helm.sh/chart: opentelemetry-collector-0.66.2
     app.kubernetes.io/name: opentelemetry-collector
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "0.83.0"
@@ -23,7 +23,7 @@ spec:
   template:
     metadata:
       annotations:
-        checksum/config: dffaf024a9279aa1e00b119107a2175df969a592a20465c9ec33ac71869ba4fb
+        checksum/config: 45115c8c454d58aeb2ac93b2109b3790aa86236e5e97c65f79133477f275372c
 
       labels:
         app.kubernetes.io/name: opentelemetry-collector