Skip to content

Commit

Permalink
Document OpenBSD support
Browse files Browse the repository at this point in the history
  • Loading branch information
AMDmi3 committed Oct 10, 2024
1 parent 3512bc3 commit da32542
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@
# ⏱ metrics-process

This crate provides a [Prometheus]-style [process metrics] collector for the
[metrics] crate, supporting Linux, macOS, Windows, and FreeBSD. The original
collector code was manually rewritten in Rust from the official Prometheus
client for Go ([client_golang]), FreeBSD support was written from scratch.
[metrics] crate, supporting Linux, macOS, Windows, FreeBSD, and OpenBSD. The
original collector code was manually rewritten in Rust from the official
Prometheus client for Go ([client_golang]), \*BSD support code was written
from scratch.

[Prometheus]: https://prometheus.io/
[process metrics]: https://prometheus.io/docs/instrumenting/writing_clientlibs/#process-metrics
Expand Down Expand Up @@ -41,17 +42,17 @@ Go ([client_golang]) provides.
> Prior to version 2.0.0, the `process_cpu_seconds_total` metric was Gauge instead of Counter.
> Enable `use-gauge-on-cpu-seconds-total` feature to use the previous behavior.
| Metric name | Linux | macOS | Windows | FreeBSD |
| ---------------------------------- | ----- | ----- | ------- | ------- |
| `process_cpu_seconds_total` | x | x | x | x |
| `process_open_fds` | x | x | x | x |
| `process_max_fds` | x | x | x | x |
| `process_virtual_memory_bytes` | x | x | x | x |
| `process_virtual_memory_max_bytes` | x | x | | x |
| `process_resident_memory_bytes` | x | x | x | x |
| `process_heap_bytes` | | | | |
| `process_start_time_seconds` | x | x | x | x |
| `process_threads` | x | x | | x |
| Metric name | Linux | macOS | Windows | FreeBSD | OpenBSD |
| ---------------------------------- | ----- | ----- | ------- | ------- | ------- |
| `process_cpu_seconds_total` | x | x | x | x | x |
| `process_open_fds` | x | x | x | x | |
| `process_max_fds` | x | x | x | x | x |
| `process_virtual_memory_bytes` | x | x | x | x | |
| `process_virtual_memory_max_bytes` | x | x | | x | |
| `process_resident_memory_bytes` | x | x | x | x | x |
| `process_heap_bytes` | | | | | |
| `process_start_time_seconds` | x | x | x | x | x |
| `process_threads` | x | x | | x | |

> [!NOTE]
>
Expand Down

0 comments on commit da32542

Please sign in to comment.