.github/workflows/rust.yml

@@ -26,12 +26,12 @@ jobs:
 
       # Caching
       - name: Cache cargo registry
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: ~/.cargo/registry
           key: cargo-registry-${{ hashFiles('Cargo.toml') }}
       - name: Cache cargo index
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: ~/.cargo/git
           key: cargo-index-${{ hashFiles('Cargo.toml') }}
@@ -68,12 +68,12 @@ jobs:
 
       # Caching
       - name: Cache cargo registry
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: ~/.cargo/registry
           key: cargo-registry-${{ hashFiles('Cargo.toml') }}
       - name: Cache cargo index
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: ~/.cargo/git
           key: cargo-index-${{ hashFiles('Cargo.toml') }}
@@ -121,12 +121,12 @@ jobs:
 
       # Caching
       - name: Cache cargo registry
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: ~/.cargo/registry
           key: cargo-registry-${{ hashFiles('Cargo.toml') }}
       - name: Cache cargo index
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: ~/.cargo/git
           key: cargo-index-${{ hashFiles('Cargo.toml') }}

CHANGELOG.md

@@ -4,6 +4,95 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.24.0] - unreleased
+
+### Added
+
+- `EncodeLabelSet` is now implemented for tuples `(A: EncodeLabelSet, B: EncodeLabelSet)`.
+   See [PR 257].
+
+- `Family::get_or_create_owned` can access a metric in a labeled family. This
+   method avoids the risk of runtime deadlocks at the expense of creating an
+   owned type. See [PR 244].
+
+[PR 244]: https://github.com/prometheus/client_rust/pull/244
+[PR 257]: https://github.com/prometheus/client_rust/pull/257
+
+### Changed
+
+- `EncodeLabelSet::encode()` now accepts a mutable reference to its encoder parameter.
+
+## [0.23.1]
+
+### Changed
+
+- `Histogram::new` now accepts an `IntoIterator` argument, rather than an `Iterator`.
+  See [PR 243].
+
+[PR 243]: https://github.com/prometheus/client_rust/pull/243
+
+## [0.23.0]
+
+### Changed
+
+- `ConstCounter::new` now requires specifying the type of literal arguments, like this: `ConstCounter::new(42u64);`.
+  See [PR 173].
+
+- Update `prost` dependencies to `v0.12`.
+  See [PR 198].
+
+- Implement `Atomic<u64>` for `AtomicU64` for gauges.
+  See [PR 226].
+
+- Implement `EnableLabelValue` for `bool`.
+  See [PR 237]
+
+[PR 173]: https://github.com/prometheus/client_rust/pull/173
+[PR 198]: https://github.com/prometheus/client_rust/pull/198
+[PR 226]: https://github.com/prometheus/client_rust/pull/226
+[PR 237]: https://github.com/prometheus/client_rust/pull/237
+
+### Added
+
+- Support `i32`/`f32` for `Gauge` and `u32`/`f32` for `Counter`/`CounterWithExemplar`.
+  See [PR 173] and [PR 216].
+
+- Supoort `Arc<String>` for `EncodeLabelValue`.
+  See [PR 217].
+
+- Add `histogram::exponential_buckets_range`.
+  See [PR 233].
+
+- Added `get` method to `Family`.
+  See [PR 234].
+
+[PR 173]: https://github.com/prometheus/client_rust/pull/173
+[PR 216]: https://github.com/prometheus/client_rust/pull/216
+[PR 217]: https://github.com/prometheus/client_rust/pull/217
+[PR 233]: https://github.com/prometheus/client_rust/pull/233
+[PR 234]: https://github.com/prometheus/client_rust/pull/234
+
+### Fixed
+
+- Don't prepend `,` when encoding empty family label set.
+  See [PR 175].
+
+[PR 175]: https://github.com/prometheus/client_rust/pull/175
+
+## [0.22.3]
+
+### Added
+
+- Added `encode_registry` and `encode_eof` functions to `text` module.
+  See [PR 205].
+
+  [PR 205]: https://github.com/prometheus/client_rust/pull/205
+
+- Support all platforms with 32 bit atomics lacking 64 bit atomics.
+  See [PR 203].
+
+[PR 203]: https://github.com/prometheus/client_rust/pull/203
+
 ## [0.22.2]
 
 ### Added

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing
+
+## Protocol Buffers
+
+The `build.rs` script in this library depends upon the
+[Protocol Buffers compiler][protoc]. Be sure that `protoc` is installed and
+available within your `PATH`.
+
+[protoc]: https://docs.rs/prost-build/latest/prost_build/#sourcing-protoc
+
+## Python Dependencies
+
+This repository uses the [`prometheus-client`][client-python] Python client
+library in its test suite.
+
+You may create and activate a virtual environment with this dependency
+installed by running the following shell commands from the root of this
+repository:
+
+```shell
+python -m venv ./venv
+source venv/bin/activate
+pip install prometheus-client
+```
+
+[client-python]: https://github.com/prometheus/client_python

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "prometheus-client"
-version = "0.22.2"
+version = "0.24.0"
 authors = ["Max Inden <mail@max-inden.de>"]
 edition = "2021"
 description = "Open Metrics client library allowing users to natively instrument applications."
