Deuxfleurs/garage
41
56
Fork 73
Code Issues 102 Pull requests 14 Releases 30 Wiki Activity

Make OTLP exporter optional and allow building without Prometheus exporter (/metrics) #372

Merged
lx merged 3 commits from jirutka/garage:telemetry-and-metrics into improve-deps 2022-09-06 13:11:33 +00:00
Conversation 3 Commits 3 Files changed 6 +13 -3
4 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit e7af006c1c - Show all commits

3
src/api/Cargo.toml
View file

@ -55,8 +55,9 @@ url = "2.1"
opentelemetry = "0.17" opentelemetry = "0.17"
opentelemetry-prometheus = "0.10" opentelemetry-prometheus = "0.10"
opentelemetry-otlp = "0.10" opentelemetry-otlp = { version = "0.10", optional = true }
prometheus = "0.13" prometheus = "0.13"
[features] [features]
k2v = [ "garage_util/k2v", "garage_model/k2v" ] k2v = [ "garage_util/k2v", "garage_model/k2v" ]
telemetry-otlp = ["opentelemetry-otlp"]

4
src/garage/Cargo.toml
View file

@ -56,7 +56,7 @@ netapp = "0.4"
opentelemetry = { version = "0.17", features = [ "rt-tokio" ] } opentelemetry = { version = "0.17", features = [ "rt-tokio" ] }
opentelemetry-prometheus = "0.10" opentelemetry-prometheus = "0.10"
opentelemetry-otlp = "0.10" opentelemetry-otlp = { version = "0.10", optional = true }
prometheus = "0.13" prometheus = "0.13"
[dev-dependencies] [dev-dependencies]
@ -77,6 +77,8 @@ base64 = "0.13"
default = [ "bundled-libs" ] default = [ "bundled-libs" ]
kubernetes-discovery = [ "garage_rpc/kubernetes-discovery" ] kubernetes-discovery = [ "garage_rpc/kubernetes-discovery" ]
k2v = [ "garage_util/k2v", "garage_api/k2v" ] k2v = [ "garage_util/k2v", "garage_api/k2v" ]
# Exporter for the OpenTelemetry Collector.
telemetry-otlp = [ "opentelemetry-otlp", "garage_api/telemetry-otlp" ]
# NOTE: bundled-libs and system-libs should be treat as mutually exclusive; # NOTE: bundled-libs and system-libs should be treat as mutually exclusive;
# exactly one of them should be enabled. # exactly one of them should be enabled.

1
src/garage/main.rs
View file

@ -8,6 +8,7 @@ mod admin;
mod cli; mod cli;
mod repair; mod repair;
mod server; mod server;
#[cfg(feature = "telemetry-otlp")]
mod tracing_setup; mod tracing_setup;
use std::net::SocketAddr; use std::net::SocketAddr;

8
src/garage/server.rs
View file

@ -15,6 +15,7 @@ use garage_web::run_web_server;
use garage_api::k2v::api_server::K2VApiServer; use garage_api::k2v::api_server::K2VApiServer;
use crate::admin::*; use crate::admin::*;
#[cfg(feature = "telemetry-otlp")]
use crate::tracing_setup::*; use crate::tracing_setup::*;
async fn wait_from(mut chan: watch::Receiver<bool>) { async fn wait_from(mut chan: watch::Receiver<bool>) {
@ -36,9 +37,14 @@ pub async fn run_server(config_file: PathBuf) -> Result<(), Error> {
info!("Initializing Garage main data store..."); info!("Initializing Garage main data store...");
let garage = Garage::new(config.clone(), background)?; let garage = Garage::new(config.clone(), background)?;
info!("Initialize tracing...");
if let Some(export_to) = config.admin.trace_sink { if let Some(export_to) = config.admin.trace_sink {
info!("Initialize tracing...");
#[cfg(feature = "telemetry-otlp")]
init_tracing(&export_to, garage.system.id)?; init_tracing(&export_to, garage.system.id)?;
#[cfg(not(feature = "telemetry-otlp"))]
warn!("Garage was built without OTLP exporter, admin.trace_sink is ignored.");
} }
jirutka marked this conversation as resolved Outdated
lx commented 2022-09-05 08:58:16 +00:00
Outdated
Review
Copy link

Looks like this will never be called because we are in a #[cfg(feature = "telemetry-otlp")] block

Looks like this will never be called because we are in a `#[cfg(feature = "telemetry-otlp")]` block
info!("Initialize Admin API server and metrics collector..."); info!("Initialize Admin API server and metrics collector...");