1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License in the LICENSE file at the
// root of this repository, or online at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! Tracing utilities.
//!
//! This module contains application tracing utilities built on top of the
//! [`tracing`] and [`opentelemetry`] libraries. The key exports are:
//!
//! * The **[`configure`]** function, which configures the `tracing` and
//! `opentelemetry` crates with sensible defaults and should be called during
//! initialization of every Materialize binary.
//!
//! * The **[`OpenTelemetryContext`]** type, which carries a tracing span
//! across thread or task boundaries within a process.
use std::collections::BTreeMap;
use std::io;
use std::io::IsTerminal;
use std::str::FromStr;
use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::LazyLock;
use std::sync::{Arc, OnceLock};
use std::time::Duration;
#[cfg(feature = "tokio-console")]
use console_subscriber::ConsoleLayer;
use derivative::Derivative;
use http::HeaderMap;
use hyper_tls::HttpsConnector;
use hyper_util::client::legacy::connect::HttpConnector;
use opentelemetry::global::Error;
use opentelemetry::propagation::{Extractor, Injector};
use opentelemetry::trace::TracerProvider;
use opentelemetry::{global, KeyValue};
use opentelemetry_sdk::propagation::TraceContextPropagator;
use opentelemetry_sdk::{trace, Resource};
use prometheus::IntCounter;
use sentry::integrations::debug_images::DebugImagesIntegration;
use tonic::metadata::MetadataMap;
use tonic::transport::Endpoint;
use tracing::{warn, Event, Level, Span, Subscriber};
#[cfg(feature = "capture")]
use tracing_capture::{CaptureLayer, SharedStorage};
use tracing_opentelemetry::OpenTelemetrySpanExt;
use tracing_subscriber::filter::Directive;
use tracing_subscriber::fmt::format::{format, Writer};
use tracing_subscriber::fmt::{self, FmtContext, FormatEvent, FormatFields};
use tracing_subscriber::layer::{Layer, SubscriberExt};
use tracing_subscriber::registry::LookupSpan;
use tracing_subscriber::util::SubscriberInitExt;
use tracing_subscriber::{reload, EnvFilter, Registry};
use crate::metric;
use crate::metrics::MetricsRegistry;
#[cfg(feature = "tokio-console")]
use crate::netio::SocketAddr;
/// Application tracing configuration.
///
/// See the [`configure`] function for details.
#[derive(Derivative)]
#[derivative(Debug)]
pub struct TracingConfig<F> {
/// The name of the service.
pub service_name: &'static str,
/// Configuration of the stderr log.
pub stderr_log: StderrLogConfig,
/// Optional configuration of the [`opentelemetry`] library.
pub opentelemetry: Option<OpenTelemetryConfig>,
/// Optional configuration for the [Tokio console] integration.
///
/// [Tokio console]: https://github.com/tokio-rs/console
#[cfg_attr(nightly_doc_features, doc(cfg(feature = "tokio-console")))]
#[cfg(feature = "tokio-console")]
pub tokio_console: Option<TokioConsoleConfig>,
/// Optional configuration for capturing spans during tests.
#[cfg(feature = "capture")]
#[derivative(Debug = "ignore")]
pub capture: Option<SharedStorage>,
/// Optional Sentry configuration.
pub sentry: Option<SentryConfig<F>>,
/// The version of this build of the service.
pub build_version: &'static str,
/// The commit SHA of this build of the service.
pub build_sha: &'static str,
/// The time of this build of the service.
pub build_time: &'static str,
/// Registry for prometheus metrics.
pub registry: MetricsRegistry,
}
/// Configures Sentry reporting.
#[derive(Debug, Clone)]
pub struct SentryConfig<F> {
/// Sentry data source name to submit events to.
pub dsn: String,
/// The environment name to report to Sentry.
///
/// If unset, the Sentry SDK will attempt to read the value from the
/// `SENTRY_ENVIRONMENT` environment variable.
pub environment: Option<String>,
/// Additional tags to include on each Sentry event/exception.
pub tags: BTreeMap<String, String>,
/// A filter that classifies events before sending them to Sentry.
pub event_filter: F,
}
/// Configures the stderr log.
#[derive(Debug)]
pub struct StderrLogConfig {
/// The format in which to emit messages.
pub format: StderrLogFormat,
/// A filter which determines which events are emitted to the log.
pub filter: EnvFilter,
}
/// Specifies the format of a stderr log message.
#[derive(Debug, Clone)]
pub enum StderrLogFormat {
/// Format as human readable, optionally colored text.
///
/// Best suited for direct human consumption in a terminal.
Text {
/// An optional prefix for each log message.
prefix: Option<String>,
},
/// Format as JSON (in reality, JSONL).
///
/// Best suited for ingestion in structured logging aggregators.
Json,
}
/// Configuration for the [`opentelemetry`] library.
#[derive(Debug)]
pub struct OpenTelemetryConfig {
/// The [OTLP/HTTP] endpoint to export OpenTelemetry data to.
///
/// [OTLP/HTTP]: https://github.com/open-telemetry/opentelemetry-specification/blob/b13c1648bae16323868a5caf614bc10c917cc6ca/specification/protocol/otlp.md#otlphttp
pub endpoint: String,
/// Additional headers to send with every request to the endpoint.
pub headers: HeaderMap,
/// A filter which determines which events are exported.
pub filter: EnvFilter,
/// How many spans can be queued before dropping.
pub max_batch_queue_size: usize,
/// How many spans to process in a single batch
pub max_export_batch_size: usize,
/// How many concurrent export tasks to allow.
/// More tasks can lead to more memory consumed by the exporter.
pub max_concurrent_exports: usize,
/// Delay between consecutive batch exports.
pub batch_scheduled_delay: Duration,
/// How long to wait for a batch to be sent before dropping it.
pub max_export_timeout: Duration,
/// `opentelemetry::sdk::resource::Resource` to include with all
/// traces.
pub resource: Resource,
}
/// Configuration of the [Tokio console] integration.
///
/// [Tokio console]: https://github.com/tokio-rs/console
#[cfg_attr(nightly_doc_features, doc(cfg(feature = "tokio-console")))]
#[cfg(feature = "tokio-console")]
#[derive(Debug, Clone)]
pub struct TokioConsoleConfig {
/// The address on which to listen for Tokio console connections.
///
/// See [`console_subscriber::Builder::server_addr`].
pub listen_addr: SocketAddr,
/// How frequently to publish updates to clients.
///
/// See [`console_subscriber::Builder::publish_interval`].
pub publish_interval: Duration,
/// How long data is retained for completed tasks.
///
/// See [`console_subscriber::Builder::retention`].
pub retention: Duration,
}
type Reloader = Arc<dyn Fn(EnvFilter, Vec<Directive>) -> Result<(), anyhow::Error> + Send + Sync>;
type DirectiveReloader = Arc<dyn Fn(Vec<Directive>) -> Result<(), anyhow::Error> + Send + Sync>;
/// A handle to the tracing infrastructure configured with [`configure`].
#[derive(Clone)]
pub struct TracingHandle {
stderr_log: Reloader,
opentelemetry: Reloader,
sentry: DirectiveReloader,
}
impl TracingHandle {
/// Creates a inoperative tracing handle.
///
/// Primarily useful in tests.
pub fn disabled() -> TracingHandle {
TracingHandle {
stderr_log: Arc::new(|_, _| Ok(())),
opentelemetry: Arc::new(|_, _| Ok(())),
sentry: Arc::new(|_| Ok(())),
}
}
/// Dynamically reloads the stderr log filter.
pub fn reload_stderr_log_filter(
&self,
filter: EnvFilter,
defaults: Vec<Directive>,
) -> Result<(), anyhow::Error> {
(self.stderr_log)(filter, defaults)
}
/// Dynamically reloads the OpenTelemetry log filter.
pub fn reload_opentelemetry_filter(
&self,
filter: EnvFilter,
defaults: Vec<Directive>,
) -> Result<(), anyhow::Error> {
(self.opentelemetry)(filter, defaults)
}
/// Dynamically reloads the additional sentry directives.
pub fn reload_sentry_directives(&self, defaults: Vec<Directive>) -> Result<(), anyhow::Error> {
(self.sentry)(defaults)
}
}
impl std::fmt::Debug for TracingHandle {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
f.debug_struct("TracingHandle").finish_non_exhaustive()
}
}
/// A guard for the tracing infrastructure configured with [`configure`].
///
/// This guard should be kept alive for the lifetime of the program.
#[must_use = "Must hold for the lifetime of the program, otherwise tracing will be shutdown"]
pub struct TracingGuard {
_sentry_guard: Option<sentry::ClientInitGuard>,
}
impl Drop for TracingGuard {
fn drop(&mut self) {
opentelemetry::global::shutdown_tracer_provider();
}
}
impl std::fmt::Debug for TracingGuard {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
f.debug_struct("TracingGuard").finish_non_exhaustive()
}
}
// Note that the following defaults are used on startup, regardless of the
// parameters in LaunchDarkly. If we need to, we can add cli flags to control
// then going forward.
/// By default we turn off tracing from the following crates, because they
/// have error spans which are noisy.
///
/// Note: folks should feel free to add more crates here if we find more
/// with long lived Spans.
pub const LOGGING_DEFAULTS_STR: [&str; 1] = ["kube_client::client::builder=off"];
/// Same as [`LOGGING_DEFAULTS_STR`], but structured as [`Directive`]s.
pub static LOGGING_DEFAULTS: LazyLock<Vec<Directive>> = LazyLock::new(|| {
LOGGING_DEFAULTS_STR
.into_iter()
.map(|directive| Directive::from_str(directive).expect("valid directive"))
.collect()
});
/// By default we turn off tracing from the following crates, because they
/// have long-lived Spans, which OpenTelemetry does not handle well.
///
/// Note: folks should feel free to add more crates here if we find more
/// with long lived Spans.
pub const OPENTELEMETRY_DEFAULTS_STR: [&str; 2] = ["h2=off", "hyper=off"];
/// Same as [`OPENTELEMETRY_DEFAULTS_STR`], but structured as [`Directive`]s.
pub static OPENTELEMETRY_DEFAULTS: LazyLock<Vec<Directive>> = LazyLock::new(|| {
OPENTELEMETRY_DEFAULTS_STR
.into_iter()
.map(|directive| Directive::from_str(directive).expect("valid directive"))
.collect()
});
/// By default we turn off tracing from the following crates, because they
/// have error spans which are noisy.
pub const SENTRY_DEFAULTS_STR: [&str; 2] =
["kube_client::client::builder=off", "mysql_async::conn=off"];
/// Same as [`SENTRY_DEFAULTS_STR`], but structured as [`Directive`]s.
pub static SENTRY_DEFAULTS: LazyLock<Vec<Directive>> = LazyLock::new(|| {
SENTRY_DEFAULTS_STR
.into_iter()
.map(|directive| Directive::from_str(directive).expect("valid directive"))
.collect()
});
/// The [`GLOBAL_SUBSCRIBER`] type.
type GlobalSubscriber = Arc<dyn Subscriber + Send + Sync + 'static>;
/// An [`Arc`] of the tracing [`Subscriber`] constructed and initialized in
/// [`configure`]. The value is written when [`configure`] runs.
pub static GLOBAL_SUBSCRIBER: OnceLock<GlobalSubscriber> = OnceLock::new();
/// Enables application tracing via the [`tracing`] and [`opentelemetry`]
/// libraries.
///
/// The `tracing` library is configured to emit events as textual log lines to
/// stderr. [`StderrLogConfig`] offer a small degree of control over this
/// behavior.
///
/// If the `opentelemetry` parameter is `Some`, the `tracing` library is
/// additionally configured to export events to an observability backend, like
/// [Jaeger] or [Honeycomb].
///
/// The `tokio_console` parameter enables integration with the [Tokio console].
/// When enabled, `tracing` events are collected and made available to the Tokio
/// console via a server running on port
///
/// [Jaeger]: https://jaegertracing.io
/// [Honeycomb]: https://www.honeycomb.io
/// [Tokio console]: https://github.com/tokio-rs/console
// Setting up OpenTelemetry in the background requires we are in a Tokio runtime
// context, hence the `async`.
#[allow(clippy::unused_async)]
pub async fn configure<F>(
config: TracingConfig<F>,
) -> Result<(TracingHandle, TracingGuard), anyhow::Error>
where
F: Fn(&tracing::Metadata<'_>) -> sentry_tracing::EventFilter + Send + Sync + 'static,
{
let stderr_log_layer: Box<dyn Layer<Registry> + Send + Sync> = match config.stderr_log.format {
StderrLogFormat::Text { prefix } => {
// See: https://no-color.org/
let no_color = std::env::var_os("NO_COLOR").unwrap_or_else(|| "".into()) != "";
Box::new(
fmt::layer()
.with_writer(io::stderr)
.event_format(PrefixFormat {
inner: format(),
prefix,
})
.with_ansi(!no_color && io::stderr().is_terminal()),
)
}
StderrLogFormat::Json => Box::new(
fmt::layer()
.with_writer(io::stderr)
.json()
.with_current_span(true),
),
};
let (stderr_log_filter, stderr_log_filter_reloader) = reload::Layer::new({
let mut filter = config.stderr_log.filter;
for directive in LOGGING_DEFAULTS.iter() {
filter = filter.add_directive(directive.clone());
}
filter
});
let stderr_log_layer = stderr_log_layer.with_filter(stderr_log_filter);
let stderr_log_reloader = Arc::new(move |mut filter: EnvFilter, defaults: Vec<Directive>| {
for directive in &defaults {
filter = filter.add_directive(directive.clone());
}
Ok(stderr_log_filter_reloader.reload(filter)?)
});
let (otel_layer, otel_reloader): (_, Reloader) = if let Some(otel_config) = config.opentelemetry
{
opentelemetry::global::set_text_map_propagator(TraceContextPropagator::new());
// Manually set up an OpenSSL-backed, h2, proxied `Channel`,
// with the timeout configured according to:
// https://docs.rs/opentelemetry-otlp/latest/opentelemetry_otlp/struct.TonicExporterBuilder.html#method.with_channel
let channel = Endpoint::from_shared(otel_config.endpoint)?
.timeout(Duration::from_secs(
opentelemetry_otlp::OTEL_EXPORTER_OTLP_TIMEOUT_DEFAULT,
))
// TODO(guswynn): investigate if this should be non-lazy.
.connect_with_connector_lazy({
let mut http = HttpConnector::new();
http.enforce_http(false);
HttpsConnector::from((
http,
// This is the same as the default, plus an h2 ALPN request.
tokio_native_tls::TlsConnector::from(
native_tls::TlsConnector::builder()
.request_alpns(&["h2"])
.build()
.unwrap(),
),
))
});
let exporter = opentelemetry_otlp::new_exporter()
.tonic()
.with_channel(channel)
.with_metadata(MetadataMap::from_headers(otel_config.headers));
let batch_config = opentelemetry_sdk::trace::BatchConfigBuilder::default()
.with_max_queue_size(otel_config.max_batch_queue_size)
.with_max_export_batch_size(otel_config.max_export_batch_size)
.with_max_concurrent_exports(otel_config.max_concurrent_exports)
.with_scheduled_delay(otel_config.batch_scheduled_delay)
.with_max_export_timeout(otel_config.max_export_timeout)
.build();
let tracer = opentelemetry_otlp::new_pipeline()
.tracing()
.with_trace_config(
trace::Config::default().with_resource(
// The latter resources win, so if the user specifies
// `service.name` in the configuration, it will override the
// `service.name` value we configure here.
Resource::new([KeyValue::new(
"service.name",
config.service_name.to_string(),
)])
.merge(&otel_config.resource),
),
)
.with_exporter(exporter)
.with_batch_config(batch_config)
.install_batch(opentelemetry_sdk::runtime::Tokio)
.unwrap()
.tracer(config.service_name);
// Create our own error handler to:
// 1. Rate limit the number of error logs. By default the OTel library will emit
// an enormous number of duplicate logs if any errors occur, one per batch
// send attempt, until the error is resolved.
// 2. Log the errors via our tracing layer, so they are formatted consistently
// with the rest of our logs, rather than the direct `eprintln` used by the
// OTel library.
const OPENTELEMETRY_ERROR_MSG_BACKOFF_SECONDS: u64 = 30;
let last_log_in_epoch_seconds = AtomicU64::default();
opentelemetry::global::set_error_handler(move |err| {
let now = std::time::SystemTime::now()
.duration_since(std::time::SystemTime::UNIX_EPOCH)
.expect("Failed to get duration since Unix epoch")
.as_secs();
let last_log = last_log_in_epoch_seconds.load(Ordering::SeqCst);
if now.saturating_sub(last_log) >= OPENTELEMETRY_ERROR_MSG_BACKOFF_SECONDS {
if last_log_in_epoch_seconds
.compare_exchange_weak(last_log, now, Ordering::Relaxed, Ordering::Relaxed)
.is_err()
{
return;
}
use crate::error::ErrorExt;
match err {
Error::Trace(err) => {
warn!("OpenTelemetry error: {}", err.display_with_causes());
}
// TODO(guswynn): turn off the metrics feature?
Error::Metric(err) => {
warn!("OpenTelemetry error: {}", err.display_with_causes());
}
Error::Other(err) => {
warn!("OpenTelemetry error: {}", err);
}
_ => {
warn!("unknown OpenTelemetry error");
}
}
}
})
.expect("valid error handler");
let (filter, filter_handle) = reload::Layer::new({
let mut filter = otel_config.filter;
for directive in OPENTELEMETRY_DEFAULTS.iter() {
filter = filter.add_directive(directive.clone());
}
filter
});
let metrics_layer = MetricsLayer::new(&config.registry);
let layer = tracing_opentelemetry::layer()
// OpenTelemetry does not handle long-lived Spans well, and they end up continuously
// eating memory until OOM. So we set a max number of events that are allowed to be
// logged to a Span, once this max is passed, old events will get dropped
//
// TODO(parker-timmerman|guswynn): make this configurable with LaunchDarkly
.max_events_per_span(2048)
.with_tracer(tracer)
.and_then(metrics_layer)
// WARNING, ENTERING SPOOKY ZONE 2.0
//
// Notice we use `with_filter` here. `and_then` will apply the filter globally.
.with_filter(filter);
let reloader = Arc::new(move |mut filter: EnvFilter, defaults: Vec<Directive>| {
// Re-apply our defaults on reload.
for directive in &defaults {
filter = filter.add_directive(directive.clone());
}
Ok(filter_handle.reload(filter)?)
});
(Some(layer), reloader)
} else {
let reloader = Arc::new(|_, _| Ok(()));
(None, reloader)
};
#[cfg(feature = "tokio-console")]
let tokio_console_layer = if let Some(console_config) = config.tokio_console.clone() {
let builder = ConsoleLayer::builder()
.publish_interval(console_config.publish_interval)
.retention(console_config.retention);
let builder = match console_config.listen_addr {
SocketAddr::Inet(addr) => builder.server_addr(addr),
SocketAddr::Unix(addr) => {
let path = addr.as_pathname().unwrap().as_ref();
builder.server_addr(path)
}
};
Some(builder.spawn())
} else {
None
};
let (sentry_guard, sentry_layer, sentry_reloader): (_, _, DirectiveReloader) =
if let Some(sentry_config) = config.sentry {
let guard = sentry::init((
sentry_config.dsn,
sentry::ClientOptions {
attach_stacktrace: true,
release: Some(format!("materialize@{0}", config.build_version).into()),
environment: sentry_config.environment.map(Into::into),
integrations: vec![Arc::new(DebugImagesIntegration::new())],
..Default::default()
},
));
sentry::configure_scope(|scope| {
scope.set_tag("service_name", config.service_name);
scope.set_tag("build_sha", config.build_sha.to_string());
scope.set_tag("build_time", config.build_time.to_string());
for (k, v) in sentry_config.tags {
scope.set_tag(&k, v);
}
});
let (filter, filter_handle) = reload::Layer::new({
// Please see the comment on `with_filter` below.
let mut filter = EnvFilter::new("info");
for directive in SENTRY_DEFAULTS.iter() {
filter = filter.add_directive(directive.clone());
}
filter
});
let layer = sentry_tracing::layer()
.event_filter(sentry_config.event_filter)
// WARNING, ENTERING THE SPOOKY ZONE
//
// While sentry provides an event filter above that maps events to types of sentry events, its `Layer`
// implementation does not participate in `tracing`'s level-fast-path implementation, which depends on
// a hidden api (<https://github.com/tokio-rs/tracing/blob/b28c9351dd4f34ed3c7d5df88bb5c2e694d9c951/tracing-subscriber/src/layer/mod.rs#L861-L867>)
// which is primarily manged by filters (like below). The fast path skips verbose log
// (and span) levels that no layer is interested by reading a single atomic. Usually, not implementing this
// api means "give me everything, including `trace`, unless you attach a filter to me.
//
// The curious thing here (and a bug in tracing) is that _some configurations of our layer stack above_,
// if you don't have this filter can cause the fast-path to trigger, despite the fact
// that the sentry layer would specifically communicating that it wants to see
// everything. This bug appears to be related to the presence of a `reload::Layer`
// _around a filter, not a layer_, and guswynn is tracking investigating it here:
// <https://github.com/MaterializeInc/database-issues/issues/4794>. Because we don't
// enable a reload-able filter in CI/locally, but DO in production (the otel layer), it
// was once possible to trigger and rely on the fast path in CI, but not notice that it
// was disabled in production.
//
// The behavior of this optimization is now tested in various scenarios (in
// `test/tracing`). Regardless, when the upstream bug is fixed/resolved,
// we will continue to place this here, as the sentry layer only cares about
// events <= INFO, so we want to use the fast-path if no other layer
// is interested in high-fidelity events.
.with_filter(filter);
let reloader = Arc::new(move |defaults: Vec<Directive>| {
// Please see the comment on `with_filter` above.
let mut filter = EnvFilter::new("info");
// Re-apply our defaults on reload.
for directive in &defaults {
filter = filter.add_directive(directive.clone());
}
Ok(filter_handle.reload(filter)?)
});
(Some(guard), Some(layer), reloader)
} else {
let reloader = Arc::new(|_| Ok(()));
(None, None, reloader)
};
#[cfg(feature = "capture")]
let capture = config.capture.map(|storage| CaptureLayer::new(&storage));
let stack = tracing_subscriber::registry();
let stack = stack.with(stderr_log_layer);
#[cfg(feature = "capture")]
let stack = stack.with(capture);
let stack = stack.with(otel_layer);
#[cfg(feature = "tokio-console")]
let stack = stack.with(tokio_console_layer);
let stack = stack.with(sentry_layer);
// Set the stack as a global subscriber.
assert!(GLOBAL_SUBSCRIBER.set(Arc::new(stack)).is_ok());
// Initialize the subscriber.
Arc::clone(GLOBAL_SUBSCRIBER.get().unwrap()).init();
#[cfg(feature = "tokio-console")]
if let Some(console_config) = config.tokio_console {
let endpoint = match console_config.listen_addr {
SocketAddr::Inet(addr) => format!("http://{addr}"),
SocketAddr::Unix(addr) => format!("file://localhost{addr}"),
};
tracing::info!("starting tokio console on {endpoint}");
}
let handle = TracingHandle {
stderr_log: stderr_log_reloader,
opentelemetry: otel_reloader,
sentry: sentry_reloader,
};
let guard = TracingGuard {
_sentry_guard: sentry_guard,
};
Ok((handle, guard))
}
/// Returns the [`Level`] of a crate from an [`EnvFilter`] by performing an
/// exact match between `crate` and the original `EnvFilter` directive.
pub fn crate_level(filter: &EnvFilter, crate_name: &'static str) -> Level {
// TODO: implement `would_enable` on `EnvFilter` or equivalent
// to avoid having to manually parse out the directives. This
// would also significantly broaden the lookups the fn is able
// to do (modules, spans, fields, etc).
let mut default_level = Level::ERROR;
// EnvFilter roundtrips through its Display fmt, so it
// is safe to split out its individual directives here
for directive in format!("{}", filter).split(',') {
match directive.split('=').collect::<Vec<_>>().as_slice() {
[target, level] => {
if *target == crate_name {
match Level::from_str(*level) {
Ok(level) => return level,
Err(err) => warn!("invalid level for {}: {}", target, err),
}
}
}
[token] => match Level::from_str(*token) {
Ok(level) => default_level = default_level.max(level),
Err(_) => {
// a target without a level is interpreted as trace
if *token == crate_name {
default_level = default_level.max(Level::TRACE);
}
}
},
_ => {}
}
}
default_level
}
/// A wrapper around a [`FormatEvent`] that adds an optional prefix to each
/// event.
#[derive(Debug)]
pub struct PrefixFormat<F> {
inner: F,
prefix: Option<String>,
}
impl<F, C, N> FormatEvent<C, N> for PrefixFormat<F>
where
C: Subscriber + for<'a> LookupSpan<'a>,
N: for<'a> FormatFields<'a> + 'static,
F: FormatEvent<C, N>,
{
fn format_event(
&self,
ctx: &FmtContext<'_, C, N>,
mut writer: Writer<'_>,
event: &Event<'_>,
) -> std::fmt::Result {
match &self.prefix {
None => self.inner.format_event(ctx, writer, event)?,
Some(prefix) => {
let mut prefix = yansi::Paint::new(prefix);
if writer.has_ansi_escapes() {
prefix = prefix.bold();
}
write!(writer, "{}: ", prefix)?;
self.inner.format_event(ctx, writer, event)?;
}
}
Ok(())
}
}
/// An OpenTelemetry context.
///
/// Allows associating [`tracing`] spans across task or thread boundaries.
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct OpenTelemetryContext {
inner: BTreeMap<String, String>,
}
impl OpenTelemetryContext {
/// Attaches this `Context` to the current [`tracing`] span,
/// as its parent.
///
/// If there is not enough information in this `OpenTelemetryContext`
/// to create a context, then the current thread's `Context` is used
/// defaulting to the default `Context`.
pub fn attach_as_parent(&self) {
let parent_cx = global::get_text_map_propagator(|prop| prop.extract(self));
tracing::Span::current().set_parent(parent_cx);
}
/// Attaches this `Context` to the given [`tracing`] Span, as its parent.
/// as its parent.
///
/// If there is not enough information in this `OpenTelemetryContext`
/// to create a context, then the current thread's `Context` is used
/// defaulting to the default `Context`.
pub fn attach_as_parent_to(&self, span: &mut Span) {
let parent_cx = global::get_text_map_propagator(|prop| prop.extract(self));
span.set_parent(parent_cx);
}
/// Obtains a `Context` from the current [`tracing`] span.
pub fn obtain() -> Self {
let mut context = Self::empty();
global::get_text_map_propagator(|propagator| {
propagator.inject_context(&tracing::Span::current().context(), &mut context)
});
context
}
/// Obtains an empty `Context`.
pub fn empty() -> Self {
Self {
inner: BTreeMap::new(),
}
}
}
impl Extractor for OpenTelemetryContext {
fn get(&self, key: &str) -> Option<&str> {
self.inner.get(&key.to_lowercase()).map(|v| v.as_str())
}
fn keys(&self) -> Vec<&str> {
self.inner.keys().map(|k| k.as_str()).collect::<Vec<_>>()
}
}
impl Injector for OpenTelemetryContext {
fn set(&mut self, key: &str, value: String) {
self.inner.insert(key.to_lowercase(), value);
}
}
impl From<OpenTelemetryContext> for BTreeMap<String, String> {
fn from(ctx: OpenTelemetryContext) -> Self {
ctx.inner
}
}
impl From<BTreeMap<String, String>> for OpenTelemetryContext {
fn from(map: BTreeMap<String, String>) -> Self {
Self { inner: map }
}
}
struct MetricsLayer {
on_close: IntCounter,
}
impl MetricsLayer {
fn new(registry: &MetricsRegistry) -> Self {
MetricsLayer {
on_close: registry.register(metric!(
name: "mz_otel_on_close",
help: "count of on_close events sent to otel",
)),
}
}
}
impl<S: tracing::Subscriber> Layer<S> for MetricsLayer {
fn on_close(&self, _id: tracing::span::Id, _ctx: tracing_subscriber::layer::Context<'_, S>) {
self.on_close.inc()
}
}
#[cfg(test)]
mod tests {
use std::str::FromStr;
use tracing::Level;
use tracing_subscriber::filter::{EnvFilter, LevelFilter, Targets};
#[crate::test]
fn overriding_targets() {
let user_defined = Targets::new().with_target("my_crate", Level::INFO);
let default = Targets::new().with_target("my_crate", LevelFilter::OFF);
assert!(!default.would_enable("my_crate", &Level::INFO));
// The user_defined filters should override the default
let filters = Targets::new()
.with_targets(default)
.with_targets(user_defined);
assert!(filters.would_enable("my_crate", &Level::INFO));
}
#[crate::test]
fn crate_level() {
// target=level directives only. should default to ERROR if unspecified
let filter = EnvFilter::from_str("abc=trace,def=debug").expect("valid");
assert_eq!(super::crate_level(&filter, "abc"), Level::TRACE);
assert_eq!(super::crate_level(&filter, "def"), Level::DEBUG);
assert_eq!(super::crate_level(&filter, "def"), Level::DEBUG);
assert_eq!(
super::crate_level(&filter, "abc::doesnt::exist"),
Level::ERROR
);
assert_eq!(super::crate_level(&filter, "doesnt::exist"), Level::ERROR);
// add in a global default
let filter = EnvFilter::from_str("abc=trace,def=debug,info").expect("valid");
assert_eq!(super::crate_level(&filter, "abc"), Level::TRACE);
assert_eq!(
super::crate_level(&filter, "abc::doesnt:exist"),
Level::INFO
);
assert_eq!(super::crate_level(&filter, "def"), Level::DEBUG);
assert_eq!(super::crate_level(&filter, "nan"), Level::INFO);
// a directive with mod path doesn't match the top-level crate
let filter = EnvFilter::from_str("abc::def::ghi=trace,debug").expect("valid");
assert_eq!(super::crate_level(&filter, "abc"), Level::DEBUG);
assert_eq!(super::crate_level(&filter, "def"), Level::DEBUG);
assert_eq!(
super::crate_level(&filter, "gets_the_default"),
Level::DEBUG
);
// directives with spans and fields don't match the top-level crate
let filter =
EnvFilter::from_str("abc[s]=trace,def[s{g=h}]=debug,[{s2}]=debug,info").expect("valid");
assert_eq!(super::crate_level(&filter, "abc"), Level::INFO);
assert_eq!(super::crate_level(&filter, "def"), Level::INFO);
assert_eq!(super::crate_level(&filter, "gets_the_default"), Level::INFO);
// a bare target without a level is taken as trace
let filter = EnvFilter::from_str("abc,info").expect("valid");
assert_eq!(super::crate_level(&filter, "abc"), Level::TRACE);
assert_eq!(super::crate_level(&filter, "gets_the_default"), Level::INFO);
// the contract of `crate_level` is that it only matches top-level crates.
// if we had a proper EnvFilter::would_match impl, this assertion should
// be Level::TRACE
assert_eq!(super::crate_level(&filter, "abc::def"), Level::INFO);
}
}