Skip to content

Commit 3fd8bb0

Browse files
akhramovakhramov
committed
Prometheus push gateway: opt-out of the default tls provider
This is a follow up to metrics-rs#516, metrics-rs#516 (comment). This change makes it possible for downstream projects to opt-out of the default rustls provider (aws-lc-rs). Hopefully closes metrics-rs#515
1 parent a44949c commit 3fd8bb0

File tree

7 files changed

+118
-31
lines changed

7 files changed

+118
-31
lines changed

‎Cargo.lock‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ hashbrown = { version = "0.15", default-features = false, features = ["default-h
3434
hdrhistogram = { version = "7.2", default-features = false }
3535
http-body-util = { version = "0.1", default-features = false }
3636
hyper = { version = "1.1", default-features = false, features = ["server", "client"] }
37-
hyper-rustls = { version = "0.27", default-features = false, features = ["aws-lc-rs", "http1", "rustls-native-certs"] }
37+
hyper-rustls = { version = "0.27", default-features = false, features = ["http1", "rustls-native-certs"] }
3838
hyper-util = { version = "0.1", default-features = false, features = ["tokio", "service", "client", "client-legacy", "http1"] }
3939
indexmap = { version = "2.6", default-features = false, features = ["std"] }
4040
ipnet = { version = "2", default-features = false, features = ["std"] }
@@ -66,6 +66,7 @@ radix_trie = { version = "0.2", default-features = false }
6666
rand = { version = "0.9", default-features = false, features = [ "thread_rng" ] }
6767
rand_xoshiro = { version = "0.7", default-features = false }
6868
ratatui = { version = "0.28", default-features = false }
69+
rustls = { version = "0.23", default-features = false }
6970
sketches-ddsketch = { version = "0.3", default-features = false }
7071
thiserror = { version = "2", default-features = false }
7172
tokio = { version = "1", default-features = false, features = ["rt", "net", "time", "rt-multi-thread"] }

‎metrics-exporter-prometheus/Cargo.toml‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,16 @@ default = ["http-listener", "push-gateway"]
2020
async-runtime = ["tokio", "hyper-util/tokio"]
2121
http-listener = ["async-runtime", "ipnet", "tracing", "_hyper-server"]
2222
uds-listener = ["http-listener"]
23-
push-gateway = ["async-runtime", "tracing", "_hyper-client"]
23+
push-gateway = ["_push-gateway-common", "hyper-rustls/aws-lc-rs"]
24+
push-gateway-no-tls-provider = ["_push-gateway-common"]
2425
protobuf = ["mime", "prost", "prost-types", "prost-build"]
2526
_hyper-server = ["http-body-util", "hyper/server", "hyper-util/server-auto"]
27+
_push-gateway-common = [
28+
"async-runtime",
29+
"rustls",
30+
"tracing",
31+
"_hyper-client",
32+
]
2633
_hyper-client = [
2734
"http-body-util",
2835
"hyper/client",
@@ -34,9 +41,11 @@ _hyper-client = [
3441

3542
[dependencies]
3643
base64 = { workspace = true }
37-
http-body-util = { workspace = true, optional = true }
44+
quanta = { workspace = true }
45+
thiserror = { workspace = true }
3846

3947
# Optional
48+
http-body-util = { workspace = true, optional = true }
4049
hyper = { workspace = true, optional = true }
4150
hyper-rustls = { workspace = true, optional = true }
4251
hyper-util = { workspace = true, optional = true }
@@ -48,8 +57,7 @@ metrics-util = { version = "^0.20", path = "../metrics-util", default-features =
4857
"registry",
4958
"storage",
5059
] }
51-
quanta = { workspace = true }
52-
thiserror = { workspace = true }
60+
rustls = { workspace = true, optional = true }
5361
tokio = { workspace = true, optional = true }
5462
tracing = { workspace = true, optional = true }
5563

‎metrics-exporter-prometheus/src/exporter/builder.rs‎

Lines changed: 52 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
use std::collections::HashMap;
2-
#[cfg(feature = "push-gateway")]
2+
#[cfg(any(feature = "push-gateway", feature = "push-gateway-no-tls-provider"))]
33
use std::convert::TryFrom;
44
#[cfg(feature = "http-listener")]
55
use std::net::{IpAddr, Ipv4Addr, SocketAddr};
66
use std::num::NonZeroU32;
77
use std::sync::RwLock;
8-
#[cfg(any(feature = "http-listener", feature = "push-gateway"))]
8+
#[cfg(any(
9+
feature = "http-listener",
10+
feature = "push-gateway",
11+
feature = "push-gateway-no-tls-provider"
12+
))]
913
use std::thread;
1014
use std::time::Duration;
1115

12-
#[cfg(feature = "push-gateway")]
16+
#[cfg(any(feature = "push-gateway", feature = "push-gateway-no-tls-provider"))]
1317
use hyper::Uri;
1418
use indexmap::IndexMap;
1519
#[cfg(feature = "http-listener")]
@@ -29,13 +33,24 @@ use crate::registry::AtomicStorage;
2933
use crate::{common::BuildError, PrometheusHandle};
3034

3135
use super::ExporterConfig;
32-
#[cfg(any(feature = "http-listener", feature = "push-gateway"))]
36+
#[cfg(any(
37+
feature = "http-listener",
38+
feature = "push-gateway",
39+
feature = "push-gateway-no-tls-provider"
40+
))]
3341
use super::ExporterFuture;
3442

3543
/// Builder for creating and installing a Prometheus recorder/exporter.
3644
#[derive(Debug)]
3745
pub struct PrometheusBuilder {
38-
#[cfg_attr(not(any(feature = "http-listener", feature = "push-gateway")), allow(dead_code))]
46+
#[cfg_attr(
47+
not(any(
48+
feature = "http-listener",
49+
feature = "push-gateway",
50+
feature = "push-gateway-no-tls-provider"
51+
)),
52+
allow(dead_code)
53+
)]
3954
exporter_config: ExporterConfig,
4055
#[cfg(feature = "http-listener")]
4156
allowed_addresses: Option<Vec<IpNet>>,
@@ -120,8 +135,11 @@ impl PrometheusBuilder {
120135
/// If the given endpoint cannot be parsed into a valid URI, an error variant will be returned describing the error.
121136
///
122137
/// [push gateway]: https://prometheus.io/docs/instrumenting/pushing/
123-
#[cfg(feature = "push-gateway")]
124-
#[cfg_attr(docsrs, doc(cfg(feature = "push-gateway")))]
138+
#[cfg(any(feature = "push-gateway", feature = "push-gateway-no-tls-provider"))]
139+
#[cfg_attr(
140+
docsrs,
141+
doc(cfg(any(feature = "push-gateway", feature = "push-gateway-no-tls-provider")))
142+
)]
125143
pub fn with_push_gateway<T>(
126144
mut self,
127145
endpoint: T,
@@ -399,8 +417,19 @@ impl PrometheusBuilder {
399417
///
400418
/// If there is an error while either building the recorder and exporter, or installing the recorder and exporter,
401419
/// an error variant will be returned describing the error.
402-
#[cfg(any(feature = "http-listener", feature = "push-gateway"))]
403-
#[cfg_attr(docsrs, doc(cfg(any(feature = "http-listener", feature = "push-gateway"))))]
420+
#[cfg(any(
421+
feature = "http-listener",
422+
feature = "push-gateway",
423+
feature = "push-gateway-no-tls-provider"
424+
))]
425+
#[cfg_attr(
426+
docsrs,
427+
doc(cfg(any(
428+
feature = "http-listener",
429+
feature = "push-gateway",
430+
feature = "push-gateway-no-tls-provider"
431+
)))
432+
)]
404433
pub fn install(self) -> Result<(), BuildError> {
405434
use tokio::runtime;
406435

@@ -476,8 +505,19 @@ impl PrometheusBuilder {
476505
/// If there is an error while building the recorder and exporter, an error variant will be returned describing the
477506
/// error.
478507
#[warn(clippy::too_many_lines)]
479-
#[cfg(any(feature = "http-listener", feature = "push-gateway"))]
480-
#[cfg_attr(docsrs, doc(cfg(any(feature = "http-listener", feature = "push-gateway"))))]
508+
#[cfg(any(
509+
feature = "http-listener",
510+
feature = "push-gateway",
511+
feature = "push-gateway-no-tls-provider"
512+
))]
513+
#[cfg_attr(
514+
docsrs,
515+
doc(cfg(any(
516+
feature = "http-listener",
517+
feature = "push-gateway",
518+
feature = "push-gateway-no-tls-provider"
519+
)))
520+
)]
481521
#[cfg_attr(not(feature = "http-listener"), allow(unused_mut))]
482522
pub fn build(mut self) -> Result<(PrometheusRecorder, ExporterFuture), BuildError> {
483523
#[cfg(feature = "http-listener")]
@@ -516,7 +556,7 @@ impl PrometheusBuilder {
516556
}
517557
},
518558

