Considerations
Before enabling add cluster info, please note the following:
- This action is meant to be used for static attributes that are known in advanced. It is not suitable for dynamic attributes that need to be extracted from an API or calculated at runtime.
- Some destinations may require specific configuration to index resource attributes and make them available for querying. Please refer to the documentation of the destination you are using for more information.
- If the attribute already exists in the telemetry signal, the value will be overwritten by the value provided in the action.
- An empty string is a valid value for the
attributeStringValue
field
Configuration Options
The AddClusterInfo action is configured using theodigos.io/v1alpha1.Action
CRD with the addClusterInfo
configuration section.
actionName
actionName
actionName
string
: Allows you to attach a meaningful name to the action for convenience.- This field is optional
- Odigos does not use or assume any meaning from this field
notes
notes
notes
string
: Allows you to attach notes regarding the action for convenience.- This field is optional
- Odigos does not use or assume any meaning from this field
disabled
disabled
disabled
boolean
: Allows you to temporarily disable the action, but keep it saved for future use.- This field is optional, and defaults to
false
signals *
signals *
signals
string[]
: An array with the signals that the action will operate on.- This field is required
- Supported values:
TRACES
,METRICS
,LOGS
addClusterInfo *
addClusterInfo *
addClusterInfo
object
: Configuration for the AddClusterInfo action.- This field is required for this action type
clusterAttributes *
clusterAttributes *
clusterAttributes
object[]
: An array of attributes to be added to the telemetry signals.- This field is required
attributeName *
attributeName *
attributeName
string
: The name of the attribute to be added to the telemetry signals.- This field is required
attributeStringValue *
attributeStringValue *
attributeStringValue
string
: The value of the attribute to be added to the telemetry signals.- This field is required
overwriteExistingValues
overwriteExistingValues
overwriteExistingValues
boolean
: Whether to overwrite existing attribute values.- This field is optional, and defaults to
false
team.name
etc.
We recommend:
k8s.cluster.name
: The name of the k8s cluster which can be useful to distinguish between different clusters.deployment.environment
: The environment of the cluster (e.g.production
,staging
,development
, etc).
Basic Example
The following example demonstrates how to insert thek8s.cluster.name
attribute to all telemetry signals using the new Action CRD.
1
Create a YAML file with the following content:
insert-cluster-name.yaml
2
Apply the action to the cluster: