Skip to content
This repository was archived by the owner on Oct 3, 2023. It is now read-only.

Commit bc68109

Browse files
committed
Add memory metrics
1 parent 550a666 commit bc68109

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

metrics/SystemMetrics.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,30 @@ TODO: Add list of supported platforms.
77
## Common metrics collection
88
These are some default metrics supported by OpenCensus system metrics package/contrib. This is to ensure consistency across language implementations, as far as practical.
99

10-
| Metric Name | Unit | Type | Description | Labels |
11-
|-------------------------------------------|-------|----------------------------|-----------------------------------------------------------------------------------------------|-----------------|
12-
| system/cpu_seconds/total | s | Int64 Cumulative | Total kernel/system user CPU in seconds. | Hostname, Mode |
13-
| system/processes/created | 1 | Int64 Cumulative | Total number of times a process was created. | Hostname |
14-
| system/processes/running | 1 | Int64 Gauge | Total number of running processes. | Hostname |
15-
| system/disk/total | By | Int64 Gauge | The total available system disk space in bytes. | Hostname, Volume |
16-
| system/disk/used | By | Int64 Gauge | The total used system disk space in bytes. | Hostname, Volume |
17-
| process/heap/total | By | Int64 Gauge | The process's total allocated heap size in bytes. | Hostname |
18-
| process/heap/used | By | Int64 Gauge | The process's total used heap size in bytes. | Hostname |
19-
| process/memory/rss | By | Int64 Gauge | Resident memory size in bytes. | Hostname |
20-
| process/file_descriptor/max | 1 | Int64 Gauge | The maximum limit of file descriptor count. | Hostname |
21-
| process/file_descriptor/open | 1 | Int64 Gauge | The number of open file descriptor count. | Hostname |
22-
| process/start_time | s | Int64 Cumulative | The start time of the process since unix epoch in seconds. | Hostname |
23-
| process/cpu/usage | s | Int64 Cumulative | The total user and system CPU time spent in seconds. | Hostname |
10+
| Metric Name | Unit | Type | Description | Labels |
11+
|-------------------------------------------|-------|----------------------------|--------------------------------------------------------------------|-------------------------|
12+
| system/cpu_seconds/total | s | Int64 Cumulative | Total kernel/system user CPU in seconds. | Hostname, Mode |
13+
| system/processes/created | 1 | Int64 Cumulative | Total number of times a process was created. | Hostname |
14+
| system/processes/running | 1 | Int64 Gauge | Total number of running processes. | Hostname |
15+
| system/processes/blocked | 1 | Int64 Gauge | Total number of blocked processes. | Hostname |
16+
| system/memory/total | By | Int64 Gauge | Total system memory capacity in bytes. | Hostname |
17+
| system/memory/free | By | Int64 Gauge | Total free system memory in bytes. | Hostname |
18+
| system/memory/used | By | Int64 Gauge | Total used system memory in bytes. | Hostname |
19+
| system/disk/total | By | Int64 Gauge | The total available system disk space in bytes. | Hostname, Volume |
20+
| system/disk/used | By | Int64 Gauge | The total used system disk space in bytes. | Hostname, Volume |
21+
| process/memory/rss | By | Int64 Gauge | Resident memory size in bytes. | Hostname |
22+
| process/file_descriptor/max | 1 | Int64 Gauge | The maximum limit of file descriptor count. | Hostname |
23+
| process/file_descriptor/open | 1 | Int64 Gauge | The number of open file descriptor count. | Hostname |
24+
| process/heap/total | By | Int64 Gauge | The process's total allocated heap size in bytes. | Hostname |
25+
| process/heap/used | By | Int64 Gauge | The process's total used heap size in bytes. | Hostname |
26+
| process/cpu/usage | s | Int64 Cumulative | The total user and system CPU time spent in seconds. | Hostname |
2427

2528
### Labels
2629
The label keys associated with the above metrics.
2730

2831
| Label Key | Description |
2932
|--------------------|----------------------------------------------------------------------------------------------------------|
30-
| Mode | The amount of time spent by the CPU in state (i.e. `user, nice, system, idle, iowait`). |
33+
| Mode | The amount of time spent by the CPU in state (i.e. `user, nice, system, idle, iowait, stolen`). |
3134
| Volume | The path the fs is mounted on (i.e. `/, /data`) |
3235
| Hostname | The hostname of the host (i.e. `opencensus-test`). |
3336

0 commit comments

Comments
 (0)