aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJakub Jirutka <jakub@jirutka.cz>2022-09-04 00:43:48 +0200
committerJakub Jirutka <jakub@jirutka.cz>2022-09-06 01:15:09 +0200
commitea36b9ff904a8300afb8fb1601cde88c915a810f (patch)
tree73dd84bba384a79cacdbd4bdec01c5c9485d2c6b /src
parente7af006c1c8211bf83b5d8abb7490ef270dd8345 (diff)
downloadgarage-ea36b9ff904a8300afb8fb1601cde88c915a810f.tar.gz
garage-ea36b9ff904a8300afb8fb1601cde88c915a810f.zip
Allow building without Prometheus exporter (/metrics endpoint)
prometheus and opentelemetry-prometheus add 7 extra dependencies in total and increases the size of the garage binary by ~7 % (with fat LTO).
Diffstat (limited to 'src')
-rw-r--r--src/api/Cargo.toml5
-rw-r--r--src/api/admin/api_server.rs55
-rw-r--r--src/garage/Cargo.toml8
3 files changed, 41 insertions, 27 deletions
diff --git a/src/api/Cargo.toml b/src/api/Cargo.toml
index 782054bd..ce2d11c0 100644
--- a/src/api/Cargo.toml
+++ b/src/api/Cargo.toml
@@ -54,10 +54,11 @@ quick-xml = { version = "0.21", features = [ "serialize" ] }
url = "2.1"
opentelemetry = "0.17"
-opentelemetry-prometheus = "0.10"
+opentelemetry-prometheus = { version = "0.10", optional = true }
opentelemetry-otlp = { version = "0.10", optional = true }
-prometheus = "0.13"
+prometheus = { version = "0.13", optional = true }
[features]
k2v = [ "garage_util/k2v", "garage_model/k2v" ]
+metrics = [ "opentelemetry-prometheus", "prometheus" ]
telemetry-otlp = ["opentelemetry-otlp"]
diff --git a/src/api/admin/api_server.rs b/src/api/admin/api_server.rs
index c3b16715..d871d4e2 100644
--- a/src/api/admin/api_server.rs
+++ b/src/api/admin/api_server.rs
@@ -3,13 +3,14 @@ use std::sync::Arc;
use async_trait::async_trait;
use futures::future::Future;
-use http::header::{
- ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ALLOW, CONTENT_TYPE,
-};
+use http::header::{ACCESS_CONTROL_ALLOW_METHODS, ACCESS_CONTROL_ALLOW_ORIGIN, ALLOW};
use hyper::{Body, Request, Response};
-use opentelemetry::trace::{SpanRef, Tracer};
+use opentelemetry::trace::SpanRef;
+
+#[cfg(feature = "metrics")]
use opentelemetry_prometheus::PrometheusExporter;
+#[cfg(feature = "metrics")]
use prometheus::{Encoder, TextEncoder};
use garage_model::garage::Garage;
@@ -25,6 +26,7 @@ use crate::admin::router::{Authorization, Endpoint};
pub struct AdminApiServer {
garage: Arc<Garage>,
+ #[cfg(feature = "metrics")]
exporter: PrometheusExporter,
metrics_token: Option<String>,
admin_token: Option<String>,
@@ -32,7 +34,6 @@ pub struct AdminApiServer {
impl AdminApiServer {
pub fn new(garage: Arc<Garage>) -> Self {
- let exporter = opentelemetry_prometheus::exporter().init();
let cfg = &garage.config.admin;
let metrics_token = cfg
.metrics_token
@@ -44,7 +45,8 @@ impl AdminApiServer {
.map(|tok| format!("Bearer {}", tok));
Self {
garage,
- exporter,
+ #[cfg(feature = "metrics")]
+ exporter: opentelemetry_prometheus::exporter().init(),
metrics_token,
admin_token,
}
@@ -71,22 +73,31 @@ impl AdminApiServer {
}
fn handle_metrics(&self) -> Result<Response<Body>, Error> {
- let mut buffer = vec![];
- let encoder = TextEncoder::new();
-
- let tracer = opentelemetry::global::tracer("garage");
- let metric_families = tracer.in_span("admin/gather_metrics", |_| {
- self.exporter.registry().gather()
- });
-
- encoder
- .encode(&metric_families, &mut buffer)
- .ok_or_internal_error("Could not serialize metrics")?;
-
- Ok(Response::builder()
- .status(200)
- .header(CONTENT_TYPE, encoder.format_type())
- .body(Body::from(buffer))?)
+ #[cfg(feature = "metrics")]
+ {
+ use opentelemetry::trace::Tracer;
+
+ let mut buffer = vec![];
+ let encoder = TextEncoder::new();
+
+ let tracer = opentelemetry::global::tracer("garage");
+ let metric_families = tracer.in_span("admin/gather_metrics", |_| {
+ self.exporter.registry().gather()
+ });
+
+ encoder
+ .encode(&metric_families, &mut buffer)
+ .ok_or_internal_error("Could not serialize metrics")?;
+
+ Ok(Response::builder()
+ .status(200)
+ .header(http::header::CONTENT_TYPE, encoder.format_type())
+ .body(Body::from(buffer))?)
+ }
+ #[cfg(not(feature = "metrics"))]
+ Err(Error::bad_request(
+ "Garage was built without the metrics feature".to_string(),
+ ))
}
}
diff --git a/src/garage/Cargo.toml b/src/garage/Cargo.toml
index 8573e2fc..553ac57a 100644
--- a/src/garage/Cargo.toml
+++ b/src/garage/Cargo.toml
@@ -55,9 +55,9 @@ tokio = { version = "1.0", default-features = false, features = ["rt", "rt-multi
netapp = "0.4"
opentelemetry = { version = "0.17", features = [ "rt-tokio" ] }
-opentelemetry-prometheus = "0.10"
+opentelemetry-prometheus = { version = "0.10", optional = true }
opentelemetry-otlp = { version = "0.10", optional = true }
-prometheus = "0.13"
+prometheus = { version = "0.13", optional = true }
[dev-dependencies]
aws-sdk-s3 = "0.8"
@@ -74,9 +74,11 @@ base64 = "0.13"
[features]
-default = [ "bundled-libs" ]
+default = [ "bundled-libs", "metrics" ]
kubernetes-discovery = [ "garage_rpc/kubernetes-discovery" ]
k2v = [ "garage_util/k2v", "garage_api/k2v" ]
+# Prometheus exporter (/metrics endpoint).
+metrics = [ "garage_api/metrics", "opentelemetry-prometheus", "prometheus" ]
# Exporter for the OpenTelemetry Collector.
telemetry-otlp = [ "opentelemetry-otlp", "garage_api/telemetry-otlp" ]