matrix/authentication-service
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-authentication-service.git synced 2025-07-31 09:24:31 +03:00
Code Activity

WIP: bump OTEL

Browse Source
This commit is contained in:
Quentin Gliech
2022-09-15 16:14:01 +02:00
parent dc4b66a96c
commit 7dd84a6584
6 changed files with 283 additions and 165 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
crates/cli/Cargo.toml
View File

@ -18,24 +18,24 @@ serde_yaml = "0.9.13"
serde_json = "1.0.85"
url = "2.3.1"
argon2 = { version = "0.4.1", features = ["password-hash"] }
reqwest = { version = "0.11.12", features = ["rustls-tls"], default-features = false, optional = true }
watchman_client = "0.8.0"
atty = "0.2.14"
tracing = "0.1.36"
tracing-appender = "0.2.2"
tracing-subscriber = { version = "0.3.15", features = ["env-filter"] }
tracing-opentelemetry = "0.17.4"
opentelemetry = { version = "0.17.0", features = ["trace", "metrics", "rt-tokio"] }
opentelemetry-semantic-conventions = "0.9.0"
opentelemetry-jaeger = { version = "0.16.0", features = ["rt-tokio", "reqwest_collector_client"], optional = true }
opentelemetry-otlp = { version = "0.10.0", features = ["trace", "metrics"], optional = true }
opentelemetry-zipkin = { version = "0.15.0", features = ["reqwest-client", "reqwest-rustls"], default-features = false, optional = true }
#tracing-opentelemetry = "0.17.4"
opentelemetry = { version = "0.18.0", features = ["trace", "metrics", "rt-tokio"] }
opentelemetry-semantic-conventions = "0.10.0"
opentelemetry-jaeger = { version = "0.17.0", features = ["rt-tokio"], optional = true }
opentelemetry-otlp = { version = "0.11.0", features = ["trace", "metrics", "http-proto"], optional = true }
opentelemetry-zipkin = { version = "0.16.0", features = ["opentelemetry-http"], default-features = false, optional = true }
opentelemetry-http = { version = "0.7.0", features = ["tokio", "hyper"], optional = true }
mas-config = { path = "../config" }
mas-email = { path = "../email" }
mas-handlers = { path = "../handlers", default-features = false }
mas-http = { path = "../http", features = ["axum"] }
mas-http = { path = "../http", features = ["axum", "client", "native-roots"] }
mas-policy = { path = "../policy" }
mas-router = { path = "../router" }
mas-static-files = { path = "../static-files" }
@ -58,8 +58,8 @@ webpki-roots = ["mas-http/webpki-roots", "mas-handlers/webpki-roots"]
dev = ["mas-templates/dev", "mas-static-files/dev"]
# Enable OpenTelemetry OTLP exporter. Requires "protoc"
otlp = ["opentelemetry-otlp"]
otlp = ["dep:opentelemetry-otlp", "dep:opentelemetry-http"]
# Enable OpenTelemetry Jaeger exporter and propagator.
jaeger = ["opentelemetry-jaeger", "reqwest"]
jaeger = ["dep:opentelemetry-jaeger"]
# Enable OpenTelemetry Zipkin exporter and B3 propagator.
zipkin = ["opentelemetry-zipkin", "reqwest"]
zipkin = ["dep:opentelemetry-zipkin", "dep:opentelemetry-http"]

6
crates/cli/src/commands/server.rs
View File

