Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .chloggen/add-k8s-node-inode-metrics.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: k8s

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "Add `k8s.node.filesystem.inode.count` and `k8s.node.filesystem.inode.free` metrics to track Kubernetes node root filesystem inode capacity and usage."

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [3858]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
46 changes: 46 additions & 0 deletions docs/system/k8s-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ and therefore inherit its attributes, like `k8s.pod.name` and `k8s.pod.uid`.
- [Metric: `k8s.node.filesystem.available`](#metric-k8snodefilesystemavailable)
- [Metric: `k8s.node.filesystem.capacity`](#metric-k8snodefilesystemcapacity)
- [Metric: `k8s.node.filesystem.usage`](#metric-k8snodefilesystemusage)
- [Metric: `k8s.node.filesystem.inode.count`](#metric-k8snodefilesysteminodecount)
- [Metric: `k8s.node.filesystem.inode.free`](#metric-k8snodefilesysteminodefree)
- [Metric: `k8s.node.system_container.cpu.usage`](#metric-k8snodesystem_containercpuusage)
- [Metric: `k8s.node.system_container.cpu.time`](#metric-k8snodesystem_containercputime)
- [Metric: `k8s.node.system_container.memory.working_set`](#metric-k8snodesystem_containermemoryworking_set)
Expand Down Expand Up @@ -1317,6 +1319,50 @@ of the Kubelet's stats API.
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

### Metric: `k8s.node.filesystem.inode.count`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.k8s.node.filesystem.inode.count -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `k8s.node.filesystem.inode.count` | UpDownCounter | `{inode}` | The total inodes in the node's root filesystem. [1] | ![Development](https://img.shields.io/badge/-development-blue) | [`k8s.node`](/docs/registry/entities/k8s.md#k8s-node) |

**[1]:** This metric is derived from the
[FsStats.Inodes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field
of the [NodeStats.Fs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#NodeStats)
of the Kubelet's stats API.

<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

### Metric: `k8s.node.filesystem.inode.free`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.k8s.node.filesystem.inode.free -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->

| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
| `k8s.node.filesystem.inode.free` | UpDownCounter | `{inode}` | The free inodes in the node's root filesystem. [1] | ![Development](https://img.shields.io/badge/-development-blue) | [`k8s.node`](/docs/registry/entities/k8s.md#k8s-node) |

**[1]:** This metric is derived from the
[FsStats.InodesFree](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field
of the [NodeStats.Fs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#NodeStats)
of the Kubelet's stats API.

<!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

### Metric: `k8s.node.system_container.cpu.usage`

This metric is [recommended][MetricRecommended].
Expand Down
35 changes: 35 additions & 0 deletions model/k8s/metrics.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -689,6 +689,41 @@ groups:
of the [NodeStats.Fs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#NodeStats)
of the Kubelet's stats API.

- id: metric.k8s.node.filesystem.inode.count
type: metric
metric_name: k8s.node.filesystem.inode.count
stability: development
brief: "The total inodes in the node's root filesystem."
Comment thread
braydonk marked this conversation as resolved.
instrument: updowncounter
annotations:
code_generation:
metric_value_type: int
unit: "{inode}"
entity_associations:
- k8s.node
note: |
This metric is derived from the
[FsStats.Inodes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field
of the [NodeStats.Fs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#NodeStats)
of the Kubelet's stats API.
- id: metric.k8s.node.filesystem.inode.free
type: metric
metric_name: k8s.node.filesystem.inode.free
stability: development
brief: "The free inodes in the node's root filesystem."
Comment thread
PlateauGao marked this conversation as resolved.
instrument: updowncounter
annotations:
code_generation:
metric_value_type: int
unit: "{inode}"
entity_associations:
- k8s.node
note: |
This metric is derived from the
[FsStats.InodesFree](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field
of the [NodeStats.Fs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#NodeStats)
of the Kubelet's stats API.

# k8s.node.memory.* metrics
- id: metric.k8s.node.memory.usage
type: metric
Expand Down
Loading