1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
//! This is my awesome crate Enabling system metrics from process to be observed using opentelemetry.
//! Current metrics observed are:
//! - CPU
//! - Memory
//! - Disk
//! - Network
//!
//!
//! # Getting started
//!
//! ```
//! use opentelemetry::global;
//! use opentelemetry_system_metrics::init_process_observer;
//!
//! let meter = global::meter("process-meter");
//! init_process_observer(meter);
//! ```
//!
use eyre::Context;
use eyre::ContextCompat;
use eyre::Result;
use nvml_wrapper::enums::device::UsedGpuMemory;
use nvml_wrapper::Nvml;
use opentelemetry::metrics::Unit;
use sysinfo::PidExt;
use sysinfo::ProcessExt;
use sysinfo::SystemExt;
use sysinfo::{get_current_pid, System};
use opentelemetry::metrics::Meter;
use opentelemetry::Key;
const PROCESS_PID: Key = Key::from_static_str("process.pid");
const PROCESS_EXECUTABLE_NAME: Key = Key::from_static_str("process.executable.name");
const PROCESS_EXECUTABLE_PATH: Key = Key::from_static_str("process.executable.path");
const PROCESS_COMMAND: Key = Key::from_static_str("process.command");
// Not implemented yet!
//
// const PROCESS_COMMAND_LINE: Key = Key::from_static_str("process.command_line");
// const PROCESS_COMMAND_ARGS: Key = Key::from_static_str("process.command_args");
// const PROCESS_OWNER: Key = Key::from_static_str("process.owner");
const PROCESS_CPU_USAGE: &str = "process.cpu.usage";
const PROCESS_CPU_UTILIZATION: &str = "process.cpu.utilization";
const PROCESS_MEMORY_USAGE: &str = "process.memory.usage";
const PROCESS_MEMORY_VIRTUAL: &str = "process.memory.virtual";
const PROCESS_DISK_IO: &str = "process.disk.io";
// const PROCESS_NETWORK_IO: &str = "process.network.io";
const DIRECTION: Key = Key::from_static_str("direction");
// const PROCESS_GPU_USAGE: &str = "process.gpu.usage";
const PROCESS_GPU_MEMORY_USAGE: &str = "process.gpu.memory.usage";
// Record asynchronnously information about the current process.
// # Example
//
// ```
// use opentelemetry::global;
// use opentelemetry_system_metrics::init_process_observer;
//
// let meter = global::meter("process-meter");
// init_process_observer(meter);
// ```
//
pub fn init_process_observer(meter: Meter) -> Result<()> {
let pid =
get_current_pid().map_err(|err| eyre::eyre!("could not get current pid. Error: {err}"))?;
let sys_ = System::new_all();
let core_count = sys_
.physical_core_count()
.with_context(|| "Could not get physical core count")?;
let nvml = Nvml::init();
if let Err(err) = &nvml {
tracing::warn!(
"Could not initiate NVML for observing GPU memory usage. Error: {:?}",
err
)
}
let process_cpu_utilization = meter
.f64_observable_gauge(PROCESS_CPU_USAGE)
.with_description("The percentage of CPU in use.")
.init();
let process_cpu_usage = meter
.f64_observable_gauge(PROCESS_CPU_UTILIZATION)
.with_description("The amount of CPU in use.")
.init();
let process_memory_usage = meter
.i64_observable_gauge(PROCESS_MEMORY_USAGE)
.with_description("The amount of physical memory in use.")
.with_unit(Unit::new("byte"))
.init();
let process_memory_virtual = meter
.i64_observable_gauge(PROCESS_MEMORY_VIRTUAL)
.with_description("The amount of committed virtual memory.")
.with_unit(Unit::new("byte"))
.init();
let process_disk_io = meter
.i64_observable_gauge(PROCESS_DISK_IO)
.with_description("Disk bytes transferred.")
.with_unit(Unit::new("byte"))
.init();
let process_gpu_memory_usage = meter
.u64_observable_gauge(PROCESS_GPU_MEMORY_USAGE)
.with_description("The amount of physical GPU memory in use.")
.with_unit(Unit::new("byte"))
.init();
meter
.register_callback(
&[
process_cpu_utilization.as_any(),
process_cpu_usage.as_any(),
process_memory_usage.as_any(),
process_memory_virtual.as_any(),
process_disk_io.as_any(),
process_gpu_memory_usage.as_any(),
],
move |context| {
let mut sys = System::new_all();
sys.refresh_processes();
let common_attributes = if let Some(process) = sys.process(pid) {
[
PROCESS_PID.i64(pid.as_u32().into()),
PROCESS_EXECUTABLE_NAME.string(process.name().to_string()),
PROCESS_EXECUTABLE_PATH.string(process.exe().to_str().unwrap().to_string()),
PROCESS_COMMAND.string(process.cmd().join(" ").to_string()),
]
} else {
unimplemented!()
};
sys.refresh_process(pid);
if let Some(process) = sys.process(pid) {
let cpu_usage = process.cpu_usage();
let disk_io = process.disk_usage();
// let network_io = process.network_usage();
context.observe_f64(&process_cpu_usage, cpu_usage.into(), &[]);
context.observe_f64(
&process_cpu_utilization,
(cpu_usage / core_count as f32).into(),
&common_attributes,
);
context.observe_i64(
&process_memory_usage,
(process.memory()).try_into().unwrap(),
&common_attributes,
);
context.observe_i64(
&process_memory_virtual,
(process.virtual_memory()).try_into().unwrap(),
&common_attributes,
);
context.observe_i64(
&process_disk_io,
disk_io.read_bytes.try_into().unwrap(),
&[common_attributes.as_slice(), &[DIRECTION.string("read")]].concat(),
);
context.observe_i64(
&process_disk_io,
disk_io.written_bytes.try_into().unwrap(),
&[common_attributes.as_slice(), &[DIRECTION.string("write")]].concat(),
);
// result.observe(
// &[common_attributes.as_slice(), &[DIRECTION.string("receive")]].concat(),
// &[process_network_io
// .observe(context,(network_io.received_bytes.try_into().unwrap())],
// );
// result.observe(
// &[
// common_attributes.as_slice(),
// &[DIRECTION.string("transmit")],
// ]
// .concat(),
// &[process_network_io
// .observe(context,(network_io.transmitted_bytes.try_into().unwrap())],
// );
}
// let mut last_timestamp = last_timestamp.lock().unwrap().clone();
if nvml.is_err() {
return;
}
// Get the first `Device` (GPU) in the system
if let Ok(device) = nvml.as_ref().unwrap().device_by_index(0) {
if let Ok(gpu_stats) = device.running_compute_processes() {
for stat in gpu_stats.iter() {
if stat.pid == pid.as_u32() {
let memory_used = match stat.used_gpu_memory {
UsedGpuMemory::Used(bytes) => bytes,
UsedGpuMemory::Unavailable => 0,
};
context.observe_u64(
&process_gpu_memory_usage,
memory_used,
&common_attributes,
);
break;
}
// If the loop finishes and no pid matched our pid, put 0.
context.observe_u64(&process_gpu_memory_usage, 0, &common_attributes);
}
};
}
},
)
.context("could not register traceback")?;
Ok(())
}