From e31ed0fdce4677cb84ac4205388be477e9c6cdca Mon Sep 17 00:00:00 2001 From: Christos Markou Date: Wed, 14 Aug 2024 19:05:32 +0530 Subject: [PATCH] Add k8s.volume.{name,type} attributes (#1251) Signed-off-by: ChrsMark --- .chloggen/add_k8s_volume_type.yaml | 22 ++++++++++++++++++ docs/attributes-registry/k8s.md | 13 +++++++++++ model/registry/k8s.yaml | 37 ++++++++++++++++++++++++++++++ 3 files changed, 72 insertions(+) create mode 100755 .chloggen/add_k8s_volume_type.yaml diff --git a/.chloggen/add_k8s_volume_type.yaml b/.chloggen/add_k8s_volume_type.yaml new file mode 100755 index 0000000000..c9be5f9027 --- /dev/null +++ b/.chloggen/add_k8s_volume_type.yaml @@ -0,0 +1,22 @@ +# Use this changelog template to create an entry for release notes. +# +# If your change doesn't affect end users you should instead start +# your pull request title with [chore] or use the "Skip Changelog" label. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: enhancement + +# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) +component: k8s + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Adds `k8s.volume.name` and `k8s.volume.type` attributes to the registry + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +# The values here must be integers. +issues: [1164] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: diff --git a/docs/attributes-registry/k8s.md b/docs/attributes-registry/k8s.md index 34d2e64c88..6f4bf8cafe 100644 --- a/docs/attributes-registry/k8s.md +++ b/docs/attributes-registry/k8s.md @@ -39,6 +39,8 @@ Kubernetes resource attributes. | `k8s.replicaset.uid` | string | The UID of the ReplicaSet. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `k8s.statefulset.name` | string | The name of the StatefulSet. | `opentelemetry` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `k8s.statefulset.uid` | string | The UID of the StatefulSet. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `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 added, we will recommend collecting the `k8s.cluster.uid` through the @@ -63,6 +65,17 @@ Which states: Therefore, UIDs between clusters should be extremely unlikely to conflict. +`k8s.volume.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. + +| Value | Description | Stability | +| ----------------------- | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | +| `configMap` | A [configMap](https://v1-29.docs.kubernetes.io/docs/concepts/storage/volumes/#configmap) volume | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `downwardAPI` | A [downwardAPI](https://v1-29.docs.kubernetes.io/docs/concepts/storage/volumes/#downwardapi) volume | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `emptyDir` | An [emptyDir](https://v1-29.docs.kubernetes.io/docs/concepts/storage/volumes/#emptydir) volume | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `local` | A [local](https://v1-29.docs.kubernetes.io/docs/concepts/storage/volumes/#local) volume | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `persistentVolumeClaim` | A [persistentVolumeClaim](https://v1-29.docs.kubernetes.io/docs/concepts/storage/volumes/#persistentvolumeclaim) volume | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `secret` | A [secret](https://v1-29.docs.kubernetes.io/docs/concepts/storage/volumes/#secret) volume | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + ## Deprecated Kubernetes Attributes Describes deprecated k8s attributes. diff --git a/model/registry/k8s.yaml b/model/registry/k8s.yaml index 42da6ab238..6767f3575e 100644 --- a/model/registry/k8s.yaml +++ b/model/registry/k8s.yaml @@ -177,3 +177,40 @@ groups: brief: > The name of the CronJob. examples: ['opentelemetry'] + - id: k8s.volume.name + type: string + stability: experimental + brief: > + The name of the K8s volume. + examples: [ 'volume0' ] + - id: k8s.volume.type + stability: experimental + brief: > + The type of the K8s volume. + examples: [ "emptyDir", "persistentVolumeClaim" ] + type: + members: + - id: persistent_volume_claim + value: 'persistentVolumeClaim' + brief: "A [persistentVolumeClaim](https://v1-29.docs.kubernetes.io/docs/concepts/storage/volumes/#persistentvolumeclaim) volume" + stability: experimental + - id: config_map + value: 'configMap' + brief: "A [configMap](https://v1-29.docs.kubernetes.io/docs/concepts/storage/volumes/#configmap) volume" + stability: experimental + - id: downward_api + value: 'downwardAPI' + brief: "A [downwardAPI](https://v1-29.docs.kubernetes.io/docs/concepts/storage/volumes/#downwardapi) volume" + stability: experimental + - id: empty_dir + value: 'emptyDir' + brief: "An [emptyDir](https://v1-29.docs.kubernetes.io/docs/concepts/storage/volumes/#emptydir) volume" + stability: experimental + - id: secret + value: 'secret' + brief: "A [secret](https://v1-29.docs.kubernetes.io/docs/concepts/storage/volumes/#secret) volume" + stability: experimental + - id: local + value: 'local' + brief: "A [local](https://v1-29.docs.kubernetes.io/docs/concepts/storage/volumes/#local) volume" + stability: experimental