Advanced Settings for the Cisco AppDynamics Distribution of OpenTelemetry Collector

This page describes the settings that can be passed into the Cisco AppDynamics Distribution of OpenTelemetry Collector Helm chart to configure the Cisco AppDynamics Distribution of OpenTelemetry Collector. For global settings, see Configure AppDynamics Cloud Kubernetes Collectors.

This page contains links to Go, Kubernetes®, and OpenTelemetry™ documentation. Cisco Cloud Observability does not own any rights and assumes no responsibility for the accuracy or completeness of such third-party documentation.

These settings may be added under the appdynamics-otel-collector section of the collectors-values.yaml to set advanced configurations for the OpenTelemetry Collector and OpenTelemetry Pod.

Sample values

appdynamics-otel-collector:
  clientId: "id"
  clientSecretEnvVar:
    valueFrom:
      secretKeyRef:
        name: "oauth-client-secret"
      	key: "secret"
  tokenUrl: "https://token_ur.com/oauth2l"
  endpoint: "https://data.appdynamics.com"

YML

appdynamics-otel-collector

appdynamics-otel-collector defines the configurations for the Cisco AppDynamics Distribution of OpenTelemetry Collector, which is provisioned by the OpenTelemetry Operator.

Name	Type	Description	Required
`clientId`	string	Defines the client ID for authenticating with Cisco Cloud Observability.	Yes
`clientSecret`	string	Defines the secret string in plaintext for authenticating with Cisco Cloud Observability.	No
`clientSecretEnvVar`	object	Defines the secret string in environment variable form for authenticating with Cisco Cloud Observability.	No
`clientSecretVolume`	object	Defines the secret string in mounted volume form for authenticating with Cisco Cloud Observability.	No
`configOverride`	object	Defines configurations for the Cisco AppDynamics Distribution of OpenTelemetry Collector. It will override the default config provided by the Helm chart values. For detailed configurations, see https://opentelemetry.io/docs/collector/configuration/.	No
`enablePrometheus`	boolean	Enables the Prometheus-related deployment. `enablePrometheus` deploys a target allocator and changes the Cisco AppDynamics Distribution of OpenTelemetry Collector `replica` mode to be `statefulset`. When `enableFileLog` and `enablePrometheus` are both set to true, the collectors used for collecting Prometheus metrics will be deployed as an additional StatefulSet along with the default DaemonSet collector. Under this mode, the replica number must be set. For examples, see Configure Kafka and Configure Redis. After you change this setting to `true` or `false`, you must restart your other collectors to see up-to-date entities and metrics on the Observe page.	No
`endpoint`	string	Defines the endpoint the collector sends data to.	Yes
`env`	object	Defines the configuration to override `appdynamics-otel-collector.spec` for a specific OS.	No
`fullnameOverride`	string	Overrides the name label for the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No
`global.clusterId`	string	The UUID of the `kube-system` namespace. Required when one or more of the following conditions are met: `helm lookup` is not supported, such as when using ArgoCD, running `helm template`, or running `helm install --dry-run` `enablePrometheus/selfTelemetry` is set to `true`	No
`nameOverride`	string	Overrides the chart name part of the name label for the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No
`os`	array	Defines the OS type(s) that the Cisco AppDynamics Distribution of OpenTelemetry Collector runs on. Useful when the cluster has mixed OS types.	No
`rbac`	object	Defines the RBAC rules that bind with the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No
`service`	object	Defines the service that is created for the Cisco AppDynamics Distribution of OpenTelemetry Collector receiver. The created service has a constant name which does change with the release name. Be aware that the OpenTelemetry Operator will also create a service for the collector.	No
`serviceAccount`	object	Defines the service account that is created and assigned to the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No
`spec`	object	Defines the desired state of Cisco AppDynamics Distribution of OpenTelemetry Collector. For the full list of settings, see https://github.com/open-telemetry/opentelemetry-operator/blob/v0.61.0/docs/api.md#opentelemetrycollectorspec.	No
`status`	object	Defines the observed state of Cisco AppDynamics Distribution of OpenTelemetry Collector. For the full list of settings, see https://github.com/open-telemetry/opentelemetry-operator/blob/v0.61.0/docs/api.md#opentelemetrycollectorstatus.	No
`tokenUrl`	string	Defines the URL for obtaining an authentication token from Cisco Cloud Observability.	Yes
`traceContextPropagation`	boolean	Enables or disables `traceparent` header propagation for export requests made by the collector. The default value is `true`.	No
`clusterName`	string	Defines the name of the cluster where the collectors and target allocator are deployed. Either `clusterName` or `global.clusterName` must be set when `enablePrometheus` is set to true.	No
`targetAllocatorServiceAccount`	object	Defines the ServiceAccount for the target allocator. This setting should only be enabled when `enablePrometheus` is set to `true`. To disable `targetAllocatorServiceAccount`, set create to `false`.	No
`annotations`	object	Used to add or override annotations.	No
`labels`	object	Used to add or override labels.	No
`enableFileLog`	boolean	Enables or disables the Filelog receiver within Cisco AppDynamics Distribution of OpenTelemetry Collector. When `enableFileLog` and `enablePrometheus` are both set to `true`, the collectors used for collecting Prometheus metrics are deployed as an additional StatefulSet along with the default DaemonSet collector.	No
`filelogReceiverConfig`	object	Defines configurations for the the Filelog receiver.	No
`mode`	object	Defines the spec and configuration override objects for different deployment modes of the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No
`presets`	object	Options for pre-configured features.	No
`customService`	object	Configurations to deploy an additional service that has a configurable name and Kubernetes namespace.	No