519-
#[cfg(feature = "push-gateway")]
559+
#[cfg(any(feature = "push-gateway", feature = "push-gateway-no-tls-provider"))]
520560
ExporterConfig::PushGateway {
521561
endpoint,
522562
interval,

‎metrics-exporter-prometheus/src/exporter/mod.rs‎

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
11
#[cfg(feature = "http-listener")]
22
use http_listener::HttpListeningError;
3-
#[cfg(any(feature = "http-listener", feature = "push-gateway"))]
3+
#[cfg(any(
4+
feature = "http-listener",
5+
feature = "push-gateway",
6+
feature = "push-gateway-no-tls-provider"
7+
))]
48
use std::future::Future;
59
#[cfg(feature = "http-listener")]
610
use std::net::SocketAddr;
7-
#[cfg(any(feature = "http-listener", feature = "push-gateway"))]
11+
#[cfg(any(
12+
feature = "http-listener",
13+
feature = "push-gateway",
14+
feature = "push-gateway-no-tls-provider"
15+
))]
816
use std::pin::Pin;
9-
#[cfg(feature = "push-gateway")]
17+
#[cfg(any(feature = "push-gateway", feature = "push-gateway-no-tls-provider"))]
1018
use std::time::Duration;
1119

12-
#[cfg(feature = "push-gateway")]
20+
#[cfg(any(feature = "push-gateway", feature = "push-gateway-no-tls-provider"))]
1321
use hyper::Uri;
1422

1523
/// Error types possible from an exporter
16-
#[cfg(any(feature = "http-listener", feature = "push-gateway"))]
24+
#[cfg(any(
25+
feature = "http-listener",
26+
feature = "push-gateway",
27+
feature = "push-gateway-no-tls-provider"
28+
))]
1729
#[derive(Debug)]
1830
pub enum ExporterError {
1931
#[cfg(feature = "http-listener")]
2032
HttpListener(HttpListeningError),
2133
PushGateway(()),
2234
}
2335
/// Convenience type for Future implementing an exporter.
24-
#[cfg(any(feature = "http-listener", feature = "push-gateway"))]
36+
#[cfg(any(
37+
feature = "http-listener",
38+
feature = "push-gateway",
39+
feature = "push-gateway-no-tls-provider"
40+
))]
2541
pub type ExporterFuture = Pin<Box<dyn Future<Output = Result<(), ExporterError>> + Send + 'static>>;
2642

