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

Add default metrics supported by OpenCensus system metrics package #258

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add default metrics supported by OpenCensus system metrics package #258

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
550a666
Add default metrics supported by OpenCensus system metrics package
mayurkale22 Apr 11, 2019
bc68109
Add memory metrics
mayurkale22 Apr 13, 2019
8696358
Fix review comment: Combine common metrics and add labels
mayurkale22 May 6, 2019
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
35 changes: 35 additions & 0 deletions metrics/SystemMetrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# System Metrics
This document serves to document the "look and feel" of the OpenCensus API for auto-collection of system metrics such as processes, memory & CPU usage, disks, etc.

## Supported platforms
TODO: Add list of supported platforms.

## Common metrics collection
These are some default metrics supported by OpenCensus system metrics package/contrib. This is to ensure consistency across language implementations, as far as practical.

| Metric Name | Unit | Type | Description | Labels |
|-------------------------------------------|-------|----------------------------|-----------------------------------------------------------------------------------------------|-----------------|
| system/cpu_seconds/total | s | Int64 Cumulative | Total kernel/system user CPU in seconds. | Hostname, Mode |
| system/processes/created | 1 | Int64 Cumulative | Total number of times a process was created. | Hostname |
| system/processes/running | 1 | Int64 Gauge | Total number of running processes. | Hostname |
Copy link
Contributor

Choose a reason for hiding this comment

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

add blocked process
system/processes/blocked, 1, Int64 Gauge, Number of processes blocked.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done, thanks.

| system/disk/total | By | Int64 Gauge | The total available system disk space in bytes. | Hostname, Volume |
| system/disk/used | By | Int64 Gauge | The total used system disk space in bytes. | Hostname, Volume |
Copy link
Contributor

Choose a reason for hiding this comment

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

add memory related stats
system/memory/used
system/memory/total
system/memory/free
all of them are Int64 Gauges.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure, added.

| process/heap/total | By | Int64 Gauge | The process's total allocated heap size in bytes. | Hostname |
| process/heap/used | By | Int64 Gauge | The process's total used heap size in bytes. | Hostname |
| process/memory/rss | By | Int64 Gauge | Resident memory size in bytes. | Hostname |
| process/file_descriptor/max | 1 | Int64 Gauge | The maximum limit of file descriptor count. | Hostname |
| process/file_descriptor/open | 1 | Int64 Gauge | The number of open file descriptor count. | Hostname |
| process/start_time | s | Int64 Cumulative | The start time of the process since unix epoch in seconds. | Hostname |
Copy link
Contributor

Choose a reason for hiding this comment

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

This has no meaning. As it will be constant. May be a wall-clock time would be better.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch, removed. Thx

| process/cpu/usage | s | Int64 Cumulative | The total user and system CPU time spent in seconds. | Hostname |

### Labels
The label keys associated with the above metrics.

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

## Language specific metrics collection
TODO: Add language-specific documentation for the list of supported metrics collection (e.g. garbage collection, threads, classloaders, etc.).