1use std::collections::HashMap;2use std::convert::Infallible;3use std::env::{self, VarError};4use std::ffi::OsString;5use std::num::ParseIntError;6use std::str::FromStr;7use std::time::Duration;89use clap::Parser;10#[cfg(feature = "otlp")]11use opentelemetry_otlp::tonic_types::metadata::MetadataMap;12#[cfg(feature = "otlp")]13use opentelemetry_otlp::{14 ExporterBuildError, LogExporter, MetricExporter, SpanExporter, WithExportConfig,15 WithHttpConfig, WithTonicConfig,16};1718#[cfg(feature = "otlp")]19mod otlp;2021pub enum Error {22 InvalidUtf8 {23 env: &'static str,24 value: OsString,25 },26 EnvParseError {27 env: &'static str,28 value: String,29 error: &'static str,30 },31 EnvParseIntError {32 env: &'static str,33 value: String,34 error: ParseIntError,35 },36}37impl From<(&'static str, &'static str, String)> for Error {38 fn from((env, error, value): (&'static str, &'static str, String)) -> Self {39 Self::EnvParseError { env, value, error }40 }41}42impl From<(&'static str, ParseIntError, String)> for Error {43 fn from((env, error, value): (&'static str, ParseIntError, String)) -> Self {44 Self::EnvParseIntError { env, value, error }45 }46}47impl From<(&'static str, Infallible, String)> for Error {48 fn from(_v: (&'static str, Infallible, String)) -> Self {49 unreachable!()50 }51}5253fn load_env<T>(env: &'static str) -> Result<Option<T>, Error>54where55 T: FromStr,56 Error: From<(&'static str, <T as FromStr>::Err, String)>,57{58 match env::var(env) {59 Ok(v) => Ok(Some(T::from_str(&v).map_err(|err| (env, err, v))?)),60 Err(VarError::NotPresent) => Ok(None),61 Err(VarError::NotUnicode(value)) => Err(Error::InvalidUtf8 { env, value }),62 }63}6465macro_rules! impl_settings {66 (67 #[name($env_prefix:literal, $long_prefix:literal)]68 struct $id:ident {69 $(70 $(#[doc = $doc:literal])*71 #[name($env:literal, $long:literal)]72 $(#[arg($($tt:tt)*)])?73 $name:ident: $ty:ty,74 )*75 }) => {76 #[derive(Parser)]77 pub struct $id {78 $(79 $(#[doc = $doc])*80 #[arg(long = concat!("otel-exporter-otlp-", $long_prefix, $long), env = concat!("OTEL_EXPORTER_OTLP_", $env_prefix, $env), $($($tt)*)?)]81 pub $name: Option<$ty>,82 )*83 }84 impl $id {85 pub fn from_env() -> Result<Self, Error> {86 Ok(Self {87 $(88 $name: load_env(concat!("OTEL_EXPORTER_OTLP_", $env_prefix, $env))?,89 )*90 })91 }92 }93 }94}95macro_rules! impl_enum {96 (enum $id:ident {97 $(98 #[name = $value:literal]99 $var:ident,100 )*101 }) => {102 #[derive(Clone, Copy)]103 #[cfg_attr(feature = "clap", derive(clap::ValueEnum))]104 pub enum $id {105 $(106 #[cfg_attr(feature = "clap", value(name = $value))]107 $var,108 )*109 }110 impl FromStr for $id {111 type Err = &'static str;112113 fn from_str(s: &str) -> Result<Self, Self::Err> {114 Ok(match s {115 $(116 $value => Self::$var,117 )*118 _ => return Err("unsupported value, supported are")119 })120 }121 }122 };123}124125impl_enum! {126 enum Compression {127 #[name = "gzip"]128 Gzip,129 #[name = "zstd"]130 Zstd,131 }132}133#[cfg(feature = "otlp")]134impl From<Compression> for opentelemetry_otlp::Compression {135 fn from(value: Compression) -> Self {136 match value {137 Compression::Gzip => opentelemetry_otlp::Compression::Gzip,138 Compression::Zstd => opentelemetry_otlp::Compression::Zstd,139 }140 }141}142143impl_enum! {144 enum OtlpProtocol {145 #[name = "grpc"]146 Grpc,147 #[name = "http/protobuf"]148 HttpProtobuf,149 #[name = "http/json"]150 HttpJson,151 }152}153#[cfg(feature = "otlp")]154impl From<OtlpProtocol> for opentelemetry_otlp::Protocol {155 fn from(value: OtlpProtocol) -> Self {156 match value {157 OtlpProtocol::Grpc => opentelemetry_otlp::Protocol::Grpc,158 OtlpProtocol::HttpProtobuf => opentelemetry_otlp::Protocol::HttpBinary,159 OtlpProtocol::HttpJson => opentelemetry_otlp::Protocol::HttpJson,160 }161 }162}163164impl_settings! {165 #[name("", "")]166 struct OtlpBaseSettings {167 168 #[name("COMPRESSION", "compression")]169 #[arg(value_enum)]170 compression: Compression,171 172 #[name("ENDPOINT", "endpoint")]173 endpoint: String,174 175 #[name("HEADERS", "headers")]176 headers: String,177 178 #[name("PROTOCOL", "protocol")]179 #[arg(value_enum)]180 protocol: OtlpProtocol,181 182 #[name("TIMEOUT", "timeout")]183 timeout: u64,184 }185}186impl_settings! {187 #[name("LOGS_", "logs-")]188 struct OtlpLogsSettings {189 190 #[name("COMPRESSION", "compression")]191 #[arg(value_enum)]192 compression: Compression,193 194 #[name("ENDPOINT", "endpoint")]195 endpoint: String,196 197 #[name("HEADERS", "headers")]198 headers: String,199 200 #[name("PROTOCOL", "protocol")]201 #[arg(value_enum)]202 protocol: OtlpProtocol,203 204 #[name("TIMEOUT", "timeout")]205 timeout: u64,206 }207}208impl_settings! {209 #[name("METRICS_", "metrics-")]210 struct OtlpMetricsSettings {211 212 #[name("COMPRESSION", "compression")]213 #[arg(value_enum)]214 compression: Compression,215 216 #[name("ENDPOINT", "endpoint")]217 endpoint: String,218 219 #[name("HEADERS", "headers")]220 headers: String,221 222 #[name("PROTOCOL", "protocol")]223 #[arg(value_enum)]224 protocol: OtlpProtocol,225 226 #[name("TIMEOUT", "timeout")]227 timeout: u64,228 }229}230231impl_settings! {232 #[name("TRACES_", "traces-")]233 struct OtlpTracesSettings {234 235 #[name("COMPRESSION", "compression")]236 #[arg(value_enum)]237 compression: Compression,238 239 #[name("ENDPOINT", "endpoint")]240 endpoint: String,241 242 #[name("HEADERS", "headers")]243 headers: String,244 245 #[name("PROTOCOL", "protocol")]246 #[arg(value_enum)]247 protocol: OtlpProtocol,248 249 #[name("TIMEOUT", "timeout")]250 timeout: u64,251 }252}253254#[derive(thiserror::Error, Debug)]255enum ProviderError {256 #[error("protocol is not set")]257 UnsetProtocol,258 #[error("endpoint is not set")]259 EndpointUnset,260 #[cfg(feature = "otlp")]261 #[error("failed to build exporter: {0}")]262 Exporter(#[from] ExporterBuildError),263}264type ProviderResult<T, E = ProviderError> = Result<T, E>;
1use std::convert::Infallible;2use std::env::{self, VarError};3use std::ffi::OsString;4use std::num::ParseIntError;5use std::str::FromStr;6use std::time::Duration;78#[cfg(feature = "otlp")]9mod otlp;1011#[derive(thiserror::Error, Debug)]12pub enum Error {13 #[error("environment variable {env} contains invalid UTF-8: {value:?}")]14 InvalidUtf8 {15 env: &'static str,16 value: OsString,17 },18 #[error("environment variable {env}={value:?}: {error}")]19 EnvParse {20 env: &'static str,21 value: String,22 error: &'static str,23 },24 #[error("environment variable {env}={value:?}: {error}")]25 EnvParseInt {26 env: &'static str,27 value: String,28 error: ParseIntError,29 },30 #[cfg(feature = "otlp")]31 #[error("failed to build exporter: {0}")]32 Exporter(#[from] opentelemetry_otlp::ExporterBuildError),33}3435impl From<(&'static str, &'static str, String)> for Error {36 fn from((env, error, value): (&'static str, &'static str, String)) -> Self {37 Self::EnvParse { env, value, error }38 }39}40impl From<(&'static str, ParseIntError, String)> for Error {41 fn from((env, error, value): (&'static str, ParseIntError, String)) -> Self {42 Self::EnvParseInt { env, value, error }43 }44}45impl From<(&'static str, Infallible, String)> for Error {46 fn from(_v: (&'static str, Infallible, String)) -> Self {47 unreachable!()48 }49}5051fn load_env<T>(env: &'static str) -> Result<Option<T>, Error>52where53 T: FromStr,54 Error: From<(&'static str, <T as FromStr>::Err, String)>,55{56 match env::var(env) {57 Ok(v) => Ok(Some(T::from_str(&v).map_err(|err| (env, err, v))?)),58 Err(VarError::NotPresent) => Ok(None),59 Err(VarError::NotUnicode(value)) => Err(Error::InvalidUtf8 { env, value }),60 }61}6263macro_rules! impl_enum {64 (enum $id:ident {65 $(66 #[name = $value:literal]67 $var:ident,68 )*69 }) => {70 #[derive(Clone, Copy)]71 #[cfg_attr(feature = "clap", derive(clap::ValueEnum))]72 pub enum $id {73 $(74 #[cfg_attr(feature = "clap", value(name = $value))]75 $var,76 )*77 }78 impl FromStr for $id {79 type Err = &'static str;8081 fn from_str(s: &str) -> Result<Self, Self::Err> {82 Ok(match s {83 $(84 $value => Self::$var,85 )*86 _ => return Err("unsupported value")87 })88 }89 }90 };91}9293impl_enum! {94 enum ExporterKind {95 #[name = "otlp"]96 Otlp,97 #[name = "none"]98 None,99 }100}101102#[derive(Default)]103#[cfg_attr(feature = "clap", derive(clap::Parser))]104pub struct SignalExporterSettings {105 106 #[cfg_attr(feature = "clap", arg(long = "otel-traces-exporter", env = "OTEL_TRACES_EXPORTER", value_enum))]107 pub traces: Option<ExporterKind>,108 109 #[cfg_attr(feature = "clap", arg(long = "otel-metrics-exporter", env = "OTEL_METRICS_EXPORTER", value_enum))]110 pub metrics: Option<ExporterKind>,111 112 #[cfg_attr(feature = "clap", arg(long = "otel-logs-exporter", env = "OTEL_LOGS_EXPORTER", value_enum))]113 pub logs: Option<ExporterKind>,114}115116impl SignalExporterSettings {117 pub fn from_env() -> Result<Self, Error> {118 Ok(Self {119 traces: load_env("OTEL_TRACES_EXPORTER")?,120 metrics: load_env("OTEL_METRICS_EXPORTER")?,121 logs: load_env("OTEL_LOGS_EXPORTER")?,122 })123 }124125 pub fn traces_enabled(&self) -> bool {126 !matches!(self.traces, Some(ExporterKind::None))127 }128 pub fn metrics_enabled(&self) -> bool {129 !matches!(self.metrics, Some(ExporterKind::None))130 }131 pub fn logs_enabled(&self) -> bool {132 !matches!(self.logs, Some(ExporterKind::None))133 }134}135136impl_enum! {137 enum Compression {138 #[name = "gzip"]139 Gzip,140 #[name = "zstd"]141 Zstd,142 }143}144#[cfg(feature = "otlp")]145impl From<Compression> for opentelemetry_otlp::Compression {146 fn from(value: Compression) -> Self {147 match value {148 Compression::Gzip => opentelemetry_otlp::Compression::Gzip,149 Compression::Zstd => opentelemetry_otlp::Compression::Zstd,150 }151 }152}153154impl_enum! {155 enum OtlpProtocol {156 #[name = "grpc"]157 Grpc,158 #[name = "http/protobuf"]159 HttpProtobuf,160 #[name = "http/json"]161 HttpJson,162 }163}164#[cfg(feature = "otlp")]165impl From<OtlpProtocol> for opentelemetry_otlp::Protocol {166 fn from(value: OtlpProtocol) -> Self {167 match value {168 OtlpProtocol::Grpc => opentelemetry_otlp::Protocol::Grpc,169 OtlpProtocol::HttpProtobuf => opentelemetry_otlp::Protocol::HttpBinary,170 OtlpProtocol::HttpJson => opentelemetry_otlp::Protocol::HttpJson,171 }172 }173}174175pub trait OtlpSignalSettings {176 fn compression(&self) -> Option<Compression>;177 fn endpoint(&self) -> Option<&str>;178 fn headers(&self) -> Option<&str>;179 fn protocol(&self) -> Option<OtlpProtocol>;180 fn timeout(&self) -> Option<u64>;181}182183macro_rules! impl_settings {184 (185 #[name($env_prefix:literal, $long_prefix:literal)]186 struct $id:ident {187 $(188 $(#[doc = $doc:literal])*189 #[name($env:literal, $long:literal)]190 $(#[arg($($tt:tt)*)])?191 $name:ident: $ty:ty,192 )*193 }) => {194 #[derive(Default)]195 #[cfg_attr(feature = "clap", derive(clap::Parser))]196 pub struct $id {197 $(198 $(#[doc = $doc])*199 #[cfg_attr(feature = "clap", arg(long = concat!("otel-exporter-otlp-", $long_prefix, $long), env = concat!("OTEL_EXPORTER_OTLP_", $env_prefix, $env) $(, $($tt)*)?))]200 pub $name: Option<$ty>,201 )*202 }203 impl $id {204 pub fn from_env() -> Result<Self, Error> {205 Ok(Self {206 $(207 $name: load_env(concat!("OTEL_EXPORTER_OTLP_", $env_prefix, $env))?,208 )*209 })210 }211 }212 impl OtlpSignalSettings for $id {213 fn compression(&self) -> Option<Compression> { self.compression }214 fn endpoint(&self) -> Option<&str> { self.endpoint.as_deref() }215 fn headers(&self) -> Option<&str> { self.headers.as_deref() }216 fn protocol(&self) -> Option<OtlpProtocol> { self.protocol }217 fn timeout(&self) -> Option<u64> { self.timeout }218 }219 }220}221222impl_settings! {223 #[name("", "")]224 struct OtlpBaseSettings {225 226 #[name("COMPRESSION", "compression")]227 #[arg(value_enum)]228 compression: Compression,229 230 #[name("ENDPOINT", "endpoint")]231 endpoint: String,232 233 #[name("HEADERS", "headers")]234 headers: String,235 236 #[name("PROTOCOL", "protocol")]237 #[arg(value_enum)]238 protocol: OtlpProtocol,239 240 #[name("TIMEOUT", "timeout")]241 timeout: u64,242 }243}244impl_settings! {245 #[name("LOGS_", "logs-")]246 struct OtlpLogsSettings {247 248 #[name("COMPRESSION", "compression")]249 #[arg(value_enum)]250 compression: Compression,251 252 #[name("ENDPOINT", "endpoint")]253 endpoint: String,254 255 #[name("HEADERS", "headers")]256 headers: String,257 258 #[name("PROTOCOL", "protocol")]259 #[arg(value_enum)]260 protocol: OtlpProtocol,261 262 #[name("TIMEOUT", "timeout")]263 timeout: u64,264 }265}266impl_settings! {267 #[name("METRICS_", "metrics-")]268 struct OtlpMetricsSettings {269 270 #[name("COMPRESSION", "compression")]271 #[arg(value_enum)]272 compression: Compression,273 274 #[name("ENDPOINT", "endpoint")]275 endpoint: String,276 277 #[name("HEADERS", "headers")]278 headers: String,279 280 #[name("PROTOCOL", "protocol")]281 #[arg(value_enum)]282 protocol: OtlpProtocol,283 284 #[name("TIMEOUT", "timeout")]285 timeout: u64,286 }287}288impl_settings! {289 #[name("TRACES_", "traces-")]290 struct OtlpTracesSettings {291 292 #[name("COMPRESSION", "compression")]293 #[arg(value_enum)]294 compression: Compression,295 296 #[name("ENDPOINT", "endpoint")]297 endpoint: String,298 299 #[name("HEADERS", "headers")]300 headers: String,301 302 #[name("PROTOCOL", "protocol")]303 #[arg(value_enum)]304 protocol: OtlpProtocol,305 306 #[name("TIMEOUT", "timeout")]307 timeout: u64,308 }309}310311pub struct ResolvedOtlpSettings {312 pub compression: Option<Compression>,313 pub endpoint: String,314 pub headers: Option<String>,315 pub protocol: OtlpProtocol,316 pub timeout: Duration,317}318319impl ResolvedOtlpSettings {320 const DEFAULT_TIMEOUT_MS: u64 = 10000;321 const DEFAULT_GRPC_ENDPOINT: &str = "http://localhost:4317";322 const DEFAULT_HTTP_ENDPOINT: &str = "http://localhost:4318";323324 pub fn traces(325 base: &impl OtlpSignalSettings,326 signal: &impl OtlpSignalSettings,327 ) -> Result<Self, Error> {328 Self::resolve(base, signal, "/v1/traces")329 }330331 pub fn metrics(332 base: &impl OtlpSignalSettings,333 signal: &impl OtlpSignalSettings,334 ) -> Result<Self, Error> {335 Self::resolve(base, signal, "/v1/metrics")336 }337338 pub fn logs(339 base: &impl OtlpSignalSettings,340 signal: &impl OtlpSignalSettings,341 ) -> Result<Self, Error> {342 Self::resolve(base, signal, "/v1/logs")343 }344345 fn resolve(346 base: &impl OtlpSignalSettings,347 signal: &impl OtlpSignalSettings,348 signal_path: &str,349 ) -> Result<Self, Error> {350 let protocol = signal351 .protocol()352 .or_else(|| base.protocol())353 .unwrap_or(OtlpProtocol::HttpProtobuf);354355 let endpoint = if let Some(ep) = signal.endpoint() {356 ep.to_owned()357 } else if let Some(ep) = base.endpoint() {358 match protocol {359 OtlpProtocol::Grpc => ep.to_owned(),360 _ => format!("{ep}{signal_path}"),361 }362 } else {363 match protocol {364 OtlpProtocol::Grpc => Self::DEFAULT_GRPC_ENDPOINT.to_owned(),365 _ => format!("{}{signal_path}", Self::DEFAULT_HTTP_ENDPOINT),366 }367 };368369 Ok(Self {370 compression: signal.compression().or_else(|| base.compression()),371 endpoint,372 headers: signal373 .headers()374 .or_else(|| base.headers())375 .map(str::to_owned),376 protocol,377 timeout: Duration::from_millis(378 signal379 .timeout()380 .or_else(|| base.timeout())381 .unwrap_or(Self::DEFAULT_TIMEOUT_MS),382 ),383 })384 }385}