2743
#[cfg(feature = "http-listener")]
@@ -40,7 +56,7 @@ enum ExporterConfig {
4056

4157
// Run a push gateway task sending to the given `endpoint` after `interval` time has elapsed,
4258
// infinitely.
43-
#[cfg(feature = "push-gateway")]
59+
#[cfg(any(feature = "push-gateway", feature = "push-gateway-no-tls-provider"))]
4460
PushGateway {
4561
endpoint: Uri,
4662
interval: Duration,
@@ -54,12 +70,19 @@ enum ExporterConfig {
5470
}
5571

5672
impl ExporterConfig {
57-
#[cfg_attr(not(any(feature = "http-listener", feature = "push-gateway")), allow(dead_code))]
73+
#[cfg_attr(
74+
not(any(
75+
feature = "http-listener",
76+
feature = "push-gateway",
77+
feature = "push-gateway-no-tls-provider"
78+
)),
79+
allow(dead_code)
80+
)]
5881
fn as_type_str(&self) -> &'static str {
5982
match self {
6083
#[cfg(feature = "http-listener")]
6184
Self::HttpListener { .. } => "http-listener",
62-
#[cfg(feature = "push-gateway")]
85+
#[cfg(any(feature = "push-gateway", feature = "push-gateway-no-tls-provider"))]
6386
Self::PushGateway { .. } => "push-gateway",
6487
Self::Unconfigured => "unconfigured,",
6588
}
@@ -69,7 +92,7 @@ impl ExporterConfig {
6992
#[cfg(feature = "http-listener")]
7093
mod http_listener;
7194

72-
#[cfg(feature = "push-gateway")]
95+
#[cfg(any(feature = "push-gateway", feature = "push-gateway-no-tls-provider"))]
7396
mod push_gateway;
7497

7598
pub(crate) mod builder;

‎metrics-exporter-prometheus/src/exporter/push_gateway.rs‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ use http_body_util::{BodyExt, Collected, Full};
44
use hyper::body::Bytes;
55
use hyper::{header::HeaderValue, Method, Request, Uri};
66
use hyper_util::{client::legacy::Client, rt::TokioExecutor};
7+
use rustls::crypto::CryptoProvider;
78
use tracing::error;
89

910
use super::ExporterFuture;
@@ -20,8 +21,10 @@ pub(super) fn new_push_gateway(
2021
) -> ExporterFuture {
2122
let http_method = if use_http_post_method { Method::POST } else { Method::PUT };
2223
Box::pin(async move {
24+
let provider = CryptoProvider::get_default()
25+
.expect("no process-level CryptoProvider available -- call rustls' CryptoProvider::install_default() before this point");
2326
let https = hyper_rustls::HttpsConnectorBuilder::new()
24-
.with_native_roots()
27+
.with_provider_and_native_roots(provider.clone())
2528
.expect("no native root CA certificates found")
2629
.https_or_http()
2730
.enable_http1()
@@ -79,7 +82,7 @@ pub(super) fn new_push_gateway(
7982
})
8083
}
8184

82-
#[cfg(feature = "push-gateway")]
85+
#[cfg(any(feature = "push-gateway", feature = "push-gateway-no-tls-provider"))]
8386
fn basic_auth(username: &str, password: Option<&str>) -> HeaderValue {
8487
use base64::prelude::BASE64_STANDARD;
8588
use base64::write::EncoderWriter;

‎metrics-exporter-prometheus/src/lib.rs‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,19 @@ pub use distribution::{Distribution, DistributionBuilder};
126126

127127
mod exporter;
128128
pub use self::exporter::builder::PrometheusBuilder;
129-
#[cfg(any(feature = "http-listener", feature = "push-gateway"))]
130-
#[cfg_attr(docsrs, doc(cfg(any(feature = "http-listener", feature = "push-gateway"))))]
129+
#[cfg(any(
130+
feature = "http-listener",
131+
feature = "push-gateway",
132+
feature = "push-gateway-no-tls-provider"
133+
))]
134+
#[cfg_attr(
135+
docsrs,
136+
doc(cfg(any(
137+
feature = "http-listener",
138+
feature = "push-gateway",
139+
feature = "push-gateway-no-tls-provider"
140+
)))
141+
)]
131142
pub use self::exporter::ExporterFuture;
132143

133144
pub mod formatting;

0 commit comments

Comments
 (0)