Protobuf support #83

ackintosh · 2022-08-29T23:42:18Z

Closes #46

This PR adds protobuf support to the client, which provides functionality to encode metrics to an instance of the OpenMetrics protobuf format.

        let mut registry = Registry::default();

        // ...

        // Encode metrics to an instance of the OpenMetrics protobuf format.
        let metric_set: openmetrics_data_model::MetricSet = encode(&registry);

        for family in metric_set.metric_families {
            println!(family.name);

            for metric in family.metrics {
                // ...
            }
        }

Compile error: error[E0277]: the trait bound `Box<dyn text::SendEncodeMetric>: proto::EncodeMetric` is not satisfied --> src/encoding/proto.rs:151:33 | 151 | println!("{:?}", encode(&registry)); | ------ ^^^^^^^^^ the trait `proto::EncodeMetric` is not implemented for `Box<dyn text::SendEncodeMetric>` | | | required by a bound introduced by this call Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Build error below occurs: error[E0207]: the lifetime parameter `'a` is not constrained by the impl trait, self type, or predicates --> src/encoding/proto.rs:199:6 | 199 | impl<'a, N, A> EncodeMetric for Counter<N, A> | ^^ unconstrained lifetime parameter Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Build error: error[E0207]: the lifetime parameter `'a` is not constrained by the impl trait, self type, or predicates --> src/encoding/proto.rs:199:6 | 199 | impl<'a, N, A> EncodeMetric for Counter<N, A> | ^^ unconstrained lifetime parameter Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

…e they could be elided https://rust-lang.github.io/rust-clippy/master/index.html#needless_lifetimes Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

https://rust-lang.github.io/rust-clippy/master/index.html#map_flatten Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

… file Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

`not found in this scope` error occurs when no feature specified Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

…theus_client::encoding` Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

ackintosh · 2022-09-07T02:48:01Z

Merged the two derive crates
Fixed missing docs
Fixed clippy warnings
Moved Encode trait
Added a changelog entry and bumped up the minor version

@mxinden Please have another look. 🙏

mxinden · 2022-09-07T07:52:56Z

Thanks for the follow-ups. I kicked off CI, which is complaining. Can you take a look?

divagant-martian · 2022-09-08T21:49:29Z

most if not all the problems are tackled in ackintosh#7

divagant-martian · 2022-09-08T22:57:02Z

derive-encode/src/lib.rs

