Skip to content

Commit

Permalink
Update K8s documentation with the daemonset/replicaset/statefulset se…
Browse files Browse the repository at this point in the history
…lectors and labels
  • Loading branch information
mariomac committed Jan 25, 2024
1 parent 959bc86 commit 128b51e
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 4 deletions.
46 changes: 42 additions & 4 deletions docs/sources/configure/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ selected need to match all the selector properties.
| --------------- | ------- | --------------------------- | ------- |
| `k8s_namespace` | -- | string (regular expression) | (unset) |

This selector property will limit the instrumentation to the services
This selector property will limit the instrumentation to the applications
running in the Kubernetes Namespaces with a name matching the provided regular
expression.

Expand All @@ -332,7 +332,7 @@ selected need to match all the selector properties.
| -------------- | ------- | --------------------------- | ------- |
| `k8s_pod_name` | -- | string (regular expression) | (unset) |

This selector property will limit the instrumentation to the services
This selector property will limit the instrumentation to the applications
running in the Kubernetes Pods with a name matching the provided regular
expression.

Expand All @@ -343,7 +343,7 @@ selected need to match all the selector properties.
| --------------------- | ------- | --------------------------- | ------- |
| `k8s_deployment_name` | -- | string (regular expression) | (unset) |

This selector property will limit the instrumentation to the services
This selector property will limit the instrumentation to the applications
running in the Kubernetes Deployments with a name matching the provided regular
expression.

Expand All @@ -354,13 +354,48 @@ selected need to match all the selector properties.
| --------------------- | ------- | --------------------------- | ------- |
| `k8s_replicaset_name` | -- | string (regular expression) | (unset) |

This selector property will limit the instrumentation to the services
This selector property will limit the instrumentation to the applications
running in the Kubernetes ReplicaSets with a name matching the provided regular
expression.

If other selectors are specified in the same `services` entry, the processes to be
selected need to match all the selector properties.

| YAML | Env var | Type | Default |
|------------------------| ------- | --------------------------- | ------- |
| `k8s_statefulset_name` | -- | string (regular expression) | (unset) |

This selector property will limit the instrumentation to the applications
running in the Kubernetes StatefulSets with a name matching the provided regular
expression.

If other selectors are specified in the same `services` entry, the processes to be
selected need to match all the selector properties.

| YAML | Env var | Type | Default |
|----------------------| ------- | --------------------------- | ------- |
| `k8s_daemonset_name` | -- | string (regular expression) | (unset) |

This selector property will limit the instrumentation to the applications
running in the Kubernetes DaemonSet with a name matching the provided regular
expression.

If other selectors are specified in the same `services` entry, the processes to be
selected need to match all the selector properties.

| YAML | Env var | Type | Default |
|------------------| ------- | --------------------------- | ------- |
| `k8s_owner_name` | -- | string (regular expression) | (unset) |

This selector property will limit the instrumentation to the applications
running in the Pods having owned by either a `Deployment`, `ReplicaSet`,
`DaemonSet` or `StatefulSet` with a name matching the provided regular
expression.

If other selectors are specified in the same `services` entry, the processes to be
selected need to match all the selector properties.


## EBPF tracer

YAML section `ebpf`.
Expand Down Expand Up @@ -446,6 +481,9 @@ and metrics with the Standard OpenTelemetry labels:

- `k8s.namespace.name`
- `k8s.deployment.name`
- `k8s.statefulset.name`
- `k8s.replicaset.name`
- `k8s.daemonset.name`
- `k8s.node.name`
- `k8s.pod.name`
- `k8s.pod.uid`
Expand Down
3 changes: 3 additions & 0 deletions docs/sources/setup/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ Beyla can decorate your traces with the following Kubernetes labels:

- `k8s.namespace.name`
- `k8s.deployment.name`
- `k8s.statefulset.name`
- `k8s.replicaset.name`
- `k8s.daemonset.name`
- `k8s.node.name`
- `k8s.pod.name`
- `k8s.pod.uid`
Expand Down

0 comments on commit 128b51e

Please sign in to comment.