Skip to content

[k8s] Add k8s node allocatable metrics#2267

Merged
joaopgrassi merged 5 commits intoopen-telemetry:mainfrom
odubajDT:add-k8s-allocatable-metrics
Jun 16, 2025
Merged

[k8s] Add k8s node allocatable metrics#2267
joaopgrassi merged 5 commits intoopen-telemetry:mainfrom
odubajDT:add-k8s-allocatable-metrics

Conversation

@odubajDT
Copy link
Copy Markdown
Contributor

@odubajDT odubajDT commented May 14, 2025 •
edited
Loading

Fixes #2243

Changes

added

k8s.node.allocatable.cpu
k8s.node.allocatable.ephemeral_storage
k8s.node.allocatable.memory
k8s.node.allocatable.pods

follow-up issue to handle the changes in k8scluster receiver here

Merge requirement checklist

@odubajDT odubajDT requested review from a team as code owners May 14, 2025 09:56
@github-actions github-actions Bot added enhancement New feature or request area:k8s labels May 14, 2025
joaopgrassi
joaopgrassi reviewed May 16, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@joaopgrassi joaopgrassi left a comment

Choose a reason for hiding this comment

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

Is it correct that there are no attributes in any of these metrics?

Comment thread model/k8s/metrics.yaml Outdated
Comment thread model/k8s/metrics.yaml Outdated
@joaopgrassi joaopgrassi moved this from Untriaged to In Review in Semantic Conventions Triage May 16, 2025
@lmolkova lmolkova moved this from In Review to Awaiting SIG approval in Semantic Conventions Triage May 17, 2025
@odubajDT odubajDT force-pushed the add-k8s-allocatable-metrics branch from 746d981 to 15981b0 Compare May 23, 2025 09:54
@ChrsMark ChrsMark moved this to In Review in K8s SemConv SIG May 28, 2025
dashpole
dashpole reviewed May 29, 2025
View reviewed changes
Comment thread docs/system/k8s-metrics.md Outdated
ChrsMark
ChrsMark reviewed Jun 4, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@ChrsMark ChrsMark left a comment

Choose a reason for hiding this comment

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

As mentioned at https://github.com/open-telemetry/semantic-conventions/pull/2267/files#r2120289448, instead of just defining the metrics as-is from the Collector's implementation we should work on defining them correctly.

We do this for all the metrics of #1032 and we have already "breaking" changes that we plan to handle through a specific migration process once we have k8s metrics to GA. We document these diffs at https://github.com/open-telemetry/semantic-conventions/blob/main/docs/non-normative/k8s-migration.md

That said, the missing piece here is if we should have a k8s.node.allocatable.* namespace with all the sub-resources attached (cpu, memory etc) or if we should re-use the existing k8s.node.cpu.*, k8s.node.memory namespaces. I don't have a strong preference for any of these 2, but maybe picking the k8s.node.allocatable.* namespace will better align context-wise?

Comment thread model/k8s/metrics.yaml Outdated
@ChrsMark ChrsMark mentioned this pull request Jun 4, 2025
Merged
@odubajDT odubajDT force-pushed the add-k8s-allocatable-metrics branch from 15981b0 to 95867b7 Compare June 5, 2025 06:48
ChrsMark
ChrsMark reviewed Jun 5, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@ChrsMark ChrsMark left a comment

Choose a reason for hiding this comment

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

Can we also list how these metrics are different to what Collect has today? We track those diffs at https://github.com/open-telemetry/semantic-conventions/blob/main/docs/non-normative/k8s-migration.md#summary-of-changes

Comment thread model/k8s/metrics.yaml
ChrsMark
ChrsMark approved these changes Jun 5, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@ChrsMark ChrsMark left a comment

Choose a reason for hiding this comment

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

LGTM! Thank's for contributing this!

@ChrsMark ChrsMark moved this from Awaiting SIG approval to Needs More Approval in Semantic Conventions Triage Jun 11, 2025
@ChrsMark
Copy link
Copy Markdown
Member

ChrsMark commented Jun 11, 2025

@open-telemetry/specs-semconv-maintainers @open-telemetry/specs-semconv-approvers this one has enough approvals from the K8s SIG. Should be on your side now :)

@ChrsMark ChrsMark moved this from In Review to Approved by K8s SIG in K8s SemConv SIG Jun 11, 2025
@odubajDT odubajDT mentioned this pull request Jun 13, 2025
Open
@odubajDT odubajDT requested a review from joaopgrassi June 13, 2025 06:30
odubajDT added 3 commits June 13, 2025 08:32
@odubajDT
[k8s] Add k8s node allocatable metrics
45da81f 
Signed-off-by: odubajDT <[email protected]>
@odubajDT
add pod unit
94bf2f1 
Signed-off-by: odubajDT <[email protected]>
@odubajDT
adapt naming
e6f616c 
Signed-off-by: odubajDT <[email protected]>
odubajDT added 2 commits June 13, 2025 08:32
@odubajDT
pr review
6d4c4dc 
Signed-off-by: odubajDT <[email protected]>
@odubajDT
fix toc
c0bd712 
Signed-off-by: odubajDT <[email protected]>
@odubajDT odubajDT force-pushed the add-k8s-allocatable-metrics branch from 6aa4e1b to c0bd712 Compare June 13, 2025 06:32
joaopgrassi
joaopgrassi approved these changes Jun 13, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@joaopgrassi joaopgrassi left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I think this PR is not affected by the discussion on naming UpDownCounters https://github.com/open-telemetry/semantic-conventions/pull/2317/files, so giving my approval.

For the implementation, consider this important fact when using UpDownCounters: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/metrics.md#consistent-updowncounter-timeseries

@joaopgrassi joaopgrassi added this pull request to the merge queue Jun 16, 2025
Merged via the queue into open-telemetry:main with commit 204c967 Jun 16, 2025
14 checks passed
@github-project-automation github-project-automation Bot moved this from Approved by K8s SIG to Done in K8s SemConv SIG Jun 16, 2025
thompson-tomo pushed a commit to thompson-tomo/semantic-conventions that referenced this pull request Jun 16, 2025
@odubajDT @thompson-tomo
[k8s] Add k8s node allocatable metrics (open-telemetry#2267)
d592c26 
Signed-off-by: odubajDT <[email protected]>
jherbage pushed a commit to jherbage/semantic-conventions that referenced this pull request Jul 1, 2025
@odubajDT @jherbage
[k8s] Add k8s node allocatable metrics (open-telemetry#2267)
ac38db4 
Signed-off-by: odubajDT <[email protected]>
spurplewang pushed a commit to spurplewang/semantic-conventions that referenced this pull request Jul 10, 2025
@odubajDT @spurplewang
[k8s] Add k8s node allocatable metrics (open-telemetry#2267)
219783c 
Signed-off-by: odubajDT <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jsuereth jsuereth jsuereth approved these changes

@dashpole dashpole dashpole approved these changes

@joaopgrassi joaopgrassi joaopgrassi approved these changes

@ChrsMark ChrsMark ChrsMark approved these changes

@jinja2 jinja2 jinja2 approved these changes

Assignees

No one assigned

Labels

area:k8s enhancement New feature or request

Projects

K8s SemConv SIG
Status: Done
Semantic Conventions Triage
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[k8s] Define semantic conventions for k8s node allocatable metric

7 participants

@odubajDT @ChrsMark @jsuereth @dashpole @joaopgrassi @jinja2 @lmolkova