Process Stats

Learn how to view resource usage statistics of specific processes with this comprehensive guide. Discover how to specify process names in the config.toml file and access the uplink_process_stats stream. Explore the various fields available, such as PID, s

Process stats allow you to monitor individual processes. To enable process stats we need to modify uplink’s config.toml file to mention the process names that need monitoring. If you have followed the setup guide, this file should be present in /usr/share/local/byebeam. Add the below section to config.toml

[system_stats]
enabled = true
process_names = ["uplink", "journalctl"]
update_period = 30

NOTE: The names of processes mentioned in the config should be the same as those in the output of ps -eaf

The stream corresponding to process stats is uplink_process_stats. This stream has the below fields

Field name	Description
pid	This field corresponds to a particular process’s ID.
start_time	Time at which the process had started execution.
cpu_usage	Percentage of CPU being used by the process.
mem_usage	RAM is used by the process, in bytes.
disk_read_bytes	The number of bytes of data read from the disk(or storage device) since the last update.
disk_total_read_bytes	Total number of bytes of data written to the disk(or storage device) since the last update.
disk_write_bytes	A number of bytes of data read from the disk(or storage device) since the last update.
disk_total_write_bytes	Total number of bytes of data written to the disk(or storage device).