@@ -21,24 +21,28 @@ members = ["derive-encode"]
 dtoa = "1.0"
 itoa = "1.0"
 parking_lot = "0.12"
-prometheus-client-derive-encode = { version = "0.4.1", path = "derive-encode" }
-prost = { version = "0.11.0", optional = true }
-prost-types = { version = "0.11.0", optional = true }
+prometheus-client-derive-encode = { version = "0.5.0", path = "derive-encode" }
+prost = { version = "0.12.0", optional = true }
+prost-types = { version = "0.12.0", optional = true }
 
 [dev-dependencies]
 async-std = { version = "1", features = ["attributes"] }
+axum = "0.7"
 criterion = "0.5"
+futures = "0.3"
 http-types = "2"
-pyo3 = "0.20"
+pyo3 = "0.22"
 quickcheck = "1"
 rand = "0.8.4"
 tide = "0.16"
 actix-web = "4"
 tokio = { version = "1", features = ["rt-multi-thread", "net", "macros", "signal"] }
-hyper = { version = "0.14.16", features = ["server", "http1", "tcp"] }
+hyper = { version = "1.3.1", features = ["server", "http1"] }
+hyper-util = { version = "0.1.3", features = ["tokio"] }
+http-body-util = "0.1.1"
 
 [build-dependencies]
-prost-build = { version = "0.11.0", optional = true }
+prost-build = { version = "0.12.0", optional = true }
 
 [[bench]]
 name = "baseline"
@@ -59,3 +63,8 @@ name = "proto"
 path = "benches/encoding/proto.rs"
 harness = false
 required-features = ["protobuf"]
+
+# Passing arguments to the docsrs builder in order to properly document cfg's.
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true

derive-encode/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "prometheus-client-derive-encode"
-version = "0.4.2"
+version = "0.5.0"
 authors = ["Max Inden <mail@max-inden.de>"]
 edition = "2021"
 description = "Auxiliary crate to derive Encode trait from prometheus-client."
@@ -18,6 +18,7 @@ syn = "2"
 
 [dev-dependencies]
 prometheus-client = { path = "../", features = ["protobuf"] }
+trybuild = "1"
 
 [lib]
-proc-macro = true
+proc-macro = true

derive-encode/src/lib.rs

@@ -71,15 +71,15 @@ pub fn derive_encode_label_set(input: TokenStream) -> TokenStream {
     };
 
     let gen = quote! {
-        impl prometheus_client::encoding::EncodeLabelSet for #name {
-            fn encode(&self, mut encoder: prometheus_client::encoding::LabelSetEncoder) -> std::result::Result<(), std::fmt::Error> {
-                use prometheus_client::encoding::EncodeLabel;
-                use prometheus_client::encoding::EncodeLabelKey;
-                use prometheus_client::encoding::EncodeLabelValue;
+        impl ::prometheus_client::encoding::EncodeLabelSet for #name {
+            fn encode(&self, encoder: &mut ::prometheus_client::encoding::LabelSetEncoder) -> ::core::result::Result<(), ::core::fmt::Error> {
+                use ::prometheus_client::encoding::EncodeLabel;
+                use ::prometheus_client::encoding::EncodeLabelKey;
+                use ::prometheus_client::encoding::EncodeLabelValue;
 
                 #body
 
-                Ok(())
+                ::core::result::Result::Ok(())
             }
         }
     };
