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 filelog 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 # Collects Kubernetes objects via the k8sobjects receiver in pull mode (default interval: 1h).
72 # Can be used with mode = deployment, statefulset, or daemonset.
73 # Compatible with kubernetesEvents preset. Extra resources can be added via
74 # config.receivers.k8sobjects.objects (ClusterRole rules must be added manually via clusterRole.rules).
77 # When enabled with mode = daemonset, leader election is setup to prevent telemetry duplication.
78 # disableLeaderElection: false
79 # When enabled, watch mode is added alongside pull to stream real-time changes.
81 # Core Kubernetes workload resources: pods, nodes, namespaces, services, serviceaccounts, deployments, replicasets, daemonsets, statefulsets, jobs, cronjobs
84 # RBAC resources: roles, rolebindings, clusterroles, clusterrolebindings
87 # Storage resources: storageclasses, persistentvolumes, persistentvolumeclaims
90 # Networking resources: ingresses, networkpolicies
93 # Autoscaling resources: horizontalpodautoscalers
96 # VPA resources: verticalpodautoscalers (requires VPA CRD to be installed)
99 # Policy resources: poddisruptionbudgets
102 # API extensions resources: customresourcedefinitions
105 # Configures the Kubernetes Cluster Receiver to collect cluster-level metrics.
106 # Adds the k8s_cluster receiver to the metrics pipeline
107 # and adds the necessary rules to ClusterRole.
108 # Can be used with mode = deployment, statefulset, or daemonset.
109 # When used as a daemonset or with multiple replicas, leader election is set up to prevent duplication.
110 # See https://opentelemetry.io/docs/kubernetes/collector/components/#kubernetes-cluster-receiver for details on the receiver.
113 # When enabled with mode = daemonset or with multiple replicas, leader election is set up to prevent telemetry duplication.
114 # disableLeaderElection: false
115 # Configures the collector to collect logs and metrics from pods with specific annotations.
116 # This preset can not be used together with the `logsCollection` preset.
117 # Adds the receiver_creator receiver to the logs and metrics pipelines
118 # and adds the necessary rules to ClusterRole.
119 # Best used with mode = daemonset.
120 # 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.
126 # Configures the collector to collect profiling data.
127 # Adds profiles pipeline with the profiling receiver,
128 # and adds the necessary volumes, security context and host PID access.
130 # Warning: The profiling receiver requires privileged access and hostPID,
131 # so it should be used with a dedicated collector distribution (e.g. otelcol-ebpf-profiler)
132 # rather than the general-purpose k8s distribution. This avoids granting elevated privileges
133 # to the same collector that handles metrics, traces, and logs.
134 # See https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-ebpf-profiler for more details.
137 # Configures the collector to detect resource attributes using the resourcedetection processor.
138 # Adds the resourcedetection/env processor to all pipelines.
139 # Each detector can be enabled individually. Base detectors 'env' and 'k8s_api' are always included when any detector is enabled.
140 # Typically used to resolve the 'k8s.cluster.name' resource attribute.
141 # See https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/resourcedetectionprocessor for details.
155 # Specifies whether a configMap should be created (true by default)
157 # Specifies an existing ConfigMap to be mounted to the pod
158 # The ConfigMap MUST include the collector configuration via a key named 'relay' or the collector will not start.
159 # This also supports template content, which will eventually be converted to yaml.
161 # Specifies the relative path to custom ConfigMap template file. This option SHOULD be used when bundling a custom
162 # ConfigMap template, as it enables pod restart via a template checksum annotation.
164# 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.
165# If internalTelemetryViaOTLP.metrics.enabled the chart will remove the default prometheus receiver (which was configured to scrape the Collector's metrics).
166# Learn more about the Collector telemetry at https://opentelemetry.io/docs/collector/internal-telemetry/.
168# THIS OPTION IS EXPERIMENTAL AND SUBJECT TO BREAKING CHANGES
169internalTelemetryViaOTLP:
170 # The endpoint where the telemetry will be exported
172 # Optional headers to configure the exporters
174 # - name: "x-dest-auth"
175 # value: "some auth key"
178 # overrides internalTelemetryViaOTLP.endpoint for traces
180 # overrides internalTelemetryViaOTLP.headers for traces
184 # overrides internalTelemetryViaOTLP.endpoint for metrics
186 # overrides internalTelemetryViaOTLP.headers for metrics
190 # overrides internalTelemetryViaOTLP.endpoint for logs
192 # overrides internalTelemetryViaOTLP.headers for logs
194# Rewrite deprecated component names (e.g. k8sattributes -> k8s_attributes
195# processor, k8snode -> k8s_api resourcedetection detector) in the generated
196# config. Set to false if using older Collector images that do not recognize the
197# new names. Renamed from rewriteDeprecatedProcessorNames in chart 0.162.0.
198rewriteDeprecatedComponentNames: true
199# Base collector configuration.
200# Supports templating. To escape existing instances of {{ }}, use {{` <original content> `}}.
201# For example, {{ REDACTED_EMAIL }} becomes {{` {{ REDACTED_EMAIL }} `}}.
206 # The health_check extension is mandatory for this chart.
207 # Without the health_check extension the collector will fail the readiness and liveness probes.
208 # The health_check extension can be modified, but should never be removed.
210 endpoint: ${env:MY_POD_IP}:13133
213 # Default memory limiter configuration for the collector based on k8s resource limits.
215 # check_interval is the time between measurements of memory usage.
217 # By default limit_mib is set to 80% of ".Values.resources.limits.memory"
219 # By default spike_limit_mib is set to 25% of ".Values.resources.limits.memory"
220 spike_limit_percentage: 25
225 endpoint: ${env:MY_POD_IP}:14250
227 endpoint: ${env:MY_POD_IP}:14268
229 endpoint: ${env:MY_POD_IP}:6831
233 endpoint: ${env:MY_POD_IP}:4317
235 endpoint: ${env:MY_POD_IP}:4318
236 # if internalTelemetryViaOTLP.metrics.enabled = true, prometheus receiver will be removed
240 - job_name: opentelemetry-collector
244 - ${env:MY_POD_IP}:8888
246 endpoint: ${env:MY_POD_IP}:9411
250 k8s.namespace.name: "${env:OTEL_K8S_NAMESPACE}"
251 k8s.node.name: "${env:OTEL_K8S_NODE_NAME}"
252 k8s.node.ip: "${env:OTEL_K8S_NODE_IP}"
253 k8s.pod.name: "${env:OTEL_K8S_POD_NAME}"
254 k8s.pod.ip: "${env:OTEL_K8S_POD_IP}"
255 host.name: "${env:OTEL_K8S_NODE_NAME}"
261 host: ${env:MY_POD_IP}
282 # if internalTelemetryViaOTLP.metrics.enabled = true, prometheus receiver will be removed
294# Helm currently has an issue (https://github.com/helm/helm/pull/12879) when using null to remove
295# default configuration from a subchart. The result is that you cannot remove default configuration
296# from `config`, such as a specific receiver or a specific pipeline, when the chart is used as a
299# Until the helm bug is fixed, this field is provided as an alternative when using this chart as a subchart.
300# It is not recommended to use this field when installing the chart directly.
302# When not empty, `alternateConfig` will be used to set the collector's configuration. It has NO default
303# values and IS NOT MERGED with config. Any configuration provided via `config` will be ignored when
304# `alternateConfig` is set. You MUST provide your own collector configuration.
306# Reminder that the healthcheck extension (or something else that provides the same functionality) is required.
308# Components configured by presets will be injected in the same way they are for `config`.
311 # If you want to use the core image `otel/opentelemetry-collector`, you also need to change `command.name` value to `otelcol`.
312 repository: cgr.dev/scratch-images/test-tmp/opentelemetry-collector-contrib
313 pullPolicy: IfNotPresent
314 # Overrides the image tag whose default is the chart appVersion.
316 # When digest is set to a non-empty value, images will be pulled by digest (regardless of tag value).
317 digest: sha256:0585c738f2e5a64cee771c4f78889a19b931c7cfecd63bd0eb15ec9de04001dd
319# OpenTelemetry Collector executable
324 # Specifies whether a service account should be created
326 # Annotations to add to the service account
328 # The name of the service account to use.
329 # If not set and create is true, a name is generated using the fullname template
331 # Automatically mount a ServiceAccount's API credentials?
332 automountServiceAccountToken: true
334 # Specifies whether a clusterRole should be created
335 # Some presets also trigger the creation of a cluster role and cluster role binding.
336 # If using one of those presets, this field is no-op.
338 # Annotations to add to the clusterRole
339 # Can be used in combination with presets that create a cluster role.
341 # The name of the clusterRole to use.
342 # If not set a name is generated using the fullname template
343 # Can be used in combination with presets that create a cluster role.
345 # A set of rules as documented here : https://kubernetes.io/docs/reference/access-authn-authz/rbac/
346 # Can be used in combination with presets that create a cluster role to add additional rules.
359 # Annotations to add to the clusterRoleBinding
360 # Can be used in combination with presets that create a cluster role binding.
362 # The name of the clusterRoleBinding to use.
363 # If not set a name is generated using the fullname template
364 # Can be used in combination with presets that create a cluster role binding.
366podSecurityContext: {}
371topologySpreadConstraints: []
372# Allows for pod scheduler prioritisation
374# Allows for pod to use a specific runtime class, e.g. gvisor, kata-containers
375# Also useful for the pod security admissions plugins that rely on runtimeClassName
377terminationGracePeriodSeconds: 30
380# This also supports template content, which will eventually be converted to yaml.
382# This also supports template content, which will eventually be converted to yaml.
384# This also supports template content, which will eventually be converted to yaml.
386# Configuration for ports
387# nodePort is also allowed
428 # The metrics port is disabled by default. However you need to enable the port
429 # in order to use the ServiceMonitor (serviceMonitor.enabled) or PodMonitor (podMonitor.enabled).
434# When enabled, the chart will set the GOMEMLIMIT env var to 80% of the configured resources.limits.memory.
435# If no resources.limits.memory are defined then enabling does nothing.
436# It is HIGHLY recommend to enable this setting and set a value for resources.limits.memory.
438# Container resize policy for in-place resource resize (Kubernetes >= 1.27).
439# https://kubernetes.io/docs/concepts/workloads/autoscaling/#in-place-resizing
443# restartPolicy: NotRequired
444# - resourceName: memory
445# restartPolicy: RestartContainer
447# Resource limits & requests.
448# It is HIGHLY recommended to set resource limits.
455enableConfigChecksumAnnotation: true
458# Common labels to add to all otel-collector resources. Evaluated as a template.
460# app.kubernetes.io/part-of: my-app
462# Host networking requested for this pod. Use the host's network namespace.
464# Enable sharing the host's PID namespace with the pod.
465# WARNING: This grants visibility into all host processes and should only be enabled when required.
467# Adding entries to Pod /etc/hosts with HostAliases
468# https://kubernetes.io/docs/tasks/network/customize-hosts-file-for-pods/
474# Pod DNS policy ClusterFirst, ClusterFirstWithHostNet, None, Default, None
476# Custom DNS config. Required when DNS policy is None.
478# Custom kube scheduler name.
480# only used with deployment mode
482revisionHistoryLimit: 10
484# List of extra sidecars to add.
485# This also supports template content, which will eventually be converted to yaml.
494# image: busybox:latest
499# List of init container specs, e.g. for copying a binary to be executed as a lifecycle hook.
500# This also supports template content, which will eventually be converted to yaml.
501# 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.
505# image: busybox:latest
515# image: busybox:latest
519# - 'chown -R 10001: /var/lib/storage/otc' # use the path given as per `extensions.file_storage.directory` & `extraVolumeMounts[x].mountPath`
521# - name: opentelemetry-collector-data # use the name of the volume used for persistence
522# mountPath: /var/lib/storage/otc # use the path given as per `extensions.file_storage.directory` & `extraVolumeMounts[x].mountPath`
524# Pod lifecycle policies.
533# liveness probe configuration
534# Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
537 # Number of seconds after the container has started before startup, liveness or readiness probes are initiated.
538 # initialDelaySeconds: 1
539 # How often in seconds to perform the probe.
541 # Number of seconds after which the probe times out.
543 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
544 # failureThreshold: 1
545 # Duration in seconds the pod needs to terminate gracefully upon probe failure.
546 # terminationGracePeriodSeconds: 10
550# readiness probe configuration
551# Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
554 # Number of seconds after the container has started before startup, liveness or readiness probes are initiated.
555 # initialDelaySeconds: 1
556 # How often (in seconds) to perform the probe.
558 # Number of seconds after which the probe times out.
560 # Minimum consecutive successes for the probe to be considered successful after having failed.
561 # successThreshold: 1
562 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
563 # failureThreshold: 1
567# startup probe configuration
568# Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
571# Number of seconds after the container has started before startup probes are initiated.
572# initialDelaySeconds: 1
573# How often in seconds to perform the probe.
575# Number of seconds after which the probe times out.
577# Minimum consecutive failures for the probe to be considered failed after having succeeded.
579# Duration in seconds the pod needs to terminate gracefully upon probe failure.
580# terminationGracePeriodSeconds: 10
586 # Enable the creation of a Service.
587 # By default, it's enabled on mode != daemonset.
588 # However, to enable it on mode = daemonset, its creation must be explicitly enabled
591 # Supported values: PreferClose (deprecated in K8s 1.33+), PreferSameZone, PreferSameNode
592 # trafficDistribution: PreferClose
594 # loadBalancerIP: 1.2.3.4
595 # loadBalancerSourceRanges: []
597 # By default, Service of type 'LoadBalancer' will be created setting 'externalTrafficPolicy: Cluster'
598 # unless other value is explicitly set.
599 # Possible values are Cluster or Local (https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip)
600 # externalTrafficPolicy: Cluster
602 # By default, Service will be created setting 'internalTrafficPolicy: Local' on mode = daemonset
603 # unless other value is explicitly set.
604 # Setting 'internalTrafficPolicy: Cluster' on a daemonset is not recommended
605 # internalTrafficPolicy: Cluster
609 # ingressClassName: nginx
611 # - host: collector.example.com
617 # - secretName: collector-tls
619 # - collector.example.com
621 # Additional ingresses - only created if ingress.enabled is true
622 # Useful for when differently annotated ingress services are required
623 # Each additional ingress needs key "name" set to something unique
624 additionalIngresses: []
626 # ingressClassName: nginx
629 # - host: collector.example.com
635 # - secretName: collector-tls
637 # - collector.example.com
638# Gateway API HTTPRoute. An alternative to ingress for exposing the
639# collector's HTTP-based receivers through a Gateway API implementation.
640# Requires the Gateway API CRDs to be installed in the cluster.
643 # HTTPRoute apiVersion (defaults to "gateway.networking.k8s.io/v1" when empty)
646 # parentRefs reference the Gateway(s) this HTTPRoute is attached to
649 # namespace: gateway-system
650 # sectionName: otlp-http
652 # hostnames matched against the HTTP Host header to select this route
654 # - collector.example.com
656 # rules associate request matches with a backend port on the collector
657 # service. backendRefs "name" defaults to the collector service when omitted.
667 # The pod monitor by default scrapes the metrics port.
668 # The metrics port needs to be enabled as well.
673 # additional labels for the PodMonitor
675 # release: kube-prometheus-stack
677 # The service monitor by default scrapes the metrics port.
678 # The metrics port needs to be enabled as well.
683 # additional labels for the ServiceMonitor
685 # release: kube-prometheus-stack
686 # Used to set relabeling and metricRelabeling configs on the ServiceMonitor
687 # https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
689 metricRelabelings: []
690 # Sets a sample limit on the ServiceMonitor
692# PodDisruptionBudget is used only if mode is "deployment" or "statefulset"
698# autoscaling is used only if mode is "deployment" or "statefulset"
704 targetCPUUtilizationPercentage: 80
705 # targetMemoryUtilizationPercentage: 80
706 # Supply an array of custom metrics to be used for autoscaling. It includes externalMetrics, objectMetrics, and podsMetrics.
707 additionalMetrics: []
710 # When 'mode: daemonset', maxSurge cannot be used when hostPort is set for any of the ports
713 strategy: RollingUpdate
717 # Create default rules for monitoring the collector
720 ## Additional labels for PrometheusRule alerts
721 additionalRuleLabels: {}
722 ## Additional annotations for PrometheusRule alerts
723 additionalRuleAnnotations: {}
724 # additional labels for the PrometheusRule
727 # volumeClaimTemplates for a statefulset
728 volumeClaimTemplates: []
729 podManagementPolicy: "Parallel"
730 # Controls if and how PVCs created by the StatefulSet are deleted. Available in Kubernetes 1.23+.
731 persistentVolumeClaimRetentionPolicy:
737 # Annotations to add to the NetworkPolicy
739 # Configure the 'from' clause of the NetworkPolicy.
740 # By default this will restrict traffic to ports enabled for the Collector. If
741 # you wish to further restrict traffic to other hosts or specific namespaces,
742 # see the standard NetworkPolicy 'spec.ingress.from' definition for more info:
743 # https://kubernetes.io/docs/reference/kubernetes-api/policy-resources/network-policy-v1/
745 # # Allow traffic from any pod in any namespace, but not external hosts
746 # - namespaceSelector: {}
747 # # Allow external access from a specific cidr block
749 # cidr: 192.168.1.64/32
750 # # Allow access from pods in specific namespaces
751 # - namespaceSelector:
753 # - key: kubernetes.io/metadata.name
759 # Add additional ingress rules to specific ports
760 # Useful to allow external hosts/services to access specific ports
761 # An example is allowing an external prometheus server to scrape metrics
763 # See the standard NetworkPolicy 'spec.ingress' definition for more info:
764 # https://kubernetes.io/docs/reference/kubernetes-api/policy-resources/network-policy-v1/
765 extraIngressRules: []
771 # cidr: 192.168.1.64/32
773 # Restrict egress traffic from the OpenTelemetry collector pod
774 # See the standard NetworkPolicy 'spec.egress' definition for more info:
775 # https://kubernetes.io/docs/reference/kubernetes-api/policy-resources/network-policy-v1/
778 # - namespaceSelector: {}
780 # cidr: 192.168.10.10/24
784# Allow containers to share processes across pod namespace
785shareProcessNamespace: false