⏱
metrics-process
This crate provides Prometheus style process metrics collector of metrics crate for Linux, macOS, and Windows. Collector code is manually re-written to Rust from an official prometheus client of go (client_golang)
Supported metrics
This crate supports the following metrics, equal to what official prometheus client of go (client_golang) provides.
| Metric name | Help string | Linux | macOS | Windows |
|---|---|---|---|---|
process_cpu_seconds_total |
Total user and system CPU time spent in seconds. | x | x | x |
process_open_fds |
Number of open file descriptors. | x | x | x |
process_max_fds |
Maximum number of open file descriptors. | x | x | x |
process_virtual_memory_bytes |
Virtual memory size in bytes. | x | x | x |
process_virtual_memory_max_bytes |
Maximum amount of virtual memory available in bytes. | x | x | |
process_resident_memory_bytes |
Resident memory size in bytes. | x | x | x |
process_heap_bytes |
Process heap size in bytes. | |||
process_start_time_seconds |
Start time of the process since unix epoch in seconds. | x | x | x |
process_threads |
Number of OS threads in the process. | x | x |
Usage
Use this crate with metrics-exporter-prometheus as an exporter like:
use std::thread;
use std::time::{Duration, Instant};
use metrics_exporter_prometheus::PrometheusBuilder;
use metrics_process::Collector;
let builder = PrometheusBuilder::new();
builder
.install()
.expect("failed to install Prometheus recorder");
let collector = Collector::default();
// Call `describe()` method to register help string.
collector.describe();
loop {
let s = Instant::now();
// Periodically call `collect()` method to update information.
collector.collect();
thread::sleep(Duration::from_millis(750));
}
Or with axum (or any web application framework you like) to collect metrics whenever the /metrics endpoint is invoked like:
use axum::{routing::get, Router, Server};
use metrics_exporter_prometheus::PrometheusBuilder;
use metrics_process::Collector;
#[tokio::main]
async fn main() {
let builder = PrometheusBuilder::new();
let handle = builder
.install_recorder()
.expect("failed to install Prometheus recorder");
let collector = Collector::default();
// Call `describe()` method to register help string.
collector.describe();
let addr = "127.0.0.1:9000".parse().unwrap();
let app = Router::new().route(
"/metrics",
get(move || {
// Collect information just before handle '/metrics'
collector.collect();
std::future::ready(handle.render())
}),
);
Server::bind(&addr)
.serve(app.into_make_service())
.await
.unwrap();
}
Difference from metrics-process-promstyle
It seems metrics-process-promstyle only support Linux but this crate (metrics-process) supports Linux, macOS, and Windows. Additionally, this crate supports process_open_fds and process_max_fds addition to what metrics-process-promstyle supports.
License
The code follows MIT license written in LICENSE. Contributors need to agree that any modifications sent in this repository follow the license.
3 Dec 4, 2022
341 Feb 6, 2023
462 Mar 6, 2023
282 Apr 16, 2023
4 Aug 12, 2023
3 Oct 24, 2023
21 Dec 29, 2022
85 Nov 23, 2022
2 Dec 15, 2022
2 Jul 3, 2022
1.8k Jan 6, 2023
629 Jan 4, 2023
13 Dec 30, 2022
11 Oct 27, 2023
2 May 2, 2022
80 Feb 22, 2023
3 Sep 21, 2023