Skip to content

Commit 05df82b

Browse files
committed
add note about container metrics and usage's brief
Signed-off-by: ChrsMark <[email protected]>
1 parent eaabcfe commit 05df82b

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

docs/system/container-metrics.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ linkTitle: Container
88

99
## Container Metrics
1010

11+
This document describes instruments and attributes for common container level
12+
metrics in OpenTelemetry. Collected from technology-specific,
13+
well-defined APIs (e.g. Kubelet's API or container runtimes).
14+
1115
### Metric: `container.cpu.time`
1216

1317
This metric is [opt-in][MetricOptIn].
@@ -42,7 +46,7 @@ This metric is [opt-in][MetricOptIn].
4246

4347
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
4448
|---|---|---|---|---|---|
45-
| [`container.cpu.state`](/docs/attributes-registry/container.md) | string | The CPU state for this data point. A container SHOULD be characterized _either_ by data points with no `state` labels, _or only_ data points with `state` labels. | `user`; `kernel` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
49+
| [`container.cpu.state`](/docs/attributes-registry/container.md) | string | The CPU state for this data point. A container's cpu time SHOULD be characterized _either_ by data points with no `state` labels, _or only_ data points with `state` labels. | `user`; `kernel` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
4650

4751
`container.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
4852

@@ -72,7 +76,7 @@ This metric is [opt-in][MetricOptIn].
7276

7377
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
7478
| -------- | --------------- | ----------- | -------------- | --------- |
75-
| `container.cpu.usage` | Gauge | `{cpu}` | CPU usage [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
79+
| `container.cpu.usage` | Gauge | `{cpu}` | Container's CPU usage, measured in cpus. Range from 0 to the number of allocatable cpus [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
7680

7781

7882
**[1]:** CPU usage of the specific container on all available CPU cores, averaged over the sample window
@@ -93,7 +97,7 @@ This metric is [opt-in][MetricOptIn].
9397

9498
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
9599
|---|---|---|---|---|---|
96-
| [`container.cpu.state`](/docs/attributes-registry/container.md) | string | The CPU state for this data point. A container SHOULD be characterized _either_ by data points with no `state` labels, _or only_ data points with `state` labels. | `user`; `kernel` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
100+
| [`container.cpu.state`](/docs/attributes-registry/container.md) | string | The CPU state for this data point. A container's cpu time SHOULD be characterized _either_ by data points with no `state` labels, _or only_ data points with `state` labels. | `user`; `kernel` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
97101

98102
`container.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
99103

model/metrics/container.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ groups:
1111
unit: "s"
1212
attributes:
1313
- ref: container.cpu.state
14-
brief: "The CPU state for this data point. A container SHOULD be characterized _either_ by data points with no `state` labels, _or only_ data points with `state` labels."
14+
brief: "The CPU state for this data point. A container's cpu time SHOULD be characterized _either_ by data points with no `state` labels, _or only_ data points with `state` labels."
1515
requirement_level: opt_in
1616

1717
- id: metric.container.cpu.usage
1818
type: metric
1919
metric_name: container.cpu.usage
2020
stability: experimental
21-
brief: "CPU usage"
21+
brief: "Container's CPU usage, measured in cpus. Range from 0 to the number of allocatable cpus"
2222
note: >
2323
CPU usage of the specific container on all available CPU cores, averaged over the sample window
2424
instrument: gauge
2525
unit: "{cpu}"
2626
attributes:
2727
- ref: container.cpu.state
28-
brief: "The CPU state for this data point. A container SHOULD be characterized _either_ by data points with no `state` labels, _or only_ data points with `state` labels."
28+
brief: "The CPU state for this data point. A container's cpu usage SHOULD be characterized _either_ by data points with no `state` labels, _or only_ data points with `state` labels."
2929
requirement_level: opt_in
3030

3131
# container.memory.* metrics and attribute group

0 commit comments

Comments
 (0)