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

Propose a new K8s SemConv SIG project #2352

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

ChrsMark
Copy link
Member

The Opentelemetry community would like to work on K8s Semantic Conventions in order to add any missing attributes and/or metrics and stabilize the existing ones. The primary goal of this is to help with the adoption of the respective OTel Collector receivers and processors.

TODOS:

  1. Expand the list of domain experts
  2. Define meeting time
  3. Create the slack channel, agenda doc, calendar event, project board

@ChrsMark
Copy link
Member Author

Pinging relevant people here. Please explicitly ask for being included in the domain experts list if you are not already.

/cc @open-telemetry/semconv-k8s-approvers @open-telemetry/semconv-container-approvers @TylerHelmuth @dmitryax @dashpole @jinja2 @frzifus @mx-psi @povilasv @jamesmoessis @AlexanderWert @rogercoll @braydonk @jsuereth

Feel free to advertise this and/or proposing people for joining this project.

@rogercoll
Copy link
Contributor

Thanks for pushing this SIG @ChrsMark ! I think it is really needed to standardize all the k8s and container metrics, which should help with the alignment between the different collector's related receivers (kubeletstats, dockerstats, podmanstats, etc.)

I would gladly join the SIG and share my domain expertise, specially in the containers area.

@braydonk
Copy link

I support the new SIG! I don't have enough expertise in the general k8s area to join, but will spread the word with some more knowledgeable folks to see who would be interested.

@jaronoff97
Copy link

As a maintainer of the operator and helm charts, id love to be added to this effort. It would be great if we could improve and standardize more in the k8s world.

@gyliu513
Copy link
Member

Thanks @ChrsMark , happy to see this proposal, can we extend this SIG a little bit to cover k8s cost as well by https://github.com/opencost?

@ChrsMark
Copy link
Member Author

Thank's for the suggestion @gyliu513!
This SIG will initially focus on the k8s.* (and a bit of container.*) namespace. The primary focus is to stabilize the basic resource attributes and metrics which are already widely used by the Collector. Then of course we can examine additional semantic conventions.

@gyliu513 do you have specific semantic conventions in mind that you would like to introduce? If so, you can always propose them with an issue and it could be added in the SIG's backlog.

* [k8s: add metric for pod status conditions](https://github.com/open-telemetry/semantic-conventions/issues/1398)
* [Proposal: Define mapping from k8s well-known labels to semconv](https://github.com/open-telemetry/semantic-conventions/issues/236)
* [k8s: new attributes: CSI driver and volume handle](https://github.com/open-telemetry/semantic-conventions/issues/1119)
* TBA
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few things you'll need to work w/ Entities/Semconv group on ->

(1) Should type on resource semconv have all identifying attributes or locally identifying attributes.

E.g. k8s.namespace today only contains k8s.namespace.name. How does the interact with k8s.pod type? Do I always put both when I can?

(2) Discovery of these attributes (locally and externally) (a.k.a. multi-observer problem). I'd like if each of the resources (and attributes) had some description in the markdown for how they can be discovered BOTH inside an SDK and externally (e.g. via collector).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can note them down on a SemConv issue, right? I will create one.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also note this one which was closed from inactivity but still remains problematic

@dmitryax
Copy link
Member

dmitryax commented Sep 19, 2024

Thanks for starting the SIG! I'm happy to help with this effort

Signed-off-by: ChrsMark <[email protected]>
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

Successfully merging this pull request may close these issues.

7 participants