Skip to content

container: add CSI attributes #1337

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
lmolkova merged 21 commits into from
Sep 20, 2024
Merged

container: add CSI attributes #1337

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
1df3be8
k8s: add CSI driver attributes
gdvalle Aug 16, 2024
b27dfa5
Update model/registry/k8s.yaml
gdvalle Aug 21, 2024
2069ea8
Update model/registry/k8s.yaml
gdvalle Aug 21, 2024
c352b3d
put CSI into its own component, ref from k8s
gdvalle Aug 30, 2024
2530d8c
Merge remote-tracking branch 'origin/main' into gtd.csi
gdvalle Aug 30, 2024
9707599
remove csi from k8s, doesn't go here
gdvalle Sep 4, 2024
5e86006
make fix generate-gh-issue-templates
gdvalle Sep 4, 2024
a0b2262
remove k8s attr bits from changelog
gdvalle Sep 4, 2024
75a4570
clarify this is a new component
gdvalle Sep 4, 2024
62ce92d
simplify changelog note
gdvalle Sep 4, 2024
67a2e1d
Add CSI to acronyms
gdvalle Sep 4, 2024
05434b2
Csi->CSI
gdvalle Sep 4, 2024
da3edad
manually fix sort order
gdvalle Sep 4, 2024
ab50427
Merge branch 'main' into gtd.csi
joaopgrassi Sep 5, 2024
ce7a5e8
Merge remote-tracking branch 'origin/main' into gtd.csi
gdvalle Sep 18, 2024
ba336ad
move csi attrs underneath container registry
gdvalle Sep 18, 2024
08daa79
make
gdvalle Sep 18, 2024
90150cf
link to CSI spec
gdvalle Sep 20, 2024
cefc652
remove erroneous generated file
gdvalle Sep 20, 2024
1e24818
link in both attrs, run make
gdvalle Sep 20, 2024
f3e5175
Merge remote-tracking branch 'origin/main' into gtd.csi
gdvalle Sep 20, 2024
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
5 changes: 5 additions & 0 deletions .chloggen/add_k8s_csi_attributes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
change_type: enhancement
component: k8s
note: Add `csi.driver` and `csi.volume.handle` attributes.
issues: [1119]
subtext:
10 changes: 8 additions & 2 deletions docs/attributes-registry/k8s.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@ Kubernetes resource attributes.

| Attribute | Type | Description | Examples | Stability |
| --------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `csi.driver` | string | The name of the CSI driver used by the volume. [1] | `pd.csi.storage.gke.io` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `csi.volume.handle` | string | The unique volume name returned by the CSI volume plugin's CreateVolume. [2] | `projects/my-gcp-project/zones/my-gcp-zone/disks/my-gcp-disk` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `k8s.cluster.name` | string | The name of the cluster. | `opentelemetry-cluster` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `k8s.cluster.uid` | string | A pseudo-ID for the cluster, set to the UID of the `kube-system` namespace. [1] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `k8s.cluster.uid` | string | A pseudo-ID for the cluster, set to the UID of the `kube-system` namespace. [3] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `k8s.container.name` | string | The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (`container.name`). | `redis` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `k8s.container.restart_count` | int | Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec. | | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `k8s.container.status.last_terminated_reason` | string | Last terminated reason of the Container. | `Evicted`; `Error` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
Expand All @@ -42,7 +44,11 @@ Kubernetes resource attributes.
| `k8s.volume.name` | string | The name of the K8s volume. | `volume0` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `k8s.volume.type` | string | The type of the K8s volume. | `emptyDir`; `persistentVolumeClaim` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[1]:** K8s doesn't have support for obtaining a cluster ID. If this is ever
**[1]:** This maps 1:1 to [CSIPersistentVolumeSource.driver](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#csipersistentvolumesource-v1-core).

**[2]:** This maps 1:1 to [CSIPersistentVolumeSource.volumeHandle](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#csipersistentvolumesource-v1-core).

**[3]:** K8s doesn't have support for obtaining a cluster ID. If this is ever
added, we will recommend collecting the `k8s.cluster.uid` through the
official APIs. In the meantime, we are able to use the `uid` of the
`kube-system` namespace as a proxy for cluster ID. Read on for the
Expand Down
18 changes: 18 additions & 0 deletions model/registry/k8s.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,3 +214,21 @@ groups:
value: 'local'
brief: "A [local](https://v1-29.docs.kubernetes.io/docs/concepts/storage/volumes/#local) volume"
stability: experimental
- id: csi.driver
type: string
stability: experimental
brief: >
The name of the CSI driver used by the volume.
note: >
This maps 1:1 to [CSIPersistentVolumeSource.driver](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#csipersistentvolumesource-v1-core).
examples:
- "pd.csi.storage.gke.io"
- id: csi.volume.handle
type: string
stability: experimental
brief: >
The unique volume name returned by the CSI volume plugin's CreateVolume.
note: >
This maps 1:1 to [CSIPersistentVolumeSource.volumeHandle](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.30/#csipersistentvolumesource-v1-core).
examples:
- "projects/my-gcp-project/zones/my-gcp-zone/disks/my-gcp-disk"