1# Default values for opentelemetry-collector.
2# This is a YAML-formatted file.
3# Declare variables to be passed into your templates.
7# Valid values are "daemonset", "deployment", and "statefulset".
9# Override the default apiVersion for custom controllers or for testing new API versions.
11# Specify which namespace should be used to deploy the resources into
13# Handles basic configuration of components that
14# also require k8s modifications to work correctly.
15# .Values.config can be used to modify/add to a preset
16# component configuration, but CANNOT be used to remove
17# preset configuration. If you require removal of any
18# sections of a preset configuration, you cannot use
19# the preset. Instead, configure the component manually in
20# .Values.config and use the other fields supplied in the
21# values.yaml to configure k8s as necessary.
23 # Configures the collector to collect logs.
24 # Adds the file_log receiver to the logs pipeline
25 # and adds the necessary volumes and volume mounts.
26 # Best used with mode = daemonset.
27 # See https://opentelemetry.io/docs/kubernetes/collector/components/#filelog-receiver for details on the receiver.
30 includeCollectorLogs: false
31 # Enabling this writes checkpoints in /var/lib/otelcol/ host directory.
32 # Note this changes collector's user to root, so that it can write to host directory.
33 storeCheckpoints: false
34 # The maximum bytes size of the recombined field.
35 # Once the size exceeds the limit, all received entries of the source will be combined and flushed.
36 maxRecombineLogSize: 102400
37 # Configures the collector to collect host metrics.
38 # Adds the hostmetrics receiver to the metrics pipeline
39 # and adds the necessary volumes and volume mounts.
40 # Best used with mode = daemonset.
41 # See https://opentelemetry.io/docs/kubernetes/collector/components/#host-metrics-receiver for details on the receiver.
44 # Configures the Kubernetes Processor to add Kubernetes metadata.
45 # Adds the k8s_attributes processor to all the pipelines
46 # and adds a preset of minimum required RBAC rules to ClusterRole.
47 # Best used with mode = daemonset.
48 # See https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-attributes-processor for details on the receiver.
51 # When enabled the processor will extract all labels for an associated pod and add them as resource attributes.
52 # The label's exact name will be the key.
53 extractAllPodLabels: false
54 # When enabled the processor will extract all annotations for an associated pod and add them as resource attributes.
55 # The annotation's exact name will be the key.
56 extractAllPodAnnotations: false
57 # Configures the collector to collect node, pod, and container metrics from the API server on a kubelet.
58 # Adds the kubeletstats receiver to the metrics pipeline
59 # and adds the necessary rules to ClusterRole.
60 # Best used with mode = daemonset.
61 # See https://opentelemetry.io/docs/kubernetes/collector/components/#kubeletstats-receiver for details on the receiver.
64 # Configures the collector to collect kubernetes events.
65 # Adds the k8sobjects receiver to the logs pipeline
66 # and collects kubernetes events by default.
67 # Best used with mode = deployment or statefulset.
68 # See https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-objects-receiver for details on the receiver.
71 # When enabled, the preset uses the k8s_events receiver instead of k8sobjects. Will default to true in a future release.
72 useK8sEventsReceiver: false
73 # Collects Kubernetes objects via the k8sobjects receiver in pull mode (default interval: 1h).
74 # Can be used with mode = deployment, statefulset, or daemonset.
75 # Compatible with kubernetesEvents preset. Extra resources can be added via
76 # config.receivers.k8sobjects.objects (ClusterRole rules must be added manually via clusterRole.rules).
79 # When enabled with mode = daemonset, leader election is setup to prevent telemetry duplication.
80 # disableLeaderElection: false
81 # When enabled, watch mode is added alongside pull to stream real-time changes.
83 # Core Kubernetes workload resources: pods, nodes, namespaces, services, serviceaccounts, deployments, replicasets, daemonsets, statefulsets, jobs, cronjobs
86 # RBAC resources: roles, rolebindings, clusterroles, clusterrolebindings
89 # Storage resources: storageclasses, persistentvolumes, persistentvolumeclaims
92 # Networking resources: ingresses, networkpolicies
95 # Autoscaling resources: horizontalpodautoscalers
98 # VPA resources: verticalpodautoscalers (requires VPA CRD to be installed)
101 # Policy resources: poddisruptionbudgets
104 # API extensions resources: customresourcedefinitions
107 # Kubernetes events, collected in watch mode.
110 # Configures the Kubernetes Cluster Receiver to collect cluster-level metrics.
111 # Adds the k8s_cluster receiver to the metrics pipeline
112 # and adds the necessary rules to ClusterRole.
113 # Can be used with mode = deployment, statefulset, or daemonset.
114 # When used as a daemonset or with multiple replicas, leader election is set up to prevent duplication.
115 # See https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-cluster-receiver for details on the receiver.
118 # When enabled with mode = daemonset or with multiple replicas, leader election is set up to prevent telemetry duplication.
119 # disableLeaderElection: false
120 # Configures the collector to collect logs and metrics from pods with specific annotations.
121 # This preset can not be used together with the `logsCollection` preset.
122 # Adds the receiver_creator receiver to the logs and metrics pipelines
123 # and adds the necessary rules to ClusterRole.
124 # Best used with mode = daemonset.
125 # See https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/receivercreator/README.md#generate-receiver-configurations-from-provided-hints for details on the receiver.
131 # Configures the collector to collect profiling data.
132 # Adds profiles pipeline with the profiling receiver,
133 # and adds the necessary volumes, security context and host PID access.
135 # Warning: The profiling receiver requires elevated capabilities and hostPID,
136 # so it should be used with a dedicated collector distribution (e.g. otelcol-ebpf-profiler)
137 # rather than the general-purpose k8s distribution. This avoids granting elevated privileges
138 # to the same collector that handles metrics, traces, and logs.
139 # See https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-ebpf-profiler for more details.
142 # Configures the collector to detect resource attributes using the resourcedetection processor.
143 # Adds the resourcedetection/env processor to all pipelines.
144 # Each detector can be enabled individually. Base detectors 'env' and 'k8s_api' are always included when any detector is enabled.
145 # Typically used to resolve the 'k8s.cluster.name' resource attribute.
146 # See https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/resourcedetectionprocessor for details.
160 # Specifies whether a configMap should be created (true by default)
162 # Specifies an existing ConfigMap to be mounted to the pod
163 # The ConfigMap MUST include the collector configuration via a key named 'relay' or the collector will not start.
164 # This also supports template content, which will eventually be converted to yaml.
166 # Specifies the relative path to custom ConfigMap template file. This option SHOULD be used when bundling a custom
167 # ConfigMap template, as it enables pod restart via a template checksum annotation.
169# When enabled, the chart will configure the collector to emit its traces, metrics, and logs over http via the OTLP using the Otel Go SDK.
170# If internalTelemetryViaOTLP.metrics.enabled the chart will remove the default prometheus receiver (which was configured to scrape the Collector's metrics).
171# Learn more about the Collector telemetry at https://opentelemetry.io/docs/collector/internal-telemetry/.
173# THIS OPTION IS EXPERIMENTAL AND SUBJECT TO BREAKING CHANGES
174internalTelemetryViaOTLP:
175 # The endpoint where the telemetry will be exported
177 # Optional headers to configure the exporters
179 # - name: "x-dest-auth"
180 # value: "some auth key"
183 # overrides internalTelemetryViaOTLP.endpoint for traces
185 # overrides internalTelemetryViaOTLP.headers for traces
189 # overrides internalTelemetryViaOTLP.endpoint for metrics
191 # overrides internalTelemetryViaOTLP.headers for metrics
195 # overrides internalTelemetryViaOTLP.endpoint for logs
197 # overrides internalTelemetryViaOTLP.headers for logs
199# Rewrite deprecated component names (e.g. k8sattributes -> k8s_attributes
200# processor, k8snode -> k8s_api resourcedetection detector) in the generated
201# config. Set to false if using older Collector images that do not recognize the
202# new names. Renamed from rewriteDeprecatedProcessorNames in chart 0.162.0.
203rewriteDeprecatedComponentNames: true
204# Base collector configuration.
205# Supports templating. To escape existing instances of {{ }}, use {{` <original content> `}}.
206# For example, {{ REDACTED_EMAIL }} becomes {{` {{ REDACTED_EMAIL }} `}}.
211 # The health_check extension is mandatory for this chart.
212 # Without the health_check extension the collector will fail the readiness and liveness probes.
213 # The health_check extension can be modified, but should never be removed.
215 endpoint: ${env:MY_POD_IP}:13133
218 # Default memory limiter configuration for the collector based on k8s resource limits.
220 # check_interval is the time between measurements of memory usage.
222 # By default limit_mib is set to 80% of ".Values.resources.limits.memory"
224 # By default spike_limit_mib is set to 25% of ".Values.resources.limits.memory"
225 spike_limit_percentage: 25
230 endpoint: ${env:MY_POD_IP}:14250
232 endpoint: ${env:MY_POD_IP}:14268
234 endpoint: ${env:MY_POD_IP}:6831
238 endpoint: ${env:MY_POD_IP}:4317
240 endpoint: ${env:MY_POD_IP}:4318
241 # if internalTelemetryViaOTLP.metrics.enabled = true, prometheus receiver will be removed
245 - job_name: opentelemetry-collector
249 - ${env:MY_POD_IP}:8888
251 endpoint: ${env:MY_POD_IP}:9411
255 k8s.namespace.name: "${env:OTEL_K8S_NAMESPACE}"
256 k8s.node.name: "${env:OTEL_K8S_NODE_NAME}"
257 k8s.node.ip: "${env:OTEL_K8S_NODE_IP}"
258 k8s.pod.name: "${env:OTEL_K8S_POD_NAME}"
259 k8s.pod.ip: "${env:OTEL_K8S_POD_IP}"
260 host.name: "${env:OTEL_K8S_NODE_NAME}"
266 host: ${env:MY_POD_IP}
287 # if internalTelemetryViaOTLP.metrics.enabled = true, prometheus receiver will be removed
299# Helm currently has an issue (https://github.com/helm/helm/pull/12879) when using null to remove
300# default configuration from a subchart. The result is that you cannot remove default configuration
301# from `config`, such as a specific receiver or a specific pipeline, when the chart is used as a
304# Until the helm bug is fixed, this field is provided as an alternative when using this chart as a subchart.
305# It is not recommended to use this field when installing the chart directly.
307# When not empty, `alternateConfig` will be used to set the collector's configuration. It has NO default
308# values and IS NOT MERGED with config. Any configuration provided via `config` will be ignored when
309# `alternateConfig` is set. You MUST provide your own collector configuration.
311# Reminder that the healthcheck extension (or something else that provides the same functionality) is required.
313# Components configured by presets will be injected in the same way they are for `config`.
316 # If you want to use the core image `otel/opentelemetry-collector`, you also need to change `command.name` value to `otelcol`.
317 repository: cgr.dev/scratch-images/test-tmp/opentelemetry-collector-contrib
318 pullPolicy: IfNotPresent
319 # Overrides the image tag whose default is the chart appVersion.
321 # When digest is set to a non-empty value, images will be pulled by digest (regardless of tag value).
322 digest: sha256:f3d28314e465252e72a2396b255e688cbf8c216ce52f7b433fdccef3e85bec00
324# OpenTelemetry Collector executable
329 # Specifies whether a service account should be created
331 # Annotations to add to the service account
333 # The name of the service account to use.
334 # If not set and create is true, a name is generated using the fullname template
336 # Automatically mount a ServiceAccount's API credentials?
337 automountServiceAccountToken: true
339 # Specifies whether a clusterRole should be created
340 # Some presets also trigger the creation of a cluster role and cluster role binding.
341 # If using one of those presets, this field is no-op.
343 # Annotations to add to the clusterRole
344 # Can be used in combination with presets that create a cluster role.
346 # The name of the clusterRole to use.
347 # If not set a name is generated using the fullname template
348 # Can be used in combination with presets that create a cluster role.
350 # A set of rules as documented here : https://kubernetes.io/docs/reference/access-authn-authz/rbac/
351 # Can be used in combination with presets that create a cluster role to add additional rules.
364 # Annotations to add to the clusterRoleBinding
365 # Can be used in combination with presets that create a cluster role binding.
367 # The name of the clusterRoleBinding to use.
368 # If not set a name is generated using the fullname template
369 # Can be used in combination with presets that create a cluster role binding.
371podSecurityContext: {}
376topologySpreadConstraints: []
377# Allows for pod scheduler prioritisation
379# Allows for pod to use a specific runtime class, e.g. gvisor, kata-containers
380# Also useful for the pod security admissions plugins that rely on runtimeClassName
382terminationGracePeriodSeconds: 30
383# This also supports template content, which will eventually be converted to yaml.
385# This also supports template content, which will eventually be converted to yaml.
387# This also supports template content, which will eventually be converted to yaml.
389# This also supports template content, which will eventually be converted to yaml.
391# This also supports template content, which will eventually be converted to yaml.
393# Configuration for ports
394# nodePort is also allowed
435 # The metrics port is disabled by default. However you need to enable the port
436 # in order to use the ServiceMonitor (serviceMonitor.enabled) or PodMonitor (podMonitor.enabled).
441# When enabled, the chart will set the GOMEMLIMIT env var to 80% of the configured resources.limits.memory.
442# If no resources.limits.memory are defined then enabling does nothing.
443# It is HIGHLY recommend to enable this setting and set a value for resources.limits.memory.
445# Container resize policy for in-place resource resize (Kubernetes >= 1.27).
446# https://kubernetes.io/docs/concepts/workloads/autoscaling/#in-place-resizing
450# restartPolicy: NotRequired
451# - resourceName: memory
452# restartPolicy: RestartContainer
454# Resource limits & requests.
455# It is HIGHLY recommended to set resource limits.
462enableConfigChecksumAnnotation: true
465# Common labels to add to all otel-collector resources. Evaluated as a template.
467# app.kubernetes.io/part-of: my-app
469# Host networking requested for this pod. Use the host's network namespace.
471# Enable sharing the host's PID namespace with the pod.
472# WARNING: This grants visibility into all host processes and should only be enabled when required.
474# Adding entries to Pod /etc/hosts with HostAliases
475# https://kubernetes.io/docs/tasks/network/customize-hosts-file-for-pods/
481# Pod DNS policy ClusterFirst, ClusterFirstWithHostNet, None, Default, None
483# Custom DNS config. Required when DNS policy is None.
485# Custom kube scheduler name.
487# only used with deployment mode
489revisionHistoryLimit: 10
491# List of extra sidecars to add.
492# This also supports template content, which will eventually be converted to yaml.
501# image: busybox:latest
506# List of init container specs, e.g. for copying a binary to be executed as a lifecycle hook.
507# This also supports template content, which will eventually be converted to yaml.
508# Another usage of init containers is e.g. initializing filesystem permissions to the OTLP Collector user `10001` in case you are using persistence and the volume is producing a permission denied error for the OTLP Collector container.
512# image: busybox:latest
522# image: busybox:latest
526# - 'chown -R 10001: /var/lib/storage/otc' # use the path given as per `extensions.file_storage.directory` & `extraVolumeMounts[x].mountPath`
528# - name: opentelemetry-collector-data # use the name of the volume used for persistence
529# mountPath: /var/lib/storage/otc # use the path given as per `extensions.file_storage.directory` & `extraVolumeMounts[x].mountPath`
531# Pod lifecycle policies.
540# liveness probe configuration
541# Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
544 # Number of seconds after the container has started before startup, liveness or readiness probes are initiated.
545 # initialDelaySeconds: 1
546 # How often in seconds to perform the probe.
548 # Number of seconds after which the probe times out.
550 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
551 # failureThreshold: 1
552 # Duration in seconds the pod needs to terminate gracefully upon probe failure.
553 # terminationGracePeriodSeconds: 10
557# readiness probe configuration
558# Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
561 # Number of seconds after the container has started before startup, liveness or readiness probes are initiated.
562 # initialDelaySeconds: 1
563 # How often (in seconds) to perform the probe.
565 # Number of seconds after which the probe times out.
567 # Minimum consecutive successes for the probe to be considered successful after having failed.
568 # successThreshold: 1
569 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
570 # failureThreshold: 1
574# startup probe configuration
575# Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
578# Number of seconds after the container has started before startup probes are initiated.
579# initialDelaySeconds: 1
580# How often in seconds to perform the probe.
582# Number of seconds after which the probe times out.
584# Minimum consecutive failures for the probe to be considered failed after having succeeded.
586# Duration in seconds the pod needs to terminate gracefully upon probe failure.
587# terminationGracePeriodSeconds: 10
593 # Enable the creation of a Service.
594 # By default, it's enabled on mode != daemonset.
595 # However, to enable it on mode = daemonset, its creation must be explicitly enabled
598 # Supported values: PreferClose (deprecated in K8s 1.33+), PreferSameZone, PreferSameNode
599 # trafficDistribution: PreferClose
601 # loadBalancerIP: 1.2.3.4
602 # loadBalancerSourceRanges: []
604 # By default, Service of type 'LoadBalancer' or 'NodePort' will be created setting 'externalTrafficPolicy: Cluster'
605 # unless other value is explicitly set.
606 # Possible values are Cluster or Local (https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip)
607 # externalTrafficPolicy: Cluster
609 # By default, Service will be created setting 'internalTrafficPolicy: Local' on mode = daemonset
610 # unless other value is explicitly set.
611 # Setting 'internalTrafficPolicy: Cluster' on a daemonset is not recommended
612 # internalTrafficPolicy: Cluster
616 # ingressClassName: nginx
618 # - host: collector.example.com
624 # - secretName: collector-tls
626 # - collector.example.com
628 # Additional ingresses - only created if ingress.enabled is true
629 # Useful for when differently annotated ingress services are required
630 # Each additional ingress needs key "name" set to something unique
631 additionalIngresses: []
633 # ingressClassName: nginx
636 # - host: collector.example.com
642 # - secretName: collector-tls
644 # - collector.example.com
645# Gateway API HTTPRoute. An alternative to ingress for exposing the
646# collector's HTTP-based receivers through a Gateway API implementation.
647# Requires the Gateway API CRDs to be installed in the cluster.
650 # HTTPRoute apiVersion (defaults to "gateway.networking.k8s.io/v1" when empty)
653 # parentRefs reference the Gateway(s) this HTTPRoute is attached to
656 # namespace: gateway-system
657 # sectionName: otlp-http
659 # hostnames matched against the HTTP Host header to select this route
661 # - collector.example.com
663 # rules associate request matches with a backend port on the collector
664 # service. backendRefs "name" defaults to the collector service when omitted.
674 # The pod monitor by default scrapes the metrics port.
675 # The metrics port needs to be enabled as well.
680 # additional labels for the PodMonitor
682 # release: kube-prometheus-stack
684 # The service monitor by default scrapes the metrics port.
685 # The metrics port needs to be enabled as well.
690 # additional labels for the ServiceMonitor
692 # release: kube-prometheus-stack
693 # Used to set relabeling and metricRelabeling configs on the ServiceMonitor
694 # https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
696 metricRelabelings: []
697 # Sets a sample limit on the ServiceMonitor
699# PodDisruptionBudget is used only if mode is "deployment" or "statefulset"
705# autoscaling is used only if mode is "deployment" or "statefulset"
711 targetCPUUtilizationPercentage: 80
712 # targetMemoryUtilizationPercentage: 80
713 # Supply an array of custom metrics to be used for autoscaling. It includes externalMetrics, objectMetrics, and podsMetrics.
714 additionalMetrics: []
717 # When 'mode: daemonset', maxSurge cannot be used when hostPort is set for any of the ports
720 strategy: RollingUpdate
724 # Create default rules for monitoring the collector
727 ## Additional labels for PrometheusRule alerts
728 additionalRuleLabels: {}
729 ## Additional annotations for PrometheusRule alerts
730 additionalRuleAnnotations: {}
731 # additional labels for the PrometheusRule
734 # volumeClaimTemplates for a statefulset
735 volumeClaimTemplates: []
736 podManagementPolicy: "Parallel"
737 # Controls if and how PVCs created by the StatefulSet are deleted. Available in Kubernetes 1.23+.
738 persistentVolumeClaimRetentionPolicy:
744 # Annotations to add to the NetworkPolicy
746 # Configure the 'from' clause of the NetworkPolicy.
747 # By default this will restrict traffic to ports enabled for the Collector. If
748 # you wish to further restrict traffic to other hosts or specific namespaces,
749 # see the standard NetworkPolicy 'spec.ingress.from' definition for more info:
750 # https://kubernetes.io/docs/reference/kubernetes-api/policy-resources/network-policy-v1/
752 # # Allow traffic from any pod in any namespace, but not external hosts
753 # - namespaceSelector: {}
754 # # Allow external access from a specific cidr block
756 # cidr: 192.168.1.64/32
757 # # Allow access from pods in specific namespaces
758 # - namespaceSelector:
760 # - key: kubernetes.io/metadata.name
766 # Add additional ingress rules to specific ports
767 # Useful to allow external hosts/services to access specific ports
768 # An example is allowing an external prometheus server to scrape metrics
770 # See the standard NetworkPolicy 'spec.ingress' definition for more info:
771 # https://kubernetes.io/docs/reference/kubernetes-api/policy-resources/network-policy-v1/
772 extraIngressRules: []
778 # cidr: 192.168.1.64/32
780 # Restrict egress traffic from the OpenTelemetry collector pod
781 # See the standard NetworkPolicy 'spec.egress' definition for more info:
782 # https://kubernetes.io/docs/reference/kubernetes-api/policy-resources/network-policy-v1/
785 # - namespaceSelector: {}
787 # cidr: 192.168.10.10/24
791# Allow containers to share processes across pod namespace
792shareProcessNamespace: false