-
Notifications
You must be signed in to change notification settings - Fork 183
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add k8s.{pod,node}.cpu.{time,usage} metrics (#1320)
Signed-off-by: ChrsMark <[email protected]>
- Loading branch information
Showing
3 changed files
with
233 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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.pod.cpu.time`, `k8s.pod.cpu.usage`, `k8s.node.cpu.time`, `k8s.node.cpu.usage` metrics | ||
|
|
||
| # 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: [1320] | ||
|
|
||
| # (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: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| <!--- Hugo front matter used to generate the website version of this page: | ||
| linkTitle: Container | ||
| ---> | ||
|
|
||
| # Semantic Conventions for Kubernetes Metrics | ||
|
|
||
| **Status**: [Experimental][DocumentStatus] | ||
|
|
||
| ## K8s Metrics | ||
|
|
||
| This document describes instruments and attributes for common K8s level | ||
| metrics in OpenTelemetry. These metrics are collected from technology-specific, | ||
| well-defined APIs (e.g. Kubelet's API). | ||
|
|
||
| Metrics in `k8s.` instruments SHOULD be attached to a [K8s Resource](/docs/resource/k8s.md) | ||
| and therefore inherit its attributes, like `k8s.pod.name` and `k8s.pod.uid`. | ||
|
|
||
| ### Metric: `k8s.pod.cpu.time` | ||
|
|
||
| This metric is [recommended][MetricRecommended]. | ||
|
|
||
| <!-- semconv metric.k8s.pod.cpu.time(metric_table) --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
| | Name | Instrument Type | Unit (UCUM) | Description | Stability | | ||
| | -------- | --------------- | ----------- | -------------- | --------- | | ||
| | `k8s.pod.cpu.time` | Counter | `s` | Total CPU time consumed [1] |  | | ||
|
|
||
|
|
||
| **[1]:** Total CPU time consumed by the specific Pod on all available CPU cores | ||
|
|
||
|
|
||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| <!-- semconv metric.k8s.pod.cpu.time --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| ### Metric: `k8s.pod.cpu.usage` | ||
|
|
||
| This metric is [recommended][MetricRecommended]. | ||
|
|
||
| <!-- semconv metric.k8s.pod.cpu.usage(metric_table) --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
| | Name | Instrument Type | Unit (UCUM) | Description | Stability | | ||
| | -------- | --------------- | ----------- | -------------- | --------- | | ||
| | `k8s.pod.cpu.usage` | Gauge | `{cpu}` | Pod's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs [1] |  | | ||
|
|
||
|
|
||
| **[1]:** CPU usage of the specific Pod on all available CPU cores, averaged over the sample window | ||
|
|
||
|
|
||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| <!-- semconv metric.k8s.pod.cpu.usage --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| ### Metric: `k8s.node.cpu.time` | ||
|
|
||
| This metric is [recommended][MetricRecommended]. | ||
|
|
||
| <!-- semconv metric.k8s.node.cpu.time(metric_table) --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
| | Name | Instrument Type | Unit (UCUM) | Description | Stability | | ||
| | -------- | --------------- | ----------- | -------------- | --------- | | ||
| | `k8s.node.cpu.time` | Counter | `s` | Total CPU time consumed [1] |  | | ||
|
|
||
|
|
||
| **[1]:** Total CPU time consumed by the specific Node on all available CPU cores | ||
|
|
||
|
|
||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| <!-- semconv metric.k8s.node.cpu.time --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| ### Metric: `k8s.node.cpu.usage` | ||
|
|
||
| This metric is [recommended][MetricRecommended]. | ||
|
|
||
| <!-- semconv metric.k8s.node.cpu.usage(metric_table) --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
| | Name | Instrument Type | Unit (UCUM) | Description | Stability | | ||
| | -------- | --------------- | ----------- | -------------- | --------- | | ||
| | `k8s.node.cpu.usage` | Gauge | `{cpu}` | Node's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs [1] |  | | ||
|
|
||
|
|
||
| **[1]:** CPU usage of the specific Node on all available CPU cores, averaged over the sample window | ||
|
|
||
|
|
||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| <!-- semconv metric.k8s.node.cpu.usage --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status | ||
| [MetricRecommended]: /docs/general/metric-requirement-level.md#recommended |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| groups: | ||
| # k8s.pod.cpu.* metrics | ||
| - id: metric.k8s.pod.cpu.time | ||
| type: metric | ||
| metric_name: k8s.pod.cpu.time | ||
| stability: experimental | ||
| brief: "Total CPU time consumed" | ||
| note: > | ||
| Total CPU time consumed by the specific Pod on all available CPU cores | ||
| instrument: counter | ||
| unit: "s" | ||
| - id: metric.k8s.pod.cpu.usage | ||
| type: metric | ||
| metric_name: k8s.pod.cpu.usage | ||
| stability: experimental | ||
| brief: "Pod's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs" | ||
| note: > | ||
| CPU usage of the specific Pod on all available CPU cores, averaged over the sample window | ||
| instrument: gauge | ||
| unit: "{cpu}" | ||
|
|
||
| # k8s.node.cpu.* metrics | ||
| - id: metric.k8s.node.cpu.time | ||
| type: metric | ||
| metric_name: k8s.node.cpu.time | ||
| stability: experimental | ||
| brief: "Total CPU time consumed" | ||
| note: > | ||
| Total CPU time consumed by the specific Node on all available CPU cores | ||
| instrument: counter | ||
| unit: "s" | ||
| - id: metric.k8s.node.cpu.usage | ||
| type: metric | ||
| metric_name: k8s.node.cpu.usage | ||
| stability: experimental | ||
| brief: "Node's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs" | ||
| note: > | ||
| CPU usage of the specific Node on all available CPU cores, averaged over the sample window | ||
| instrument: gauge | ||
| unit: "{cpu}" |