Skip to content

Commit

Permalink
pr feedback: Disable cluster name by default. Misc spelling / wording.
Browse files Browse the repository at this point in the history
  • Loading branch information
jsirianni committed Dec 18, 2023
1 parent 1e95ba3 commit 030bdc1
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
24 changes: 22 additions & 2 deletions processor/resourcedetectionprocessor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -412,11 +412,31 @@ processors:

#### Cluster Name

Cluster name detection is disabled by default, and can be enabled with the
following configuration:

```yaml
processors:
resourcedetection/aks:
detectors: [aks]
timeout: 2s
override: false
aks:
resource_attributes:
k8s.cluster.name: true
```

Azure AKS cluster name is derived from the Azure Instance Metadata Service's (IMDS) infrastructure resource group field. This field contains the resource group and name of the cluster, separated by underscores. e.g: `MC_<resource group>_<cluster name>_<location>`.

The cluster name is accurately detected if underscores are not present in the resource group name or the cluster name.
Example:
- Resource group: my-resource-group
- Cluster name: my-cluster
- Location: eastus
- Generated name: MC_my-resource-group_my-cluster_eastus

The cluster name is detected if it does not contain underscores and if a custom infrastructure resource group name was not used.

If accurate parsing cannot be performed, the infrastructure resource group value is returned. This value can be used to accurately identify the cluster, as Azure will not allow users to create multiple clusters with the same infrastructure resource group.
If accurate parsing cannot be performed, the infrastructure resource group value is returned. This value can be used to uniquely identify the cluster, as Azure will not allow users to create multiple clusters with the same infrastructure resource group name.

### Consul

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ resource_attributes:
k8s.cluster.name:
description: The k8s.cluster.name parsed from the Azure Instance Metadata Service's infrastructure resource group field
type: string
enabled: true
enabled: false

0 comments on commit 030bdc1

Please sign in to comment.