-
Notifications
You must be signed in to change notification settings - Fork 932
Add semantic conventions for more Kubernetes objects #732
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.
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
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,134 @@ | ||
| # Kubernetes | ||
|
|
||
| **type:** `k8s` | ||
| Useful resources to understand Kubernetes objects and metadata: | ||
|
|
||
| **Description:** A Kubernetes resource. | ||
| * [Namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) | ||
| * [Names and UIDs](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/). | ||
| * [Pods](https://kubernetes.io/docs/concepts/workloads/pods/) | ||
| * [Controllers](https://kubernetes.io/docs/concepts/workloads/controllers/) | ||
|
|
||
| The "name" of a Kubernetes object is unique for that type of object within a | ||
| "namespace" and only at a specific moment of time (names can be reused over | ||
| time). The "uid" is unique across your whole cluster, and very likely across | ||
| time. Because of this it is recommended to always set the UID for every | ||
| Kubernetes object, but "name" is usually more user friendly so can be also set. | ||
|
|
||
| ## Cluster | ||
|
|
||
| **type:** `k8s.cluster` | ||
|
|
||
| **Description:** A Kubernetes Cluster. | ||
|
|
||
| | Attribute | Description | Example | | ||
| |---|---|---| | ||
| | k8s.cluster.name | The name of the cluster. | `opentelemetry-cluster` | | ||
|
|
||
| ## Namespace | ||
|
|
||
| Namespaces provide a scope for names. Names of objects need to be unique within | ||
| a namespace, but not across namespaces. | ||
|
|
||
| **type:** `k8s.namespace` | ||
|
|
||
| **Description:** A Kubernetes Namespace. | ||
|
|
||
| | Attribute | Description | Example | | ||
| |---|---|---| | ||
| | k8s.cluster.name | The name of the cluster that the pod is running in. | `opentelemetry-cluster` | | ||
| | k8s.namespace.name | The name of the namespace that the pod is running in. | `default` | | ||
| | k8s.pod.name | The name of the pod. | `opentelemetry-pod-autoconf` | | ||
| | k8s.deployment.name | The name of the deployment. | `opentelemetry` | | ||
|
|
||
| ## Pod | ||
|
|
||
| The smallest and simplest Kubernetes object. A Pod represents a set of running | ||
| containers on your cluster. | ||
|
|
||
| **type:** `k8s.pod` | ||
|
|
||
| **Description:** A Kubernetes Pod object. | ||
|
|
||
| | Attribute | Description | Example | | ||
| |---|---|---| | ||
| | k8s.pod.uid | The uid of the Pod. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | | ||
| | k8s.pod.name | The name of the Pod. | `opentelemetry-pod-autoconf` | | ||
|
|
||
| ## ReplicaSet | ||
|
|
||
| A ReplicaSet’s purpose is to maintain a stable set of replica Pods running at | ||
| any given time. | ||
|
|
||
| **type:** `k8s.replicaset` | ||
|
|
||
| **Description:** A Kubernetes ReplicaSet object. | ||
|
|
||
| | Attribute | Description | Example | | ||
| |---|---|---| | ||
| | k8s.replicaset.uid | The uid of the ReplicaSet. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | | ||
| | k8s.replicaset.name | The name of the ReplicaSet. | `opentelemetry` | | ||
|
|
||
| ## Deployment | ||
|
|
||
| An API object that manages a replicated application, typically by running Pods | ||
| with no local state. Each replica is represented by a Pod, and the Pods are | ||
| distributed among the nodes of a cluster. | ||
|
|
||
| **type:** `k8s.deployment` | ||
|
|
||
| **Description:** A Kubernetes Deployment object. | ||
|
|
||
| | Attribute | Description | Example | | ||
| |---|---|---| | ||
| | k8s.deployment.uid | The uid of the Deployment. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | | ||
| | k8s.deployment.name | The name of the Deployment. | `opentelemetry` | | ||
|
|
||
| ## StatefulSet | ||
|
|
||
| Manages the deployment and scaling of a set of Pods, and provides guarantees | ||
| about the ordering and uniqueness of these Pods. | ||
|
|
||
| **type:** `k8s.statefulset` | ||
|
|
||
| **Description:** A Kubernetes StatefulSet object. | ||
|
|
||
| | Attribute | Description | Example | | ||
| |---|---|---| | ||
| | k8s.statefulset.uid | The uid of the StatefulSet. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | | ||
| | k8s.statefulset.name | The name of the StatefulSet. | `opentelemetry` | | ||
|
|
||
| ## DaemonSet | ||
|
|
||
| A DaemonSet ensures that all (or some) Nodes run a copy of a Pod. | ||
|
|
||
| **type:** `k8s.daemonset` | ||
|
|
||
| **Description:** A Kubernetes DaemonSet object. | ||
|
|
||
| | Attribute | Description | Example | | ||
| |---|---|---| | ||
| | k8s.daemonset.uid | The uid of the DaemonSet. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | | ||
| | k8s.daemonset.name | The name of the DaemonSet. | `opentelemetry` | | ||
|
|
||
| ## Job | ||
|
|
||
| A Job creates one or more Pods and ensures that a specified number of them | ||
| successfully terminate. | ||
|
|
||
| **type:** `k8s.job` | ||
|
|
||
| **Description:** A Kubernetes Job object. | ||
|
|
||
| | Attribute | Description | Example | | ||
| |---|---|---| | ||
| | k8s.job.uid | The uid of the Job. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | | ||
| | k8s.job.name | The name of the Job. | `opentelemetry` | | ||
|
|
||
| ## CronJob | ||
|
|
||
| A CronJob creates Jobs on a repeating schedule. | ||
|
|
||
| **type:** `k8s.cronjob` | ||
|
|
||
| **Description:** A Kubernetes CronJob object. | ||
|
|
||
| | Attribute | Description | Example | | ||
| |---|---|---| | ||
| | k8s.cronjob.uid | The uid of the CronJob. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | | ||
| | k8s.cronjob.name | The name of the CronJob. | `opentelemetry` | | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.