use std::net::SocketAddr;
use oxtel_sdk::logs::LogExporter;
use oxtel_sdk::metrics::MetricExporter;
use oxtel_sdk::trace::SpanExporter;
use crate::plan::{Proc, Sink};
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) enum Kind {
Traces,
Metrics,
Logs,
}
impl Kind {
fn name(self) -> &'static str {
match self {
Kind::Traces => "traces",
Kind::Metrics => "metrics",
Kind::Logs => "logs",
}
}
}
#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) enum Dest {
Exporter(String),
Prometheus(SocketAddr),
Program,
}
impl Dest {
pub(crate) fn of_sink(sink: &Sink, kind: Kind) -> Dest {
Dest::Exporter(match kind {
Kind::Traces => SpanExporter::destination(sink),
Kind::Metrics => MetricExporter::destination(sink),
Kind::Logs => LogExporter::destination(sink),
})
}
pub(crate) fn of_proc(proc: &Proc, kind: Kind) -> Dest {
match proc {
Proc::Batch(sink, _) | Proc::Simple(sink) => Dest::of_sink(sink, kind),
}
}
pub(crate) fn uses_the_grpc_port(&self) -> bool {
matches!(self, Dest::Exporter(d) if d.contains(":4317/") && d.contains("(OTLP"))
}
fn describe(&self) -> String {
match self {
Dest::Exporter(destination) => destination.clone(),
Dest::Prometheus(addr) => {
format!("a Prometheus scrape endpoint at http://{addr}/metrics")
}
Dest::Program => "the program's own setup".into(),
}
}
}
#[derive(Debug, Default)]
pub(crate) struct Summary {
pub(crate) config_file: Option<String>,
pub(crate) local: Option<String>,
pub(crate) disabled: bool,
pub(crate) traces: Vec<Dest>,
pub(crate) metrics: Vec<Dest>,
pub(crate) logs: Vec<Dest>,
}
impl Summary {
pub(crate) fn line(&self) -> String {
let mut parts = Vec::new();
if let Some(path) = &self.config_file {
parts.push(format!("configured by {path}"));
}
parts.push(match &self.local {
Some(local) => format!("log lines: {local}"),
None => "log lines: off".into(),
});
if self.disabled {
let why = if self.config_file.is_some() {
"the configuration file disables it"
} else {
"OTEL_SDK_DISABLED is true"
};
parts.push(format!("everything else: off ({why})"));
return parts.join("; ");
}
let kinds = [
(Kind::Traces, &self.traces),
(Kind::Metrics, &self.metrics),
(Kind::Logs, &self.logs),
];
let mut unexported = Vec::new();
for (kind, dests) in kinds {
if dests.is_empty() {
unexported.push(kind.name());
} else {
let dests: Vec<String> = dests.iter().map(Dest::describe).collect();
parts.push(format!("{}: {}", kind.name(), dests.join(" and ")));
}
}
if !unexported.is_empty() {
let mut part = format!("{}: not exported", list(&unexported));
if unexported.len() == kinds.len() && self.config_file.is_none() {
part.push_str(" (set OTEL_EXPORTER_OTLP_ENDPOINT to send them to a collector)");
}
parts.push(part);
}
parts.join("; ")
}
}
fn list(items: &[&str]) -> String {
match items {
[] => String::new(),
[one] => one.to_string(),
[rest @ .., last] => format!("{} and {last}", rest.join(", ")),
}
}
#[cfg(test)]
mod tests {
use super::*;
fn otlp(path: &str) -> Dest {
Dest::Exporter(format!("http://localhost:4318{path} (OTLP)"))
}
#[test]
fn with_nothing_configured_it_says_how_to_export() {
let summary = Summary {
local: Some("standard error, as JSON".into()),
..Summary::default()
};
assert_eq!(
summary.line(),
"log lines: standard error, as JSON; traces, metrics and logs: not exported \
(set OTEL_EXPORTER_OTLP_ENDPOINT to send them to a collector)"
);
}
#[test]
fn each_kind_names_where_it_goes() {
let summary = Summary {
local: Some("standard error, as text".into()),
traces: vec![otlp("/v1/traces"), Dest::Exporter("standard output".into())],
metrics: vec![Dest::Prometheus("127.0.0.1:9464".parse().unwrap())],
..Summary::default()
};
assert_eq!(
summary.line(),
"log lines: standard error, as text; \
traces: http://localhost:4318/v1/traces (OTLP) and standard output; \
metrics: a Prometheus scrape endpoint at http://127.0.0.1:9464/metrics; \
logs: not exported"
);
}
#[test]
fn a_configuration_file_or_a_disabled_sdk_is_named() {
let summary = Summary {
config_file: Some("otel.yaml".into()),
logs: vec![Dest::Exporter(
"https://collector/v1/logs (OTLP/JSON)".into(),
)],
..Summary::default()
};
assert_eq!(
summary.line(),
"configured by otel.yaml; log lines: off; logs: https://collector/v1/logs (OTLP/JSON); \
traces and metrics: not exported"
);
let summary = Summary {
local: Some("standard output, as ECS JSON".into()),
disabled: true,
traces: vec![Dest::Program],
..Summary::default()
};
assert_eq!(
summary.line(),
"log lines: standard output, as ECS JSON; everything else: off (OTEL_SDK_DISABLED is true)"
);
}
#[test]
fn the_grpc_port_is_noticed() {
assert!(Dest::Exporter("http://c:4317/v1/traces (OTLP)".into()).uses_the_grpc_port());
assert!(!otlp("/v1/traces").uses_the_grpc_port());
assert!(!Dest::Exporter("standard output".into()).uses_the_grpc_port());
}
}