+                        quote! {
+                            let mut label = prometheus_client::encoding::proto::Label::default();
+                            label.name = #ident_string.to_string();
+                            label.value = format!("{}", self.#ident);


This imposes a Display requirement on the fields of a struct. Is this actually needed? if so it would be good to document it somewhere because it's unexpected

Thank you for pointing it out. I'm working on that in ackintosh#9.

ackintosh#9 has been merged into this PR.

ackintosh · 2022-09-10T00:53:53Z

Ahh, Signed-off-by is required...

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

- `assert!(false, ..)` should probably be replaced - redundant clone - field assignment outside of initializer for an instance created with Default::default()

Remove a `Display` requirement and fix CI errors

ackintosh · 2022-09-10T03:16:06Z

@mxinden @divagant-martian

Removed a Display requirement from the derive macro (8baf256) and fixed CI errors. I checked that all checks have passed on my repo. ackintosh#9

mxinden

Wonderful work. I will cut a release soonish.

Thank you @ackintosh for tackling this large project!

mxinden · 2022-09-07T07:37:59Z

CHANGELOG.md

+
+### Changed
+
+- Move`Encode` trait from `prometheus_client::encoding::text` to `prometheus_client::encoding`. See [PR 83].


ackintosh · 2022-09-11T21:34:02Z

Thank you so much for your help! ✨ @mxinden @divagant-martian

ackintosh and others added 30 commits August 30, 2022 08:29

src/encoding/proto: Construct Registry with proto::EncodeMetric

e2e96f9

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Implement encoding for labels

abb66df

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Implement encoding for CounterWithExemplar

33b527f

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Move comment

a3e6afc

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Implement encoding for Gauge

c3bb963

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Implement encoding for Histogram

d29e2d3

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Tweak function name according to encoding::text

18ca645

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Implement encoding for HistogramWithExemplars

9c97af5

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Move function for readability

ca45f64

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Implement encoding for Info

d76e7a0

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Add tests for Counter

4b31a21

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Add assertions for MetricType

571c707

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: DRY-ed tests with extract_metric_point_value

84a0745

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Assert name and help

90d8b00

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Refactor: use associated constants

03fc057

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Add assertions for counter.exemplar

745160c

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Add assertion for Unit

4b839c9

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Refactoring: extract a method Unit::as_str()

202d457

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Remove superfluous comments

2e7e35a

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Add tests for Family

bd90dc3

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Remove redundant test

c1b38a2

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Add doc

92b4493

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Introduce protobuf feature

3cfe085

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

src/encoding/proto: Refactoring for loop

ee6344a

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Implement proc macro EncodeProtobuf

cc0df24

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Add impl EncodeGaugeValue for u64

7040f2a

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Make EncodeLabel::encode return iterator

49a3dfb

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

ackintosh added 7 commits September 7, 2022 10:34

Fix clippy warnings: explicit lifetimes given in parameter types wher…

cc9f739

…e they could be elided https://rust-lang.github.io/rust-clippy/master/index.html#needless_lifetimes Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Fix clippy warnings: called map(..).flatten() on Option

d106aa3

https://rust-lang.github.io/rust-clippy/master/index.html#map_flatten Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Allow some lint warnings on openmetrics.rs which is an auto-generated…

77c9c22

… file Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Remove unnecessary cfg

ec56224

`not found in this scope` error occurs when no feature specified Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

MoveEncode trait from prometheus_client::encoding::text to `prome…

d992bad

…theus_client::encoding` Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Bump up the minor version as the unreleased contains breaking changes

8fce756

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

Update a link to PR

639cb0a

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

divagant-martian reviewed Sep 8, 2022

View reviewed changes

misc fixes

ca0f583

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

ackintosh force-pushed the protobuf branch from 3270f76 to ca0f583 Compare September 10, 2022 01:06

Remove a Display requirement

8baf256

Signed-off-by: ackintosh <sora.akatsuki@gmail.com>

ackintosh mentioned this pull request Sep 10, 2022

Remove a Display requirement and fix CI errors ackintosh/client_rust#9

Merged

ackintosh added 6 commits September 10, 2022 10:17

Remove unnecessary Display implementation

3a2190d

Disambiguate Encode

396512f

Fix cannot find derive macro Encode in this scope in docs

20fd62e

Fix clippy warnings

8ac25a5

- `assert!(false, ..)` should probably be replaced - redundant clone - field assignment outside of initializer for an instance created with Default::default()

Don't use AtomicI64 on unsupported platforms

f5b61f1

Merge pull request #9 from ackintosh/remove-display

69f85ba

Remove a `Display` requirement and fix CI errors

mxinden approved these changes Sep 11, 2022

View reviewed changes

mxinden merged commit ffc2ab6 into prometheus:master Sep 11, 2022

mxinden mentioned this pull request Sep 11, 2022

README.md: Remove mention of missing Protobuf #88

Merged

ackintosh deleted the protobuf branch September 11, 2022 21:27

ackintosh mentioned this pull request Sep 18, 2022

protocols/gossipsub: Enable the protobuf feature of prometheus-client libp2p/rust-libp2p#2911

Closed

4 tasks

mxinden mentioned this pull request Sep 21, 2022

impl TypedMetric for Counter/HistogramWithExemplars #96

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Protobuf support #83

Protobuf support #83

ackintosh commented Aug 29, 2022

ackintosh commented Sep 7, 2022

mxinden commented Sep 7, 2022

divagant-martian commented Sep 8, 2022

divagant-martian Sep 8, 2022

ackintosh Sep 10, 2022

ackintosh Sep 10, 2022

ackintosh commented Sep 10, 2022

ackintosh commented Sep 10, 2022

mxinden left a comment

mxinden Sep 7, 2022

ackintosh commented Sep 11, 2022


		### Changed

		- Move`Encode` trait from `prometheus_client::encoding::text` to `prometheus_client::encoding`. See [PR 83].

Protobuf support #83

Protobuf support #83

Conversation

ackintosh commented Aug 29, 2022

ackintosh commented Sep 7, 2022

mxinden commented Sep 7, 2022

divagant-martian commented Sep 8, 2022

divagant-martian Sep 8, 2022

Choose a reason for hiding this comment

ackintosh Sep 10, 2022

Choose a reason for hiding this comment

ackintosh Sep 10, 2022

Choose a reason for hiding this comment

ackintosh commented Sep 10, 2022

ackintosh commented Sep 10, 2022

mxinden left a comment

Choose a reason for hiding this comment

mxinden Sep 7, 2022

Choose a reason for hiding this comment

ackintosh commented Sep 11, 2022