Skip to content

Commit 11f6942

Browse files
committed
Officially remove OpenBSD support
Because we cannot fix the CI issue on OpenBSD and we cannot support it. In case, we keep the code for OpenBSD but it is not tested and we cannot guarantee its correctness.
1 parent f5a52df commit 11f6942

File tree

2 files changed

+29
-26
lines changed

2 files changed

+29
-26
lines changed

.github/workflows/test.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,11 +107,12 @@ jobs:
107107
test-cross-platform:
108108
strategy:
109109
matrix:
110-
# don't forget to update current os versions, see https://github.com/cross-platform-actions/action?tab=readme-ov-file#supported-platforms
111110
include:
112-
- { os: freebsd, version: "14.1", prepare_cmd: "sudo pkg install -y rust cmake rust-bindgen-cli" }
113-
# 7.6 is not supported by [email protected] yet
114-
- { os: openbsd, version: "7.5", prepare_cmd: "sudo pkg_add rust cmake llvm%17; export LIBCLANG_PATH=/usr/local/llvm17/lib" }
111+
- {
112+
os: freebsd,
113+
version: "14.1",
114+
prepare_cmd: "sudo pkg install -y rust cmake rust-bindgen-cli",
115+
}
115116
fail-fast: false
116117
runs-on: ubuntu-latest
117118
name: "test (${{matrix.os}}-${{matrix.version}})"
@@ -127,7 +128,7 @@ jobs:
127128
target/
128129
key: ${{matrix.os}}-${{matrix.version}}-cargo-${{ hashFiles('**/Cargo.lock') }}
129130
- name: Cross-platform test
130-
uses: cross-platform-actions/action@v0.25.0
131+
uses: cross-platform-actions/action@595d543e5d1aeb6d48c0a176965028afe56c7018
131132
with:
132133
operating_system: ${{matrix.os}}
133134
version: "${{matrix.version}}"

README.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@
88
# ⏱ metrics-process
99

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

1615
[Prometheus]: https://prometheus.io/
1716
[process metrics]: https://prometheus.io/docs/instrumenting/writing_clientlibs/#process-metrics
@@ -35,29 +34,32 @@ This crate supports the following metrics provided by [Prometheus] for
3534
| `process_threads` | Number of OS threads in the process. |
3635

3736
For each platform, it is equivalent to what the official Prometheus client for
38-
Go ([client_golang]) provides.
37+
Go ([client_golang]) provides. Note that code for OpenBSD exists but is not
38+
tested and we cannot guarantee its correctness.
3939

4040
> [!NOTE]
4141
>
42-
> Prior to version 2.0.0, the `process_cpu_seconds_total` metric was Gauge instead of Counter.
43-
> Enable `use-gauge-on-cpu-seconds-total` feature to use the previous behavior.
44-
45-
| Metric name | Linux | macOS | Windows | FreeBSD | OpenBSD |
46-
| ---------------------------------- | ----- | ----- | ------- | ------- | ------- |
47-
| `process_cpu_seconds_total` | x | x | x | x | x |
48-
| `process_open_fds` | x | x | x | x | |
49-
| `process_max_fds` | x | x | x | x | x |
50-
| `process_virtual_memory_bytes` | x | x | x | x | |
51-
| `process_virtual_memory_max_bytes` | x | x | | x | |
52-
| `process_resident_memory_bytes` | x | x | x | x | x |
53-
| `process_heap_bytes` | | | | | |
54-
| `process_start_time_seconds` | x | x | x | x | x |
55-
| `process_threads` | x | x | | x | |
42+
> Prior to version 2.0.0, the `process_cpu_seconds_total` metric was Gauge
43+
> instead of Counter. Enable `use-gauge-on-cpu-seconds-total` feature to use the
44+
> previous behavior.
45+
46+
| Metric name | Linux | macOS | Windows | FreeBSD | (OpenBSD) |
47+
| ---------------------------------- | ----- | ----- | ------- | ------- | --------- |
48+
| `process_cpu_seconds_total` | x | x | x | x | x |
49+
| `process_open_fds` | x | x | x | x | |
50+
| `process_max_fds` | x | x | x | x | x |
51+
| `process_virtual_memory_bytes` | x | x | x | x | |
52+
| `process_virtual_memory_max_bytes` | x | x | | x | |
53+
| `process_resident_memory_bytes` | x | x | x | x | x |
54+
| `process_heap_bytes` | | | | | |
55+
| `process_start_time_seconds` | x | x | x | x | x |
56+
| `process_threads` | x | x | | x | |
5657

5758
> [!NOTE]
5859
>
59-
> If you only need to compile this crate on non-supported platforms, you can use the `dummy` feature.
60-
> Enabling this feature activates a dummy collector, which returns an empty `Metrics`.
60+
> If you only need to compile this crate on non-supported platforms, you can use
61+
> the `dummy` feature. Enabling this feature activates a dummy collector, which
62+
> returns an empty `Metrics`.
6163
6264
[client_golang]: https://github.com/prometheus/client_golang
6365

0 commit comments

Comments
 (0)