Skip to content

Commit c3c36dd

Browse files
committed
Update protobuf feature docs
1 parent 4fa354d commit c3c36dd

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@ Find the latest documentation at <https://docs.rs/prometheus>.
1818

1919
This crate provides several optional components which can be enabled via [Cargo `[features]`](https://doc.rust-lang.org/cargo/reference/features.html):
2020

21-
- `gen`: To generate protobuf client with the latest protobuf version instead of
22-
using the pre-generated client.
21+
- `protobuf`: Enable [Protocol Buffers](https://developers.google.com/protocol-buffers/) (aka Protobuf) based exposition format. (Enabled by default)
22+
23+
> Notice: Since version 2.0, Prometheus no longer supports the Protobuf-based format. You can read about the reasoning behind this change in [this document](https://github.com/OpenObservability/OpenMetrics/blob/master/legacy/markdown/protobuf_vs_text.md).
2324
2425
- `nightly`: Enable nightly only features.
2526

src/lib.rs

+4-2
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,10 @@ additional functionality.
104104
105105
This library supports four features:
106106
107-
* `gen`: To generate protobuf client with the latest protobuf version instead of
108-
using the pre-generated client.
107+
* `protobuf`: Enable [Protocol Buffers](https://developers.google.com/protocol-buffers/) (aka Protobuf) based exposition format. (Enabled by default)
108+
109+
> Notice: Since version 2.0, Prometheus no longer supports the Protobuf-based format. You can read about the reasoning behind this change in [this document](https://github.com/OpenObservability/OpenMetrics/blob/master/legacy/markdown/protobuf_vs_text.md).
110+
109111
* `nightly`: Enable nightly only features.
110112
* `process`: For collecting process info.
111113
* `push`: Enable push support.

0 commit comments

Comments
 (0)