Skip to content
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

Remove abbreviation of kubernetes in resource semantic conventions #58

Closed
mlunadia opened this issue May 26, 2023 · 4 comments
Closed
Assignees

Comments

@mlunadia
Copy link
Contributor

mlunadia commented May 26, 2023

The current specification for kubernetes resources is k8s.*

While k8s is a popular abbreviation within the Kubernetes community, using the full name kubernetes is preferable in most situations to ensure clear communication and alignment with standard practices.

There is a lot of scope to expand into further fields for semantic conventions for kubernetes and whilst there are a few fields it may be practical to consider removing the abbreviation given the below reasons:

  1. Clarity: Using "Kubernetes" ensures clarity and avoids confusion compared to the abbreviation "k8s" which not everybody might be familiar with.
  2. Standard Terminology: "Kubernetes" is the recognized and widely used name for the platform.
  3. Consistency: Using "Kubernetes" maintains consistency in discussions and documentation.
  4. Searchability: "Kubernetes" yields more accurate search results when seeking information.
  5. Professionalism: Using the full name demonstrates professionalism and adherence to standards.
@ChrsMark
Copy link
Member

FYI, if we decide to replace k8s with kubernetes it would need a transition plan on the collector's side as well: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/kubeletstatsreceiver/documentation.md

@TylerHelmuth
Copy link
Member

This would be an incredibly impactful change. If we were to move forward with something like this we will need a plan as robust as the ECS http change.

I do also want to callout that this is not the naming standard in use by KubeStateMetrics, which uses kube: https://github.com/kubernetes/kube-state-metrics/blob/main/docs/pod-metrics.md.

@austinlparker
Copy link
Member

k8s is an accepted abbreviation of kubernetes, with wide usage inside the community (for example, the Kubernetes package registry is registry.k8s.io, among other examples). I do not see value in pursuing a massively breaking change throughout semantic conventions when the likelihood of k8s ever causing a collision with another convention is extremely low.

@mlunadia
Copy link
Contributor Author

Thank you all for the input, and fair comments. Agree that either is acceptable.
Closing this issue to convey agreement on k8s

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants