View Source OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics (OpenTelemetry.SemConv v1.27.0)
OpenTelemetry Semantic Conventions for System metrics.
Summary
Functions
Reports the current frequency of the CPU in Hz
Reports the number of logical (virtual) processor cores created by the operating system to manage multitasking
Reports the number of actual physical processor cores on the hardware
Seconds each logical CPU spent on each mode
Difference in system.cpu.time since the last measurement, divided by the elapsed time and number of logical CPUs
none
Time disk spent activated
none
Sum of the time each operation took to complete
An estimate of how much memory is available for starting new applications, without causing swapping
Reports the memory used by the Linux kernel for managing caches of frequently used objects.
Total memory available in the system.
Shared memory used (mostly by tmpfs).
Reports memory in use by state.
Count of packets that are dropped or discarded even though there was no error
Count of network errors detected
none
Unix swap or windows pagefile usage
Total number of processes in each state
Total number of processes created over uptime of the host
Functions
@spec system_cpu_frequency() :: :"system.cpu.frequency"
Reports the current frequency of the CPU in Hz
Instrument: gauge
Unit: {Hz}
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_cpu_frequency()
:"system.cpu.frequency"?SYSTEM_CPU_FREQUENCY.
'system.cpu.frequency'@spec system_cpu_logical_count() :: :"system.cpu.logical.count"
Reports the number of logical (virtual) processor cores created by the operating system to manage multitasking
Instrument: updowncounter
Unit: {cpu}
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_cpu_logical_count()
:"system.cpu.logical.count"?SYSTEM_CPU_LOGICAL_COUNT.
'system.cpu.logical.count'@spec system_cpu_physical_count() :: :"system.cpu.physical.count"
Reports the number of actual physical processor cores on the hardware
Instrument: updowncounter
Unit: {cpu}
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_cpu_physical_count()
:"system.cpu.physical.count"?SYSTEM_CPU_PHYSICAL_COUNT.
'system.cpu.physical.count'@spec system_cpu_time() :: :"system.cpu.time"
Seconds each logical CPU spent on each mode
Instrument: counter
Unit: s
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_cpu_time()
:"system.cpu.time"?SYSTEM_CPU_TIME.
'system.cpu.time'@spec system_cpu_utilization() :: :"system.cpu.utilization"
Difference in system.cpu.time since the last measurement, divided by the elapsed time and number of logical CPUs
Instrument: gauge
Unit: 1
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_cpu_utilization()
:"system.cpu.utilization"?SYSTEM_CPU_UTILIZATION.
'system.cpu.utilization'@spec system_disk_io() :: :"system.disk.io"
none
Instrument: counter
Unit: By
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_disk_io()
:"system.disk.io"?SYSTEM_DISK_IO.
'system.disk.io'@spec system_disk_io_time() :: :"system.disk.io_time"
Time disk spent activated
Instrument: counter
Unit: s
Notes
The real elapsed time ("wall clock") used in the I/O path (time from operations running in parallel are not counted). Measured as:
- Linux: Field 13 from procfs-diskstats
- Windows: The complement of
"Disk% Idle Time"
performance counter:uptime * (100 - "Disk% Idle Time") / 100
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_disk_io_time()
:"system.disk.io_time"?SYSTEM_DISK_IO_TIME.
'system.disk.io_time'@spec system_disk_merged() :: :"system.disk.merged"
none
Instrument: counter
Unit: {operation}
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_disk_merged()
:"system.disk.merged"?SYSTEM_DISK_MERGED.
'system.disk.merged'@spec system_disk_operation_time() :: :"system.disk.operation_time"
Sum of the time each operation took to complete
Instrument: counter
Unit: s
Notes
Because it is the sum of time each request took, parallel-issued requests each contribute to make the count grow. Measured as:
- Linux: Fields 7 & 11 from procfs-diskstats
- Windows: "Avg. Disk sec/Read" perf counter multiplied by "Disk Reads/sec" perf counter (similar for Writes)
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_disk_operation_time()
:"system.disk.operation_time"?SYSTEM_DISK_OPERATION_TIME.
'system.disk.operation_time'@spec system_disk_operations() :: :"system.disk.operations"
none
Instrument: counter
Unit: {operation}
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_disk_operations()
:"system.disk.operations"?SYSTEM_DISK_OPERATIONS.
'system.disk.operations'@spec system_filesystem_usage() :: :"system.filesystem.usage"
none
Instrument: updowncounter
Unit: By
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_filesystem_usage()
:"system.filesystem.usage"?SYSTEM_FILESYSTEM_USAGE.
'system.filesystem.usage'@spec system_filesystem_utilization() :: :"system.filesystem.utilization"
none
Instrument: gauge
Unit: 1
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_filesystem_utilization()
:"system.filesystem.utilization"?SYSTEM_FILESYSTEM_UTILIZATION.
'system.filesystem.utilization'@spec system_linux_memory_available() :: :"system.linux.memory.available"
An estimate of how much memory is available for starting new applications, without causing swapping
Instrument: updowncounter
Unit: By
Notes
This is an alternative to system.memory.usage metric with state=free.
Linux starting from 3.14 exports "available" memory. It takes "free" memory as a baseline, and then factors in kernel-specific values.
This is supposed to be more accurate than just "free" memory.
For reference, see the calculations here.
See also MemAvailable in /proc/meminfo.
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_linux_memory_available()
:"system.linux.memory.available"?SYSTEM_LINUX_MEMORY_AVAILABLE.
'system.linux.memory.available'@spec system_linux_memory_slab_usage() :: :"system.linux.memory.slab.usage"
Reports the memory used by the Linux kernel for managing caches of frequently used objects.
Instrument: updowncounter
Unit: By
Notes
The sum over the reclaimable and unreclaimable state values in linux.memory.slab.usage SHOULD be equal to the total slab memory available on the system.
Note that the total slab memory is not constant and may vary over time.
See also the Slab allocator and Slab in /proc/meminfo.
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_linux_memory_slab_usage()
:"system.linux.memory.slab.usage"?SYSTEM_LINUX_MEMORY_SLAB_USAGE.
'system.linux.memory.slab.usage'@spec system_memory_limit() :: :"system.memory.limit"
Total memory available in the system.
Instrument: updowncounter
Unit: By
Notes
Its value SHOULD equal the sum of system.memory.state over all states.
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_memory_limit()
:"system.memory.limit"?SYSTEM_MEMORY_LIMIT.
'system.memory.limit'@spec system_memory_usage() :: :"system.memory.usage"
Reports memory in use by state.
Instrument: updowncounter
Unit: By
Notes
The sum over all system.memory.state values SHOULD equal the total memory
available on the system, that is system.memory.limit.
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_memory_usage()
:"system.memory.usage"?SYSTEM_MEMORY_USAGE.
'system.memory.usage'@spec system_memory_utilization() :: :"system.memory.utilization"
none
Instrument: gauge
Unit: 1
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_memory_utilization()
:"system.memory.utilization"?SYSTEM_MEMORY_UTILIZATION.
'system.memory.utilization'@spec system_network_connections() :: :"system.network.connections"
none
Instrument: updowncounter
Unit: {connection}
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_network_connections()
:"system.network.connections"?SYSTEM_NETWORK_CONNECTIONS.
'system.network.connections'@spec system_network_dropped() :: :"system.network.dropped"
Count of packets that are dropped or discarded even though there was no error
Instrument: counter
Unit: {packet}
Notes
Measured as:
- Linux: the
dropcolumn in/proc/dev/net(source) - Windows:
InDiscards/OutDiscards
fromGetIfEntry2
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_network_dropped()
:"system.network.dropped"?SYSTEM_NETWORK_DROPPED.
'system.network.dropped'@spec system_network_errors() :: :"system.network.errors"
Count of network errors detected
Instrument: counter
Unit: {error}
Notes
Measured as:
- Linux: the
errscolumn in/proc/dev/net(source). - Windows:
InErrors/OutErrors
fromGetIfEntry2.
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_network_errors()
:"system.network.errors"?SYSTEM_NETWORK_ERRORS.
'system.network.errors'@spec system_network_io() :: :"system.network.io"
none
Instrument: counter
Unit: By
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_network_io()
:"system.network.io"?SYSTEM_NETWORK_IO.
'system.network.io'@spec system_network_packets() :: :"system.network.packets"
none
Instrument: counter
Unit: {packet}
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_network_packets()
:"system.network.packets"?SYSTEM_NETWORK_PACKETS.
'system.network.packets'@spec system_paging_faults() :: :"system.paging.faults"
none
Instrument: counter
Unit: {fault}
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_paging_faults()
:"system.paging.faults"?SYSTEM_PAGING_FAULTS.
'system.paging.faults'@spec system_paging_operations() :: :"system.paging.operations"
none
Instrument: counter
Unit: {operation}
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_paging_operations()
:"system.paging.operations"?SYSTEM_PAGING_OPERATIONS.
'system.paging.operations'@spec system_paging_usage() :: :"system.paging.usage"
Unix swap or windows pagefile usage
Instrument: updowncounter
Unit: By
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_paging_usage()
:"system.paging.usage"?SYSTEM_PAGING_USAGE.
'system.paging.usage'@spec system_paging_utilization() :: :"system.paging.utilization"
none
Instrument: gauge
Unit: 1
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_paging_utilization()
:"system.paging.utilization"?SYSTEM_PAGING_UTILIZATION.
'system.paging.utilization'@spec system_process_count() :: :"system.process.count"
Total number of processes in each state
Instrument: updowncounter
Unit: {process}
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_process_count()
:"system.process.count"?SYSTEM_PROCESS_COUNT.
'system.process.count'@spec system_process_created() :: :"system.process.created"
Total number of processes created over uptime of the host
Instrument: counter
Unit: {process}
iex> OpenTelemetry.SemConv.Incubating.Metrics.SystemMetrics.system_process_created()
:"system.process.created"?SYSTEM_PROCESS_CREATED.
'system.process.created'