@@ -118,13 +118,13 @@ pub fn derive_encode_label_value(input: TokenStream) -> TokenStream {
     };
 
     let gen = quote! {
-        impl prometheus_client::encoding::EncodeLabelValue for #name {
-            fn encode(&self, encoder: &mut prometheus_client::encoding::LabelValueEncoder) -> std::result::Result<(), std::fmt::Error> {
-                use std::fmt::Write;
+        impl ::prometheus_client::encoding::EncodeLabelValue for #name {
+            fn encode(&self, encoder: &mut ::prometheus_client::encoding::LabelValueEncoder) -> ::core::result::Result<(), ::core::fmt::Error> {
+                use ::core::fmt::Write;
 
                 #body
 
-                Ok(())
+                ::core::result::Result::Ok(())
             }
         }
     };

derive-encode/tests/build/redefine-prelude-symbols.rs

@@ -0,0 +1,36 @@
+#![allow(unused_imports)]
+
+// Empty module has nothing and can be used to redefine symbols.
+mod empty {}
+
+// redefine the prelude `::std`
+use empty as std;
+
+// redefine the dependency `::prometheus_client`
+use empty as prometheus_client;
+
+// redefine the prelude `::core::result::Result`.
+type Result = ();
+
+enum TResult {
+    Ok,
+    Err,
+}
+
+// redefine the prelude `::core::result::Result::Ok/Err`.
+use TResult::Ok;
+use TResult::Err;
+
+#[derive(Debug, Clone, PartialEq, Eq, Hash, ::prometheus_client::encoding::EncodeLabelSet)]
+struct LableSet {
+    a: String,
+    b: LabelEnum,
+}
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, ::prometheus_client::encoding::EncodeLabelValue)]
+enum LabelEnum {
+    A,
+    B,
+}
+
+fn main() {}

derive-encode/tests/lib.rs

@@ -1,3 +1,5 @@
+use std::sync::Arc;
+
 use prometheus_client::encoding::text::encode;
 use prometheus_client::encoding::{EncodeLabelSet, EncodeLabelValue};
 use prometheus_client::metrics::counter::Counter;
@@ -137,6 +139,36 @@ fn remap_keyword_identifiers() {
     assert_eq!(expected, buffer);
 }
 
+#[test]
+fn arc_string() {
+    #[derive(EncodeLabelSet, Hash, Clone, Eq, PartialEq, Debug)]
+    struct Labels {
+        client_id: Arc<String>,
+    }
+
+    let mut registry = Registry::default();
+    let family = Family::<Labels, Counter>::default();
+    registry.register("my_counter", "This is my counter", family.clone());
+
+    // Record a single HTTP GET request.
+    let client_id = Arc::new("client_id".to_string());
+    family
+        .get_or_create(&Labels {
+            client_id: client_id.clone(),
+        })
+        .inc();
+
+    // Encode all metrics in the registry in the text format.
+    let mut buffer = String::new();
+    encode(&mut buffer, &registry).unwrap();
+
+    let expected = "# HELP my_counter This is my counter.\n".to_owned()
+        + "# TYPE my_counter counter\n"
+        + "my_counter_total{client_id=\"client_id\"} 1\n"
+        + "# EOF\n";
+    assert_eq!(expected, buffer);
+}
+
 #[test]
 fn flatten() {
     #[derive(EncodeLabelSet, Hash, Clone, Eq, PartialEq, Debug)]
@@ -173,3 +205,9 @@ fn flatten() {
         + "# EOF\n";
     assert_eq!(expected, buffer);
 }
+
+#[test]
+fn build() {
+    let t = trybuild::TestCases::new();
+    t.pass("tests/build/redefine-prelude-symbols.rs")
+}

examples/actix-web.rs

@@ -1,5 +1,6 @@
 use std::sync::Mutex;
 
+use actix_web::middleware::Compress;
 use actix_web::{web, App, HttpResponse, HttpServer, Responder, Result};
 use prometheus_client::encoding::text::encode;
 use prometheus_client::encoding::{EncodeLabelSet, EncodeLabelValue};
@@ -61,6 +62,7 @@ async fn main() -> std::io::Result<()> {
 
     HttpServer::new(move || {
         App::new()
+            .wrap(Compress::default())
             .app_data(metrics.clone())
             .app_data(state.clone())
             .service(web::resource("/metrics").route(web::get().to(metrics_handler)))