appdynamics-otel-collector.clientSecretEnvVar

clientSecretEnvVar defines the secret string in environment variable form for authenticating with Cisco Cloud Observability.

Name	Type	Description	Required
`name`	string	Name of the environment variable. Must be a `C_IDENTIFIER.`	Yes
`value`	string	Variable references (`VARNAME`) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged, which allows for escaping the (VARNAME) syntax. For example: (VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. The default value is "".	No
`valueFrom`	object	Source for the environment variable's value that has the same schema with `appdynamics-otel-collector.spec.env[index].valueFrom`. Cannot be used if value is not empty.	No

appdynamics-otel-collector.clientSecretVolume

appdynamics-otel-collector.clientSecretVolume defines the secret string in mounted volume form for authenticating with Cisco Cloud Observability.

Name	Type	Description	Required
`secretName`	string	The Kubernetes secret name created for authenticating with Cisco Cloud Observability.	Yes
`secretKey`	string	The secret key for authenticating with Cisco Cloud Observability.	No

appdynamics-otel-collector.customService

appdynamics-otel-collector.customService defines configurations for additional services for the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`enable`	boolean	Specifies if the additional service should be deployed. The default is `false`.	No
`name`	string	The service name.	No
`namespace`	string	The Kubernetes namespace for the service.	No

appdynamics-otel-collector.env.linux

appdynamics-otel-collector.env.linux defines the spec and configuration override objects for Linux deployments of the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`spec`	object	Defines the desired state of the Cisco AppDynamics Distribution of OpenTelemetry Collector. For the full list of settings, see https://github.com/open-telemetry/opentelemetry-operator/blob/v0.61.0/docs/api.md#opentelemetrycollectorspec.	No
`configOverride`	object	Defines configurations for the Cisco AppDynamics Distribution of OpenTelemetry Collector. This environment variable will override the default configurations provided by the Helm chart values. For detailed configurations, see https://opentelemetry.io/docs/collector/configuration/.	No
`mode`	object	Defines the spec and configuration override objects for Linux deployments of the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No

appdynamics-otel-collector.env.linux.mode

appdynamics-otel-collector.env.linux.mode defines the spec and configuration override objects for the Linux deployment modes of the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`daemonset`	object	Defines the spec and configuration override objects for the Linux DaemonSet deployment of the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No
`statefulset`	object	Defines the spec and configuration override objects for the Linux StatefulSet deployment of the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No

appdynamics-otel-collector.env.linux.mode.daemonset

appdynamics-otel-collector.env.linux.mode.daemonset defines the spec and configuration override objects for the Linux DaemonSet deployment of theCisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`spec`	object	Defines the desired state of the Cisco AppDynamics Distribution of OpenTelemetry Collector. For the full list of settings, see https://github.com/open-telemetry/opentelemetry-operator/blob/v0.61.0/docs/api.md#opentelemetrycollectorspec.	No
`configOverride`	object	Defines configurations for the Cisco AppDynamics Distribution of OpenTelemetry Collector. This environment variable will override the default configurations provided by the Helm chart values. For detailed configurations, see https://opentelemetry.io/docs/collector/configuration/.	No

appdynamics-otel-collector.env.linux.mode.statefulset

appdynamics-otel-collector.env.linux.mode.statefulset defines the spec and configuration override objects for Linux StatefulSet deployments of the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`spec`	object	Defines the desired state of the Cisco AppDynamics Distribution of OpenTelemetry Collector. For the full list of settings, see https://github.com/open-telemetry/opentelemetry-operator/blob/v0.61.0/docs/api.md#opentelemetrycollectorspec.	No
`configOverride`	object	Defines configurations for the Cisco AppDynamics Distribution of OpenTelemetry Collector. This environment variable will override the default configurations provided by the Helm chart values. For detailed configurations, see https://opentelemetry.io/docs/collector/configuration/.	No

appdynamics-otel-collector.env.windows

appdynamics-otel-collector.env.windows defines the spec and configuration override objects for Windows deployments of the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`spec`	object	Defines the desired state of the Cisco AppDynamics Distribution of OpenTelemetry Collector. For the full list of settings, see https://github.com/open-telemetry/opentelemetry-operator/blob/v0.61.0/docs/api.md#opentelemetrycollectorspec.	No
`configOverride`	object	Defines configurations for the Cisco AppDynamics Distribution of OpenTelemetry Collector. This environment variable will override the default configurations provided by the Helm chart values. For detailed configurations, see https://opentelemetry.io/docs/collector/configuration/.	No
`mode`	object	Defines the spec and configuration override objects for Windows deployments of the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No

appdynamics-otel-collector.env.windows.mode

appdynamics-otel-collector.env.windows.mode defines the spec and configuration override objects for the different Windows deployment modes of the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`daemonset`	object	Defines the spec and configuration override objects for Windows DaemonSet deployments of the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No
`statefulset`	object	Defines the spec and configuration override objects for Windows StatefulSet deployments of the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No

appdynamics-otel-collector.env.windows.mode.daemonset

appdynamics-otel-collector.env.windows.mode.daemonset defines the spec and configuration override objects for Windows DaemonSet deployments of the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`spec`	object	Defines the desired state of the Cisco AppDynamics Distribution of OpenTelemetry Collector. For the full list of settings, see https://github.com/open-telemetry/opentelemetry-operator/blob/v0.61.0/docs/api.md#opentelemetrycollectorspec.	No
`configOverride`	object	Defines configurations for the Cisco AppDynamics Distribution of OpenTelemetry Collector. This environment variable will override the default configurations provided by the Helm chart values. For detailed configurations, see https://opentelemetry.io/docs/collector/configuration/.	No

appdynamics-otel-collector.env.windows.mode.statefulset

appdynamics-otel-collector.env.windows.mode.statefulset defines the spec and configuration override objects for Windows StatefulSet deployments of the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`spec`	object	Defines the desired state of the Cisco AppDynamics Distribution of OpenTelemetry Collector. For the full list of settings, see https://github.com/open-telemetry/opentelemetry-operator/blob/v0.61.0/docs/api.md#opentelemetrycollectorspec.	No
`configOverride`	object	Defines configurations for the Cisco AppDynamics Distribution of OpenTelemetry Collector. This environment variable will override the default configurations provided by the Helm chart values. For detailed configurations, see https://opentelemetry.io/docs/collector/configuration/.	No

appdynamics-otel-collector.filelogReceiverConfig

appdynamics-otel-collector.filelogReceiverConfig defines the configurations for the Filelog receiver and log message parser.

Name	Type	Description	Required
`includeLogsPath`	array	An array of strings. Defines the paths of the log files that the filelog receiver will scrap.	No
`excludeLogsPath`	array	An array of strings. Defines the paths of the log files that the filelog receiver excludes from the log collection.	No
`filelogReceiverConfig`	array	An array of strings. Defines the paths of the log files that the filelog receiver will not scrap.	No
`messageParserPattern`	string	Defines the log message parser pattern.	No
`messageParserType`	string	Defines the log message parser type. Valid values: log4j, logback, json, grok, timestamp, or infra. Whenever `messageParserType` is `json` or `infra`, `messageParserPattern` must be an empty string (`""`) since these two parser types do not require any pattern.	No

appdynamics-otel-collector.mode

appdynamics-otel-collector.mode defines the spec and configuration override objects for the different deployment modes of the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`daemonset`	object	Defines the spec and configuration override objects for DaemonSet deployments of the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No
`statefulset`	object	Defines the spec and configuration override objects for StatefulSet deployments of the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No

appdynamics-otel-collector.mode.daemonset

appdynamics-otel-collector.mode.daemonset defines the spec and configuration override objects for DaemonSet deployments of the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`spec`	object	Defines the desired state of the Cisco AppDynamics Distribution of OpenTelemetry Collector. For the full list of settings, see https://github.com/open-telemetry/opentelemetry-operator/blob/v0.61.0/docs/api.md#opentelemetrycollectorspec.	No
`configOverride`	object	Defines configurations for the Cisco AppDynamics Distribution of OpenTelemetry Collector. This environment variable will override the default configurations provided by the Helm chart values. For detailed configurations, see https://opentelemetry.io/docs/collector/configuration/.	No

appdynamics-otel-collector.mode.statefulset

appdynamics-otel-collector.mode.statefulset defines the spec and configuration override objects for StatefulSet deployments of the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`spec`	object	Defines the desired state of the Cisco AppDynamics Distribution of OpenTelemetry Collector. For the full list of settings, see https://github.com/open-telemetry/opentelemetry-operator/blob/v0.61.0/docs/api.md#opentelemetrycollectorspec.	No
`configOverride`	object	Defines configurations for the Cisco AppDynamics Distribution of OpenTelemetry Collector. This environment variable will override the default configurations provided by the Helm chart values. For detailed configurations, see https://opentelemetry.io/docs/collector/configuration/.	No

appdynamics-otel-collector.presets

appdynamics-otel-collector.presets defines the options for pre-configured features.

Name	Type	Description	Required
`selfTelemetry`	object	Configurations for the self-telemetry data from the Cisco AppDynamics Distribution of OpenTelemetry Collector.	No

appdynamics-otel-collector.presets.selfTelemetry

appdynamics-otel-collector.presets.selfTelemetry defines the options for configuring the self-telemetry data from the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`exporters`	object	Configurations to export the self-telemetry data from the Cisco AppDynamics Distribution of OpenTelemetry Collector to different endpoints. You can add or modify exporters to change the self-telemetry export endpoints. The default value is `otlphttp: {}`, which exports the self-telemetry data to Cisco Cloud Observability.	No

appdynamics-otel-collector.rbac

appdynamics-otel-collector.rbac defines the RBAC rules that bind with the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`create`	string	If set to `true`, a Kubernetes Role is created with the chart name and rules specified below. The Role is bound to the `serviceAccount` defined at `appdynamics-otel-collector.serviceAccount`. The default value is `false`.	No
`rules`	[string]	List of verbs that the created role can access. For details, see https://kubernetes.io/docs/reference/access-authn-authz/authorization/#determine-the-request-verb.	No

appdynamics-otel-collector.service

appdynamics-otel-collector.service defines the service that is created for the Cisco AppDynamics Distribution of OpenTelemetry Collector receiver. The created service has a constant name which does change with the release name. The OpenTelemetry™ Operator also creates a service for the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`name`	string	The name of the service, which is `appdynamics-otel-collector-service`. The service name is used by other Cisco AppDynamics collectors and should not be changed for most use cases. To change the collector service name for receiving OTLP data from the agents, configure `appdynamics-otel-collector.customService` to deploy an additional service that has a configurable name.	Yes
`ports`	[object]	The ports of the service. This setting has the same schema as `appdynamics-otel-collector.spec.ports[index]`. By default, 4317 for grpc and 4318 for HTTP are configured.	No
`type`	string	Type of the service. By default, the cluster IP is used.	Yes

appdynamics-otel-collector.serviceAccount

appdynamics-otel-collector.serviceAccount defines the service account that is created and assigned to the Cisco AppDynamics Distribution of OpenTelemetry Collector.

Name	Type	Description	Required
`annotations`	map[string]string	Annotations associated with the service account.	No
`create`	boolean	If set to `true`, a Kubernetes Service Account will be created for the collector.	No
`imagePullSecrets`	[object]	Associated with the service account. For details, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/.	No
`name`	string	The name of the service account. The default value is the full name of the chart, which includes the release name and chart name.	No

appdynamics-otel-collector.serviceAccount.imagePullSecrets[index]

appdynamics-otel-collector.serviceAccount.imagePullSecrets[index] contains an array of secret names for authenticating with the private Docker registry.

Name	Type	Description	Required
`name`	string	The secret name for authenticating with private docker registry to pull the image.	Yes

appdynamics-otel-collector.targetAllocatorServiceAccount

appdynamics-otel-collector.targetAllocatorServiceAccount defines the service account that is created and assigned to the target allocator.

Name	Type	Description	Required
`annotations`	map[string]string	Annotations associated with the service account.	No
`create`	boolean	If set to `true`, a Kubernetes Service Account will be created for the target allocator.	No
`imagePullSecrets`	[object]	Associated with the service account. For details, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/.	No
`name`	string	The name of the service account. The default value is the full name of the chart with the suffix `-target-allocator`.	No

appdynamics-otel-collector.targetAllocatorServiceAccount.imagePullSecrets[index]

appdynamics-otel-collector.targetAllocatorServiceAccount.imagePullSecrets[index] defines an array of secret names for authenticating with the private Docker registry to pull the target allocator image.

Name	Type	Description	Required
`name`	string	The secret name for authenticating with the private Docker registry to pull the image.	Yes

OpenTelemetry™ and Kubernetes® (as applicable) are trademarks of The Linux Foundation®.