Skip to content

Commit

Permalink
Update protobuf feature docs
Browse files Browse the repository at this point in the history
Signed-off-by: Folyd <lyshuhow@gmail.com>
  • Loading branch information
Folyd committed Feb 7, 2021
1 parent 2097820 commit 9001ff8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ Find the latest documentation at <https://docs.rs/prometheus>.

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

- `gen`: To generate protobuf client with the latest protobuf version instead of
using the pre-generated client.
- `protobuf`: Enable [Protocol Buffers](https://developers.google.com/protocol-buffers/) (aka Protobuf) based exposition format. (Enabled by default)

> 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).
- `nightly`: Enable nightly only features.

Expand Down
6 changes: 4 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,10 @@ additional functionality.
This library supports four features:
* `gen`: To generate protobuf client with the latest protobuf version instead of
using the pre-generated client.
* `protobuf`: Enable [Protocol Buffers](https://developers.google.com/protocol-buffers/) (aka Protobuf) based exposition format. (Enabled by default)
> 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).
* `nightly`: Enable nightly only features.
* `process`: For collecting process info.
* `push`: Enable push support.
Expand Down

0 comments on commit 9001ff8

Please sign in to comment.