Skip to content

Commit

Permalink
Propose a new K8s SemConv SIG
Browse files Browse the repository at this point in the history
Signed-off-by: ChrsMark <[email protected]>
  • Loading branch information
ChrsMark committed Sep 18, 2024
1 parent c1d2a61 commit dedc5fb
Showing 1 changed file with 88 additions and 0 deletions.
88 changes: 88 additions & 0 deletions projects/k8s-semconv.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# K8s Conventions Working Group

## Description

Kubernetes is the leading platform for Opentelemetry Collector deployment (80.6%) according
to a recent [survey](https://opentelemetry.io/blog/2024/otel-collector-survey/#otel-components-usage).
The OpenTelemetry community would like to stabilize k8s semantic conventions including k8s/container metrics
in order to help the adoption of the respective OTel Collector receivers and processors.
The goal of this SIG project is to work towards this direction.

Project Board: TBA

## Roadmap

* [META: Define Semantic Conventions for k8s metrics](https://github.com/open-telemetry/semantic-conventions/issues/1032)
* [Clarify the brief of container.image.id](https://github.com/open-telemetry/semantic-conventions/issues/1236)
* [Define rules for Kubernetes name and uid resource attributes](https://github.com/open-telemetry/semantic-conventions/issues/430)
* [Add k8s.pod.ip attribute](https://github.com/open-telemetry/semantic-conventions/issues/1160)
* [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

## Deliverables

* Introduce and stabilize k8s semantic conventions.
* Update existing OpenTelemetry Collector components to conform with the stable conventions.

## Staffing / Help Wanted

We are seeking domain experts to work on the introduction and stability of the K8s Semantic Conventions.

The goal is to follow @tedsuo's proposed [Semantic Convention Process](https://docs.google.com/document/d/1ghvajKaipiNZso3fDtyNxU7x1zx0_Eyd02OGpMGEpLE/edit#heading=h.xc2ft2cddhny).

- Stage 1: Working Group Preparation
- Stage 2: Stabilizing the Specification
- Stage 3: Implementation

### Required staffing

**Project Leads:**

- @ChrsMark (Elastic)
- @dashpole (Google)

**Domain Experts:**

- @TylerHelmuth
- @dmitryax
- ...

**TC sponsor(s):**

- @jsuereth

Need more
- [ ] domain experts
- [ ] TC
- [ ] potentially, maintainers of language-specific instrumentation may be needed if the need arises.

**Maintainers:**

- @open-telemetry/semconv-k8s-approvers
- @open-telemetry/semconv-container-approvers

## Meeting Times

*meeting-notes* [google-doc TBA](TBA)

*cncf-slack* For async conversation please use #otel-k8s-semconv-sig slack channel from official CNCF slack workspace.

## Timeline

Timeline
Stage 1 (Working Group Preparation) is happening now.

Stage 2 (Stabilizing the Specification) will begin as soon as we have adequate
staffing for this project, and we coordinate weekly
meeting times (currently targeting X).

Stage 3 (Implementation) will begin as soon as the k8s metrics and resource attributes are marked stable,
and it should be relatively short we only need to update conformance to the specification for a few collector components.


## Labels

* area:k8s
* area:containers

0 comments on commit dedc5fb

Please sign in to comment.