@ -20,7 +20,7 @@ use std::{
use anyhow::Context;
use clap::Parser;
use futures::stream::{StreamExt, TryStreamExt};
use futures_util::stream::{StreamExt, TryStreamExt};
use hyper::Server;
use mas_config::RootConfig;
use mas_email::Mailer;
@ -100,7 +100,7 @@ async fn watch_templates(
.await?;
// Create a stream out of that subscription
let stream = futures::stream::try_unfold(subscription, |mut sub| async move {
let stream = futures_util::stream::try_unfold(subscription, |mut sub| async move {
let next = sub.next().await?;
anyhow::Ok(Some((next, sub)))
});
@ -109,7 +109,7 @@ async fn watch_templates(
}
let files_changed_stream =
futures::stream::select_all(streams).try_filter_map(|event| async move {
futures_util::stream::select_all(streams).try_filter_map(|event| async move {
match event {
SubscriptionData::FilesChanged(QueryResult {
files: Some(files), ..

10
crates/cli/src/main.rs
View File

@ -58,14 +58,16 @@ async fn try_main() -> anyhow::Result<()> {
.or_else(|_| EnvFilter::try_new("info"))
.context("could not setup logging filter")?;
/*
// Don't fill the telemetry layer for now, we want to configure it based on the
// app config, so we need to delay that a bit
let (telemetry_layer, handle) = reload::Layer::new(None);
// We only want "INFO" level spans to go through OpenTelemetry
let telemetry_layer = telemetry_layer.with_filter(LevelFilter::INFO);
*/
let subscriber = Registry::default()
.with(telemetry_layer)
//.with(telemetry_layer)
.with(filter_layer)
.with(fmt_layer);
subscriber
@ -89,7 +91,10 @@ async fn try_main() -> anyhow::Result<()> {
let telemetry_config: TelemetryConfig = opts.load_config().unwrap_or_default();
// Setup OpenTelemtry tracing and metrics
let tracer = telemetry::setup(&telemetry_config).context("failed to setup opentelemetry")?;
let tracer = telemetry::setup(&telemetry_config)
.await
.context("failed to setup opentelemetry")?;
/*
if let Some(tracer) = tracer {
// Now we can swap out the actual opentelemetry tracing layer
handle.reload(
@ -98,6 +103,7 @@ async fn try_main() -> anyhow::Result<()> {
.with_tracked_inactivity(false),
)?;
}
*/
// And run the command
tracing::trace!(?opts, "Running command");

56
crates/cli/src/telemetry.rs
View File

@ -15,7 +15,6 @@
use std::{net::SocketAddr, time::Duration};
use anyhow::bail;
use futures::stream::{Stream, StreamExt};
use mas_config::{MetricsExporterConfig, Propagator, TelemetryConfig, TracingExporterConfig};
use opentelemetry::{
global,
@ -34,7 +33,7 @@ use opentelemetry_semantic_conventions as semcov;
use opentelemetry_zipkin::{B3Encoding, Propagator as ZipkinPropagator};
use url::Url;
pub fn setup(config: &TelemetryConfig) -> anyhow::Result<Option<Tracer>> {
pub async fn setup(config: &TelemetryConfig) -> anyhow::Result<Option<Tracer>> {
global::set_error_handler(|e| tracing::error!("{}", e))?;
let propagator = propagator(&config.tracing.propagators)?;
@ -43,7 +42,7 @@ pub fn setup(config: &TelemetryConfig) -> anyhow::Result<Option<Tracer>> {
mas_http::set_propagator(&propagator);
global::set_text_map_propagator(propagator);
let tracer = tracer(&config.tracing.exporter)?;
let tracer = tracer(&config.tracing.exporter).await?;
meter(&config.metrics.exporter)?;
Ok(tracer)
}
@ -86,6 +85,14 @@ fn propagator(propagators: &[Propagator]) -> anyhow::Result<impl TextMapPropagat
Ok(TextMapCompositePropagator::new(propagators?))
}
#[cfg(any(feature = "otlp", feature = "jaeger"))]
async fn http_client() -> anyhow::Result<impl opentelemetry_http::HttpClient + 'static> {
let client = mas_http::make_untraced_client().await?;
let client =
opentelemetry_http::hyper::HyperClient::new_with_timeout(client, Duration::from_secs(30));
Ok(client)
}
fn stdout_tracer() -> Tracer {
sdk::export::trace::stdout::new_pipeline()
.with_pretty_print(true)
@ -124,12 +131,12 @@ fn jaeger_tracer(_agent_endpoint: &Option<SocketAddr>) -> anyhow::Result<Tracer>
#[cfg(feature = "jaeger")]
fn jaeger_tracer(agent_endpoint: &Option<SocketAddr>) -> anyhow::Result<Tracer> {
// TODO: also support exporting to a Jaeger collector & skip the agent
let mut pipeline = opentelemetry_jaeger::new_pipeline()
let mut pipeline = opentelemetry_jaeger::new_agent_pipeline()
.with_service_name(env!("CARGO_PKG_NAME"))
.with_trace_config(trace_config());
if let Some(agent_endpoint) = agent_endpoint {
pipeline = pipeline.with_agent_endpoint(agent_endpoint);
pipeline = pipeline.with_endpoint(agent_endpoint);
}
let tracer = pipeline.install_batch(opentelemetry::runtime::Tokio)?;
@ -143,8 +150,8 @@ fn zipkin_tracer(_collector_endpoint: &Option<Url>) -> anyhow::Result<Tracer> {
}
#[cfg(feature = "zipkin")]
fn zipkin_tracer(collector_endpoint: &Option<Url>) -> anyhow::Result<Tracer> {
let http_client = reqwest::Client::new();
async fn zipkin_tracer(collector_endpoint: &Option<Url>) -> anyhow::Result<Tracer> {
let http_client = http_client().await?;
let mut pipeline = opentelemetry_zipkin::new_pipeline()
.with_http_client(http_client)
@ -160,23 +167,20 @@ fn zipkin_tracer(collector_endpoint: &Option<Url>) -> anyhow::Result<Tracer> {
Ok(tracer)
}
fn tracer(config: &TracingExporterConfig) -> anyhow::Result<Option<Tracer>> {
async fn tracer(config: &TracingExporterConfig) -> anyhow::Result<Option<Tracer>> {
let tracer = match config {
TracingExporterConfig::None => return Ok(None),
TracingExporterConfig::Stdout => stdout_tracer(),
TracingExporterConfig::Otlp { endpoint } => otlp_tracer(endpoint)?,
TracingExporterConfig::Jaeger { agent_endpoint } => jaeger_tracer(agent_endpoint)?,
TracingExporterConfig::Zipkin { collector_endpoint } => zipkin_tracer(collector_endpoint)?,
TracingExporterConfig::Zipkin { collector_endpoint } => {
zipkin_tracer(collector_endpoint).await?
}
};
Ok(Some(tracer))
}
fn interval(duration: Duration) -> impl Stream<Item = tokio::time::Instant> {
// Skip first immediate tick from tokio
opentelemetry::util::tokio_interval_stream(duration).skip(1)
}
#[cfg(feature = "otlp")]
fn otlp_meter(endpoint: &Option<url::Url>) -> anyhow::Result<()> {
use opentelemetry_otlp::WithExportConfig;
@ -187,9 +191,12 @@ fn otlp_meter(endpoint: &Option<url::Url>) -> anyhow::Result<()> {
}
opentelemetry_otlp::new_pipeline()
.metrics(tokio::spawn, interval)
.metrics(
sdk::metrics::selectors::simple::histogram([0.1, 0.2, 0.5, 1.0, 5.0, 10.0]),
sdk::export::metrics::aggregation::stateless_temporality_selector(),
opentelemetry::runtime::Tokio,
)
.with_exporter(exporter)
.with_aggregator_selector(sdk::metrics::selectors::simple::Selector::Exact)
.build()?;
Ok(())
@ -200,14 +207,25 @@ fn otlp_meter(_endpoint: &Option<url::Url>) -> anyhow::Result<()> {
anyhow::bail!("The service was compiled without OTLP exporter support, but config exports metrics via OTLP.")
}
fn stdout_meter() {
sdk::export::metrics::stdout(tokio::spawn, interval).init();
fn stdout_meter() -> anyhow::Result<()> {
let exporter = sdk::export::metrics::stdout().build()?;
let controller = sdk::metrics::controllers::basic(
sdk::metrics::processors::factory(
sdk::metrics::selectors::simple::histogram([0.1, 0.2, 0.5, 1.0, 5.0, 10.0]),
exporter.temporality_selector(),
)
.with_memory(true),
)
.with_exporter(exporter)
.build();
global::set_meter_provider(controller);
Ok(())
}
fn meter(config: &MetricsExporterConfig) -> anyhow::Result<()> {
match config {
MetricsExporterConfig::None => {}
MetricsExporterConfig::Stdout => stdout_meter(),
MetricsExporterConfig::Stdout => stdout_meter()?,
MetricsExporterConfig::Otlp { endpoint } => otlp_meter(endpoint)?,
};