Skip to content

Document container and cloud metadata #2606

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mariomac merged 2 commits into from
Mar 13, 2026
Merged

Document container and cloud metadata #2606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7564f7
Document container and cloud metadata
mariomac Mar 13, 2026
bf1945e
try make vale happy
mariomac Mar 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/sources/configure/service-discovery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ You can override the service name, namespace, and other configurations per servi
| `open_ports` | Selects the process to instrument by the port it has open (listens to). Refer to [open ports](#open-ports). | string | (unset) |
| `exe_path` | Selects the processes to instrument by their executable name path. Refer to [executable path](#executable-path). | string (glob) | (unset) |
| `containers_only` | Selects processes to instrument which are running in an OCI container. Refer to [containers only](#containers-only). | boolean | false |
| `container_name` | Filter services by OCI container name. Refer to [Container name](#container-name). | string (glob) | (unset) |
| `k8s_namespace` | Filter services by Kubernetes namespace. Refer to [K8s namespace](#k8s-namespace). | string (glob) | (unset) |
| `k8s_pod_name` | Filter services by Kubernetes Pod. Refer to [K8s Pod name](#k8s-pod-name). | string (glob) | (unset) |
| `k8s_deployment_name` | Filter services by Kubernetes Deployment. Refer to [K8s deployment name](#k8s-deployment-name). | string (glob) | (unset) |
Expand Down Expand Up @@ -103,6 +104,23 @@ Selects processes to instrument which are running in an OCI container. To perfor

If you specify other selectors in the same `instrument` entry, the processes must match all the selector properties.

### Container name

This selector property limits the instrumentation to the applications running in OCI containers (such as Docker) with a name matching the provided glob pattern.

For example:

```yaml
discovery:
instrument:
- container_name: "*testserver*"
- container_name: "my-app-*"
```

This example discovers all processes running in containers whose names contain `testserver` or start with `my-app-`.

If you specify other selectors in the same `instrument` entry, the processes must match all the selector properties.

### K8s namespace

This selector property limits the instrumentation to the applications running in the Kubernetes Namespaces with a name matching the provided glob.
Expand Down
17 changes: 17 additions & 0 deletions docs/sources/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,10 @@ For more information about the OpenTelemetry semantic conventions for each metri
- [Messaging metrics conventions](https://opentelemetry.io/docs/specs/semconv/messaging/messaging-metrics/)
- [Process metrics conventions](https://opentelemetry.io/docs/specs/semconv/system/process-metrics/)
- [Kubernetes resource conventions](https://opentelemetry.io/docs/specs/semconv/resource/k8s/)
- [Container resource conventions](https://opentelemetry.io/docs/specs/semconv/resource/container/)
- [Host resource conventions](https://opentelemetry.io/docs/specs/semconv/resource/host/)
- [Cloud resource conventions](https://opentelemetry.io/docs/specs/semconv/resource/cloud/)
- [Cloud provider specific conventions](https://opentelemetry.io/docs/specs/semconv/resource/cloud-provider/)

| Metrics | Name | Default |
|--------------------------------|------------------------------|---------------------------------------------------|
Expand All @@ -72,6 +76,19 @@ For more information about the OpenTelemetry semantic conventions for each metri
| Application (all) | `k8s.replicaset.name` | shown if Kubernetes metadata is enabled |
| Application (all) | `k8s.statefulset.name` | shown if Kubernetes metadata is enabled |
| Application (all) | `k8s.cluster.name` | shown if Kubernetes metadata is enabled |
| Application (all) | `container.id` | shown if Docker metadata is enabled |
| Application (all) | `container.name` | shown if Docker metadata is enabled |
| Application (all) | `cloud.provider` | shown if cloud metadata is enabled |
| Application (all) | `cloud.platform` | shown if cloud metadata is enabled |
| Application (all) | `cloud.region` | shown if cloud metadata is enabled |
| Application (all) | `cloud.account.id` | shown if cloud metadata is enabled |
| Application (all) | `cloud.availability_zone` | shown if cloud metadata is enabled |
| Application (all) | `cloud.resource_id` | shown if cloud metadata is enabled (Azure only) |
| Application (all) | `host.id` | shown if cloud metadata is enabled |
| Application (all) | `host.type` | shown if cloud metadata is enabled |
| Application (all) | `host.image.id` | shown if cloud metadata is enabled (AWS only) |
| Application (all) | `gcp.gce.instance.name` | shown if cloud metadata is enabled (GCP only) |
| Application (all) | `gcp.gce.instance.hostname` | shown if cloud metadata is enabled (GCP only) |
| Application (all) | `service.name` | shown |
| Application (all) | `service.namespace` | shown |
| Application (all) | `target.instance` | shown |
Expand Down
Loading