4.1 Displaying Metrics using System Insight
System Insight displays metrics based on the filters determined with metrics and tags. The filter you create is determined by the metric that you want to display, and can be further refined by determining the tag name and tag value that you want to visualize. For example, if you want to visualize all of the MIMs in a specific workflow, your filter would be determined with mim.<workflow type>.<agent type>.<agent>
without the addition of a tag on the metric.
The data included for a metric:
- A timestamp for when the metric was created or sampled
- Tags that carry metadata on the metric, for example, which workflow or pico the metric originated from
- Values for the actual data carried by the metric, for example, the number of udrs or the amount of data
For information on how to create a System Insight filter, see 4.1.1 Managing System Insight Filters. For information on the naming conventions in place for metrics, see 4.1.2 Metrics Naming Conventions.
System Metrics
The system metrics are host.compute
, host.network
, host.storage.iostats
, host.storage.usage
, host.storage.swap
, pico.events
, pico.jvm
, pico.workflow
,
service.akka.router.receiver
,
service.akka.router.sender
and
service.systeminsight.dispatcher
. The respective default fields in place for these metrics are listed below. You must create a System Insight profile to see these system metrics, see 2.2.34 systeminsight.
Note!
Depending on the filesystem access privileges that you have, the metrics might not be reported for some filesystems.
host.compute
Field | Description |
---|---|
hi_cpu | The percentage of CPU spent servicing/handling hardware interrupts |
idle_cpu | The percentage of CPU in idle state |
idle_proc | The total number of processes in idle state |
nice_cpu | The percentage of CPU spent running user space processes that have have a positive nice value (working with low priority processes) |
running_proc | The total number of processes in run state |
si_cpu | The percentage of CPU spent servicing/handling software interrupts |
sleep_proc | The total number of processes in sleep state |
stolen_cpu | The percentage of CPU ‘stolen’ from this virtual machine by the hypervisor for other tasks, e g running another virtual machine. This is 0 on the Desktop and server without a virtual machine. |
sys_cpu | The percentage of CPU used by the system |
total_proc | The total number of processes |
user_cpu | The percentage of CPU used by the user |
up_time | The amount of time in seconds that has passed since the machine started |
wait_cpu | The percentage of CPU in wait state |
host.network
Field | Description |
---|---|
rx_bytes | The total amount of RX bytes |
rx_dropped | The total amount of RX dropped |
rx_errors | The total amount of RX errors |
rx_frame | The total amount of RX frames |
rx_overruns | The total amount of RX overruns |
rx_packets | The total amount of RX packets |
speed | The speed in bits per second |
tx_bytes | The total amount of TX bytes |
tx_carrier | The total amount of TX carriers |
tx_collisions | The total amount of TX collisions |
tx_dropped | The total amount of TX dropped |
tx_errors | The total amount of TX errors |
tx_overruns | The total amount of TX overruns |
tx_packets | The total amount of TX packets |
host.storage.iostats
Field | Description |
---|---|
disk_read_bytes | The number of physical disk bytes read |
disk_reads | The number of physical disk reads |
disk_write_bytes | The number of physical disk bytes written |
disk_writes | The number of physical disk writes |
host.storage.swap
Field | Description |
---|---|
pages_swapped_in | The total number of pages swapped in |
pages_swapped_out | The total number of pages swapped out |
swap_free | The amount of swap space free in bytes |
swap_total | The total amount of swap space in bytes |
swap_used | The amount of swap space used in bytes |
host.storage.usage
Field | Description |
---|---|
available_space | The total amount of free space available for use on the filesystem in 1024-byte units |
free_file_count | The number of free file nodes on the filesystem |
free_space | The total amount of free space on the filesystem in 1024-byte units |
total_file_count | The total number of file nodes on the filesystem |
total_size | The total size of the filesystem in 1024-byte units |
used_percentage | The percentage of disk used |
used_space | The total amount of space used on the filesystem in 1024-byte units |
pico.events
This metric reports events that occur on the picos.
pico.jvm
Field | Description |
---|---|
active_thread_count | The current number of live threads including both daemon and non-daemon threads |
collection_count | The total number of garbage collections |
| The difference between the collection_count and the previous value of collection_count |
collection_count_per_gc | The approximate time spent per garbage collection since the last measurement |
collection_time | The approximate time (in milliseconds) that has elapsed for accumulated garbage collection |
committed_memory | The amount of memory in bytes that is committed for the JVM to use |
cpu_time | The CPU time used (in nanoseconds) by the process on which the JVM is running |
cpu_time_diff | The difference between the cpu_time and the previous value of cpu_time |
cpu_time_percent | The CPU used (in percent) since the last measurement by the process on which the JVM is running |
loaded_file_count | The number of classes that are currently loaded in the JVM |
max_memory | The maximum amount of memory in bytes that can be used for memory management |
open_file_count | The number of open file descriptors |
up_time | The uptime of the JVM in milliseconds |
used_memory | The amount of memory used in bytes |
Any other fields for pico.jvm
report memory pool metrics, which are an estimate of the memory usage in bytes of each memory pool in the JVM.
pico.workflow
Field | Description |
---|---|
throughput | The throughput of the workflow |
service.akka.router.receiver
Field | Description |
---|---|
received | The messages received by the actor |
uptime | The uptime of the actor |
service.akka.router.sender
Field | Description |
---|---|
delivered | The messages delivered downstream |
not_acknowledged | The messages not acknowledged from downstream |
uptime | The uptime of the actor |
service.systeminsight.dispatcher
Field | Description |
---|---|
custom | The number of metrics of the category custom that are handled |
host | The number of metrics of the category host that are handled |
mim | The number of metrics of the category mim that are handled |
pico | The number of metrics of the category pico that are handled |
service | The number of metrics of the category service that are handled |
total | The total number of metrics handled |
Note!
If you have activated InfluxDB, the metric service.systeminsight.mediator
is also listed. This metric has the default tags actor_system
, host_system and
pico_instance
.
service.systeminsight.mediator
Field | Description |
---|---|
custom | The number of metrics of the category custom that are handled |
host | The number of metrics of the category host that are handled |
mim | The number of metrics of the category mim that are handled |
pico | The number of metrics of the category pico that are handled |
service | The number of metrics of the category service that are handled |
Default Tag Names
There are default tags in place for some of the metrics.
Metric | Default Tags |
---|---|
host.compute
| host_name , reporting_pico
,
reporting_pico_type
|
host.network | host_name , nic , reporting_pico,
|
host.storage.iostats
| host_name , mount_dir,
reporting_pico,
|
host.storage.swap
| host_name , reporting_pico,
|
host.storage.usage | host_name , mount_dir,
reporting_pico ,
|
pico.events | The tags depend on the events that are run on the pico. |
pico.jvm
|
host_name
,
pico_instance
,
pico_type
|
pico.workflow | time , host , pico_instance , throughput , workflow_folder , workflow_instance , workflow_name |
service.akka.router.receiver
|
actor_system
,
host_system
,
pico_instance
|
service.akka.router.sender
| actor_system , host_system , pico_instance |
service.systeminsight.dispatcher
| actor_system , host_system , pico_instance |
The default tags on a mim
metric are the following:
Tags | Description |
---|---|
agent_category
| The category of the agent, namely, collection , processing or forwarding |
agent_name
| The name of the agent |
host_name
| The name of the host |
pico_instance
| The pico instance |
workflow_folder
| The name of the folder in which the workflow is saved |
workflow_instance
| The name of the running instance of a workflow |
workflow_name
| The name of the workflow configuration |
workflow_type | The type of workflow, namely, batch or realtime |
This section includes the following subsections: