Skip to content

Add new k8s.node.filesystem semantic conventions#3890

Open
PlateauGao wants to merge 3 commits into
open-telemetry:mainfrom
PlateauGao:add-k8s-node-inode-metrics
Open

Add new k8s.node.filesystem semantic conventions#3890
PlateauGao wants to merge 3 commits into
open-telemetry:mainfrom
PlateauGao:add-k8s-node-inode-metrics

Conversation

@PlateauGao

Copy link
Copy Markdown
Contributor

Fixes #3858

Changes

This PR proposes adding new Kubernetes node-level filesystem inode capacity and usage metrics under the k8s.node.filesystem namespace:

  • k8s.node.filesystem.inode.count (UpDownCounter, {inode}): Represents the total number of inodes in the node's root filesystem.
  • k8s.node.filesystem.inode.free (UpDownCounter, {inode}): Represents the number of free inodes in the node's root filesystem.

These metrics are derived from the Kubelet Summary API (v1alpha1.NodeStats.FsStats fields Inodes and InodesFree respectively). Adding these allows monitoring for potential inode pressure or exhaustion on Kubernetes nodes, complementing the existing pod volume inode metrics.

Only the semantic conventions model/ file and corresponding documentation sections have been updated.

Merge requirement checklist

  • CONTRIBUTING.md guidelines followed.
  • Links to prototypes or existing instrumentations (when adding or changing conventions):
  • Disclose AI usage, see OTel GenAI policy:
    • no AI used
    • AI-assisted
    • bulk AI-generated
  • I have the experience and knowledge necessary to understand, review, and validate all content in this PR.1

Footnotes

  1. Yes, I can answer maintainer questions about the content of this PR without using AI.

Copilot AI review requested due to automatic review settings July 14, 2026 16:38
@PlateauGao
PlateauGao requested review from a team as code owners July 14, 2026 16:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot couldn't run its full agentic review because no GitHub Actions runner was available. Make sure your repository has a runner available to run Copilot's review, or add a copilot-setup-steps.yml file specifying one with the runs-on attribute. See the docs for more details.

Adds new semantic conventions and docs for Kubernetes node root filesystem inode metrics, enabling monitoring of inode pressure/exhaustion from Kubelet Summary API data.

Changes:

  • Define k8s.node.filesystem.inode.count and k8s.node.filesystem.inode.free in the k8s metrics model.
  • Add autogenerated documentation sections and TOC entries for the new metrics.
  • Add a changelog entry describing the enhancement.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 5 comments.

File Description
model/k8s/metrics.yaml Adds two new node filesystem inode metric definitions under k8s.node.filesystem.*.
docs/system/k8s-metrics.md Documents the new inode metrics and updates the metrics TOC.
.chloggen/add-k8s-node-inode-metrics.yaml Adds a release note entry for the new inode metrics.

Comment thread model/k8s/metrics.yaml
Comment thread model/k8s/metrics.yaml
@github-actions github-actions Bot added enhancement New feature or request area:k8s labels Jul 14, 2026
@lmolkova lmolkova moved this from Untriaged to Awaiting codeowners approval in Semantic Conventions Triage Jul 17, 2026
@PlateauGao

Copy link
Copy Markdown
Contributor Author

Hi @ChrsMark, could you please review this PR? Thanks!

Comment thread package-lock.json
@opentelemetry-pr-dashboard

opentelemetry-pr-dashboard Bot commented Jul 21, 2026

Copy link
Copy Markdown

Pull request dashboard status

Status last refreshed: 2026-07-25 14:01:50 UTC.

  • Waiting on: Reviewers
  • Next step: Review the latest changes.

This automated status or its linked feedback items may be incorrect. If something looks wrong, please report it with the result you expected.

@braydonk braydonk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

My approval cannot be official since I'm not part of this group, but I was part of the discussion in the Collector issue on this and confirm it matches my understanding of what we agreed upon there.

@PlateauGao
PlateauGao requested a review from kamphaus July 21, 2026 14:32
@PlateauGao

Copy link
Copy Markdown
Contributor Author

Hi @kamphaus , may I have your review here? Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:k8s enhancement New feature or request

Projects

Status: No status
Status: Awaiting codeowners approval

Development

Successfully merging this pull request may close these issues.

Proposal: Add K8s Node Filesystem Inode Metrics

5 participants