/
mod.rs
1798 lines (1707 loc) · 68.5 KB
/
mod.rs
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
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! The [`Layer`] trait, a composable abstraction for building [`Subscriber`]s.
//!
//! The [`Subscriber`] trait in `tracing-core` represents the _complete_ set of
//! functionality required to consume `tracing` instrumentation. This means that
//! a single `Subscriber` instance is a self-contained implementation of a
//! complete strategy for collecting traces; but it _also_ means that the
//! `Subscriber` trait cannot easily be composed with other `Subscriber`s.
//!
//! In particular, [`Subscriber`]s are responsible for generating [span IDs] and
//! assigning them to spans. Since these IDs must uniquely identify a span
//! within the context of the current trace, this means that there may only be
//! a single `Subscriber` for a given thread at any point in time —
//! otherwise, there would be no authoritative source of span IDs.
//!
//! On the other hand, the majority of the [`Subscriber`] trait's functionality
//! is composable: any number of subscribers may _observe_ events, span entry
//! and exit, and so on, provided that there is a single authoritative source of
//! span IDs. The [`Layer`] trait represents this composable subset of the
//! [`Subscriber`] behavior; it can _observe_ events and spans, but does not
//! assign IDs.
//!
//! # Composing Layers
//!
//! Since a [`Layer`] does not implement a complete strategy for collecting
//! traces, it must be composed with a `Subscriber` in order to be used. The
//! [`Layer`] trait is generic over a type parameter (called `S` in the trait
//! definition), representing the types of `Subscriber` they can be composed
//! with. Thus, a [`Layer`] may be implemented that will only compose with a
//! particular `Subscriber` implementation, or additional trait bounds may be
//! added to constrain what types implementing `Subscriber` a `Layer` can wrap.
//!
//! `Layer`s may be added to a `Subscriber` by using the [`SubscriberExt::with`]
//! method, which is provided by `tracing-subscriber`'s [prelude]. This method
//! returns a [`Layered`] struct that implements `Subscriber` by composing the
//! `Layer` with the `Subscriber`.
//!
//! For example:
//! ```rust
//! use tracing_subscriber::Layer;
//! use tracing_subscriber::prelude::*;
//! use tracing::Subscriber;
//!
//! pub struct MyLayer {
//! // ...
//! }
//!
//! impl<S: Subscriber> Layer<S> for MyLayer {
//! // ...
//! }
//!
//! pub struct MySubscriber {
//! // ...
//! }
//!
//! # use tracing_core::{span::{Id, Attributes, Record}, Metadata, Event};
//! impl Subscriber for MySubscriber {
//! // ...
//! # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(1) }
//! # fn record(&self, _: &Id, _: &Record) {}
//! # fn event(&self, _: &Event) {}
//! # fn record_follows_from(&self, _: &Id, _: &Id) {}
//! # fn enabled(&self, _: &Metadata) -> bool { false }
//! # fn enter(&self, _: &Id) {}
//! # fn exit(&self, _: &Id) {}
//! }
//! # impl MyLayer {
//! # fn new() -> Self { Self {} }
//! # }
//! # impl MySubscriber {
//! # fn new() -> Self { Self { }}
//! # }
//!
//! let subscriber = MySubscriber::new()
//! .with(MyLayer::new());
//!
//! tracing::subscriber::set_global_default(subscriber);
//! ```
//!
//! Multiple `Layer`s may be composed in the same manner:
//! ```rust
//! # use tracing_subscriber::{Layer, layer::SubscriberExt};
//! # use tracing::Subscriber;
//! pub struct MyOtherLayer {
//! // ...
//! }
//!
//! impl<S: Subscriber> Layer<S> for MyOtherLayer {
//! // ...
//! }
//!
//! pub struct MyThirdLayer {
//! // ...
//! }
//!
//! impl<S: Subscriber> Layer<S> for MyThirdLayer {
//! // ...
//! }
//! # pub struct MyLayer {}
//! # impl<S: Subscriber> Layer<S> for MyLayer {}
//! # pub struct MySubscriber { }
//! # use tracing_core::{span::{Id, Attributes, Record}, Metadata, Event};
//! # impl Subscriber for MySubscriber {
//! # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(1) }
//! # fn record(&self, _: &Id, _: &Record) {}
//! # fn event(&self, _: &Event) {}
//! # fn record_follows_from(&self, _: &Id, _: &Id) {}
//! # fn enabled(&self, _: &Metadata) -> bool { false }
//! # fn enter(&self, _: &Id) {}
//! # fn exit(&self, _: &Id) {}
//! }
//! # impl MyLayer {
//! # fn new() -> Self { Self {} }
//! # }
//! # impl MyOtherLayer {
//! # fn new() -> Self { Self {} }
//! # }
//! # impl MyThirdLayer {
//! # fn new() -> Self { Self {} }
//! # }
//! # impl MySubscriber {
//! # fn new() -> Self { Self { }}
//! # }
//!
//! let subscriber = MySubscriber::new()
//! .with(MyLayer::new())
//! .with(MyOtherLayer::new())
//! .with(MyThirdLayer::new());
//!
//! tracing::subscriber::set_global_default(subscriber);
//! ```
//!
//! The [`Layer::with_subscriber`] constructs the [`Layered`] type from a
//! [`Layer`] and [`Subscriber`], and is called by [`SubscriberExt::with`]. In
//! general, it is more idiomatic to use [`SubscriberExt::with`], and treat
//! [`Layer::with_subscriber`] as an implementation detail, as `with_subscriber`
//! calls must be nested, leading to less clear code for the reader.
//!
//! ## Runtime Configuration With `Layer`s
//!
//! In some cases, a particular [`Layer`] may be enabled or disabled based on
//! runtime configuration. This can introduce challenges, because the type of a
//! layered [`Subscriber`] depends on which layers are added to it: if an `if`
//! or `match` expression adds some [`Layer`] implementation in one branch,
//! and other layers in another, the [`Subscriber`] values returned by those
//! branches will have different types. For example, the following _will not_
//! work:
//!
//! ```compile_fail
//! # fn docs() -> Result<(), Box<dyn std::error::Error + 'static>> {
//! # struct Config {
//! # is_prod: bool,
//! # path: &'static str,
//! # }
//! # let cfg = Config { is_prod: false, path: "debug.log" };
//! use std::fs::File;
//! use tracing_subscriber::{Registry, prelude::*};
//!
//! let stdout_log = tracing_subscriber::fmt::layer().pretty();
//! let subscriber = Registry::default().with(stdout_log);
//!
//! // The compile error will occur here because the if and else
//! // branches have different (and therefore incompatible) types.
//! let subscriber = if cfg.is_prod {
//! let file = File::create(cfg.path)?;
//! let layer = tracing_subscriber::fmt::layer()
//! .json()
//! .with_writer(Arc::new(file));
//! layer.with(subscriber)
//! } else {
//! layer
//! };
//!
//! tracing::subscriber::set_global_default(subscriber)
//! .expect("Unable to set global subscriber");
//! # Ok(()) }
//! ```
//!
//! However, a [`Layer`] wrapped in an [`Option`] [also implements the `Layer`
//! trait][option-impl]. This allows individual layers to be enabled or disabled at
//! runtime while always producing a [`Subscriber`] of the same type. For
//! example:
//!
//! ```
//! # fn docs() -> Result<(), Box<dyn std::error::Error + 'static>> {
//! # struct Config {
//! # is_prod: bool,
//! # path: &'static str,
//! # }
//! # let cfg = Config { is_prod: false, path: "debug.log" };
//! use std::fs::File;
//! use tracing_subscriber::{Registry, prelude::*};
//!
//! let stdout_log = tracing_subscriber::fmt::layer().pretty();
//! let subscriber = Registry::default().with(stdout_log);
//!
//! // if `cfg.is_prod` is true, also log JSON-formatted logs to a file.
//! let json_log = if cfg.is_prod {
//! let file = File::create(cfg.path)?;
//! let json_log = tracing_subscriber::fmt::layer()
//! .json()
//! .with_writer(file);
//! Some(json_log)
//! } else {
//! None
//! };
//!
//! // If `cfg.is_prod` is false, then `json` will be `None`, and this layer
//! // will do nothing. However, the subscriber will still have the same type
//! // regardless of whether the `Option`'s value is `None` or `Some`.
//! let subscriber = subscriber.with(json_log);
//!
//! tracing::subscriber::set_global_default(subscriber)
//! .expect("Unable to set global subscriber");
//! # Ok(()) }
//! ```
//!
//! If a [`Layer`] may be one of several different types, note that [`Box<dyn
//! Layer<S> + Send + Sync>` implements `Layer`][box-impl].
//! This may be used to erase the type of a [`Layer`].
//!
//! For example, a function that configures a [`Layer`] to log to one of
//! several outputs might return a `Box<dyn Layer<S> + Send + Sync + 'static>`:
//! ```
//! use tracing_subscriber::{
//! Layer,
//! registry::LookupSpan,
//! prelude::*,
//! };
//! use std::{path::PathBuf, fs::File, io};
//!
//! /// Configures whether logs are emitted to a file, to stdout, or to stderr.
//! pub enum LogConfig {
//! File(PathBuf),
//! Stdout,
//! Stderr,
//! }
//!
//! impl LogConfig {
//! pub fn layer<S>(self) -> Box<dyn Layer<S> + Send + Sync + 'static>
//! where
//! S: tracing_core::Subscriber,
//! for<'a> S: LookupSpan<'a>,
//! {
//! // Shared configuration regardless of where logs are output to.
//! let fmt = tracing_subscriber::fmt::layer()
//! .with_target(true)
//! .with_thread_names(true);
//!
//! // Configure the writer based on the desired log target:
//! match self {
//! LogConfig::File(path) => {
//! let file = File::create(path).expect("failed to create log file");
//! Box::new(fmt.with_writer(file))
//! },
//! LogConfig::Stdout => Box::new(fmt.with_writer(io::stdout)),
//! LogConfig::Stderr => Box::new(fmt.with_writer(io::stderr)),
//! }
//! }
//! }
//!
//! let config = LogConfig::Stdout;
//! tracing_subscriber::registry()
//! .with(config.layer())
//! .init();
//! ```
//!
//! The [`Layer::boxed`] method is provided to make boxing a `Layer`
//! more convenient, but [`Box::new`] may be used as well.
//!
//! When the number of `Layer`s varies at runtime, note that a
//! [`Vec<L> where L: Layer` also implements `Layer`][vec-impl]. This
//! can be used to add a variable number of `Layer`s to a `Subscriber`:
//!
//! ```
//! use tracing_subscriber::{Layer, prelude::*};
//! struct MyLayer {
//! // ...
//! }
//! # impl MyLayer { fn new() -> Self { Self {} }}
//!
//! impl<S: tracing_core::Subscriber> Layer<S> for MyLayer {
//! // ...
//! }
//!
//! /// Returns how many layers we need
//! fn how_many_layers() -> usize {
//! // ...
//! # 3
//! }
//!
//! // Create a variable-length `Vec` of layers
//! let mut layers = Vec::new();
//! for _ in 0..how_many_layers() {
//! layers.push(MyLayer::new());
//! }
//!
//! tracing_subscriber::registry()
//! .with(layers)
//! .init();
//! ```
//!
//! If a variable number of `Layer` is needed and those `Layer`s have
//! different types, a `Vec` of [boxed `Layer` trait objects][box-impl] may
//! be used. For example:
//!
//! ```
//! use tracing_subscriber::{filter::LevelFilter, Layer, prelude::*};
//! use std::fs::File;
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! struct Config {
//! enable_log_file: bool,
//! enable_stdout: bool,
//! enable_stderr: bool,
//! // ...
//! }
//! # impl Config {
//! # fn from_config_file()-> Result<Self, Box<dyn std::error::Error>> {
//! # // don't enable the log file so that the example doesn't actually create it
//! # Ok(Self { enable_log_file: false, enable_stdout: true, enable_stderr: true })
//! # }
//! # }
//!
//! let cfg = Config::from_config_file()?;
//!
//! // Based on our dynamically loaded config file, create any number of layers:
//! let mut layers = Vec::new();
//!
//! if cfg.enable_log_file {
//! let file = File::create("myapp.log")?;
//! let layer = tracing_subscriber::fmt::layer()
//! .with_thread_names(true)
//! .with_target(true)
//! .json()
//! .with_writer(file)
//! // Box the layer as a type-erased trait object, so that it can
//! // be pushed to the `Vec`.
//! .boxed();
//! layers.push(layer);
//! }
//!
//! if cfg.enable_stdout {
//! let layer = tracing_subscriber::fmt::layer()
//! .pretty()
//! .with_filter(LevelFilter::INFO)
//! // Box the layer as a type-erased trait object, so that it can
//! // be pushed to the `Vec`.
//! .boxed();
//! layers.push(layer);
//! }
//!
//! if cfg.enable_stdout {
//! let layer = tracing_subscriber::fmt::layer()
//! .with_target(false)
//! .with_filter(LevelFilter::WARN)
//! // Box the layer as a type-erased trait object, so that it can
//! // be pushed to the `Vec`.
//! .boxed();
//! layers.push(layer);
//! }
//!
//! tracing_subscriber::registry()
//! .with(layers)
//! .init();
//!# Ok(()) }
//! ```
//!
//! Finally, if the number of layers _changes_ at runtime, a `Vec` of
//! subscribers can be used alongside the [`reload`](crate::reload) module to
//! add or remove subscribers dynamically at runtime.
//!
//! [option-impl]: Layer#impl-Layer<S>-for-Option<L>
//! [box-impl]: Layer#impl-Layer%3CS%3E-for-Box%3Cdyn%20Layer%3CS%3E%20+%20Send%20+%20Sync%3E
//! [vec-impl]: Layer#impl-Layer<S>-for-Vec<L>
//! [prelude]: crate::prelude
//!
//! # Recording Traces
//!
//! The [`Layer`] trait defines a set of methods for consuming notifications from
//! tracing instrumentation, which are generally equivalent to the similarly
//! named methods on [`Subscriber`]. Unlike [`Subscriber`], the methods on
//! `Layer` are additionally passed a [`Context`] type, which exposes additional
//! information provided by the wrapped subscriber (such as [the current span])
//! to the layer.
//!
//! # Filtering with `Layer`s
//!
//! As well as strategies for handling trace events, the `Layer` trait may also
//! be used to represent composable _filters_. This allows the determination of
//! what spans and events should be recorded to be decoupled from _how_ they are
//! recorded: a filtering layer can be applied to other layers or
//! subscribers. `Layer`s can be used to implement _global filtering_, where a
//! `Layer` provides a filtering strategy for the entire subscriber.
//! Additionally, individual recording `Layer`s or sets of `Layer`s may be
//! combined with _per-layer filters_ that control what spans and events are
//! recorded by those layers.
//!
//! ## Global Filtering
//!
//! A `Layer` that implements a filtering strategy should override the
//! [`register_callsite`] and/or [`enabled`] methods. It may also choose to implement
//! methods such as [`on_enter`], if it wishes to filter trace events based on
//! the current span context.
//!
//! Note that the [`Layer::register_callsite`] and [`Layer::enabled`] methods
//! determine whether a span or event is enabled *globally*. Thus, they should
//! **not** be used to indicate whether an individual layer wishes to record a
//! particular span or event. Instead, if a layer is only interested in a subset
//! of trace data, but does *not* wish to disable other spans and events for the
//! rest of the layer stack should ignore those spans and events in its
//! notification methods.
//!
//! The filtering methods on a stack of `Layer`s are evaluated in a top-down
//! order, starting with the outermost `Layer` and ending with the wrapped
//! [`Subscriber`]. If any layer returns `false` from its [`enabled`] method, or
//! [`Interest::never()`] from its [`register_callsite`] method, filter
//! evaluation will short-circuit and the span or event will be disabled.
//!
//! ### Enabling Interest
//!
//! Whenever an tracing event (or span) is emitted, it goes through a number of
//! steps to determine how and how much it should be processed. The earlier an
//! event is disabled, the less work has to be done to process the event, so
//! `Layer`s that implement filtering should attempt to disable unwanted
//! events as early as possible. In order, each event checks:
//!
//! - [`register_callsite`], once per callsite (roughly: once per time that
//! `event!` or `span!` is written in the source code; this is cached at the
//! callsite). See [`Subscriber::register_callsite`] and
//! [`tracing_core::callsite`] for a summary of how this behaves.
//! - [`enabled`], once per emitted event (roughly: once per time that `event!`
//! or `span!` is *executed*), and only if `register_callsite` regesters an
//! [`Interest::sometimes`]. This is the main customization point to globally
//! filter events based on their [`Metadata`]. If an event can be disabled
//! based only on [`Metadata`], it should be, as this allows the construction
//! of the actual `Event`/`Span` to be skipped.
//! - For events only (and not spans), [`event_enabled`] is called just before
//! processing the event. This gives layers one last chance to say that
//! an event should be filtered out, now that the event's fields are known.
//!
//! ## Per-Layer Filtering
//!
//! **Note**: per-layer filtering APIs currently require the [`"registry"` crate
//! feature flag][feat] to be enabled.
//!
//! Sometimes, it may be desirable for one `Layer` to record a particular subset
//! of spans and events, while a different subset of spans and events are
//! recorded by other `Layer`s. For example:
//!
//! - A layer that records metrics may wish to observe only events including
//! particular tracked values, while a logging layer ignores those events.
//! - If recording a distributed trace is expensive, it might be desirable to
//! only send spans with `INFO` and lower verbosity to the distributed tracing
//! system, while logging more verbose spans to a file.
//! - Spans and events with a particular target might be recorded differently
//! from others, such as by generating an HTTP access log from a span that
//! tracks the lifetime of an HTTP request.
//!
//! The [`Filter`] trait is used to control what spans and events are
//! observed by an individual `Layer`, while still allowing other `Layer`s to
//! potentially record them. The [`Layer::with_filter`] method combines a
//! `Layer` with a [`Filter`], returning a [`Filtered`] layer.
//!
//! This crate's [`filter`] module provides a number of types which implement
//! the [`Filter`] trait, such as [`LevelFilter`], [`Targets`], and
//! [`FilterFn`]. These [`Filter`]s provide ready-made implementations of
//! common forms of filtering. For custom filtering policies, the [`FilterFn`]
//! and [`DynFilterFn`] types allow implementing a [`Filter`] with a closure or
//! function pointer. In addition, when more control is required, the [`Filter`]
//! trait may also be implemented for user-defined types.
//!
//! <pre class="compile_fail" style="white-space:normal;font:inherit;">
//! <strong>Warning</strong>: Currently, the <a href="../struct.Registry.html">
//! <code>Registry</code></a> type defined in this crate is the only root
//! <code>Subscriber</code> capable of supporting <code>Layer</code>s with
//! per-layer filters. In the future, new APIs will be added to allow other
//! root <code>Subscriber</code>s to support per-layer filters.
//! </pre>
//!
//! For example, to generate an HTTP access log based on spans with
//! the `http_access` target, while logging other spans and events to
//! standard out, a [`Filter`] can be added to the access log layer:
//!
//! ```
//! use tracing_subscriber::{filter, prelude::*};
//!
//! // Generates an HTTP access log.
//! let access_log = // ...
//! # filter::LevelFilter::INFO;
//!
//! // Add a filter to the access log layer so that it only observes
//! // spans and events with the `http_access` target.
//! let access_log = access_log.with_filter(filter::filter_fn(|metadata| {
//! // Returns `true` if and only if the span or event's target is
//! // "http_access".
//! metadata.target() == "http_access"
//! }));
//!
//! // A general-purpose logging layer.
//! let fmt_layer = tracing_subscriber::fmt::layer();
//!
//! // Build a subscriber that combines the access log and stdout log
//! // layers.
//! tracing_subscriber::registry()
//! .with(fmt_layer)
//! .with(access_log)
//! .init();
//! ```
//!
//! Multiple layers can have their own, separate per-layer filters. A span or
//! event will be recorded if it is enabled by _any_ per-layer filter, but it
//! will be skipped by the layers whose filters did not enable it. Building on
//! the previous example:
//!
//! ```
//! use tracing_subscriber::{filter::{filter_fn, LevelFilter}, prelude::*};
//!
//! let access_log = // ...
//! # LevelFilter::INFO;
//! let fmt_layer = tracing_subscriber::fmt::layer();
//!
//! tracing_subscriber::registry()
//! // Add the filter for the "http_access" target to the access
//! // log layer, like before.
//! .with(access_log.with_filter(filter_fn(|metadata| {
//! metadata.target() == "http_access"
//! })))
//! // Add a filter for spans and events with the INFO level
//! // and below to the logging layer.
//! .with(fmt_layer.with_filter(LevelFilter::INFO))
//! .init();
//!
//! // Neither layer will observe this event
//! tracing::debug!(does_anyone_care = false, "a tree fell in the forest");
//!
//! // This event will be observed by the logging layer, but not
//! // by the access log layer.
//! tracing::warn!(dose_roentgen = %3.8, "not great, but not terrible");
//!
//! // This event will be observed only by the access log layer.
//! tracing::trace!(target: "http_access", "HTTP request started");
//!
//! // Both layers will observe this event.
//! tracing::error!(target: "http_access", "HTTP request failed with a very bad error!");
//! ```
//!
//! A per-layer filter can be applied to multiple [`Layer`]s at a time, by
//! combining them into a [`Layered`] layer using [`Layer::and_then`], and then
//! calling [`Layer::with_filter`] on the resulting [`Layered`] layer.
//!
//! Consider the following:
//! - `layer_a` and `layer_b`, which should only receive spans and events at
//! the [`INFO`] [level] and above.
//! - A third layer, `layer_c`, which should receive spans and events at
//! the [`DEBUG`] [level] as well.
//! The layers and filters would be composed thusly:
//!
//! ```
//! use tracing_subscriber::{filter::LevelFilter, prelude::*};
//!
//! let layer_a = // ...
//! # LevelFilter::INFO;
//! let layer_b = // ...
//! # LevelFilter::INFO;
//! let layer_c = // ...
//! # LevelFilter::INFO;
//!
//! let info_layers = layer_a
//! // Combine `layer_a` and `layer_b` into a `Layered` layer:
//! .and_then(layer_b)
//! // ...and then add an `INFO` `LevelFilter` to that layer:
//! .with_filter(LevelFilter::INFO);
//!
//! tracing_subscriber::registry()
//! // Add `layer_c` with a `DEBUG` filter.
//! .with(layer_c.with_filter(LevelFilter::DEBUG))
//! .with(info_layers)
//! .init();
//!```
//!
//! If a [`Filtered`] [`Layer`] is combined with another [`Layer`]
//! [`Layer::and_then`], and a filter is added to the [`Layered`] layer, that
//! layer will be filtered by *both* the inner filter and the outer filter.
//! Only spans and events that are enabled by *both* filters will be
//! observed by that layer. This can be used to implement complex filtering
//! trees.
//!
//! As an example, consider the following constraints:
//! - Suppose that a particular [target] is used to indicate events that
//! should be counted as part of a metrics system, which should be only
//! observed by a layer that collects metrics.
//! - A log of high-priority events ([`INFO`] and above) should be logged
//! to stdout, while more verbose events should be logged to a debugging log file.
//! - Metrics-focused events should *not* be included in either log output.
//!
//! In that case, it is possible to apply a filter to both logging layers to
//! exclude the metrics events, while additionally adding a [`LevelFilter`]
//! to the stdout log:
//!
//! ```
//! # // wrap this in a function so we don't actually create `debug.log` when
//! # // running the doctests..
//! # fn docs() -> Result<(), Box<dyn std::error::Error + 'static>> {
//! use tracing_subscriber::{filter, prelude::*};
//! use std::{fs::File, sync::Arc};
//!
//! // A layer that logs events to stdout using the human-readable "pretty"
//! // format.
//! let stdout_log = tracing_subscriber::fmt::layer()
//! .pretty();
//!
//! // A layer that logs events to a file.
//! let file = File::create("debug.log")?;
//! let debug_log = tracing_subscriber::fmt::layer()
//! .with_writer(Arc::new(file));
//!
//! // A layer that collects metrics using specific events.
//! let metrics_layer = /* ... */ filter::LevelFilter::INFO;
//!
//! tracing_subscriber::registry()
//! .with(
//! stdout_log
//! // Add an `INFO` filter to the stdout logging layer
//! .with_filter(filter::LevelFilter::INFO)
//! // Combine the filtered `stdout_log` layer with the
//! // `debug_log` layer, producing a new `Layered` layer.
//! .and_then(debug_log)
//! // Add a filter to *both* layers that rejects spans and
//! // events whose targets start with `metrics`.
//! .with_filter(filter::filter_fn(|metadata| {
//! !metadata.target().starts_with("metrics")
//! }))
//! )
//! .with(
//! // Add a filter to the metrics label that *only* enables
//! // events whose targets start with `metrics`.
//! metrics_layer.with_filter(filter::filter_fn(|metadata| {
//! metadata.target().starts_with("metrics")
//! }))
//! )
//! .init();
//!
//! // This event will *only* be recorded by the metrics layer.
//! tracing::info!(target: "metrics::cool_stuff_count", value = 42);
//!
//! // This event will only be seen by the debug log file layer:
//! tracing::debug!("this is a message, and part of a system of messages");
//!
//! // This event will be seen by both the stdout log layer *and*
//! // the debug log file layer, but not by the metrics layer.
//! tracing::warn!("the message is a warning about danger!");
//! # Ok(()) }
//! ```
//!
//! [`Subscriber`]: tracing_core::subscriber::Subscriber
//! [span IDs]: tracing_core::span::Id
//! [the current span]: Context::current_span
//! [`register_callsite`]: Layer::register_callsite
//! [`enabled`]: Layer::enabled
//! [`event_enabled`]: Layer::event_enabled
//! [`on_enter`]: Layer::on_enter
//! [`Layer::register_callsite`]: Layer::register_callsite
//! [`Layer::enabled`]: Layer::enabled
//! [`Interest::never()`]: tracing_core::subscriber::Interest::never()
//! [`Filtered`]: crate::filter::Filtered
//! [`filter`]: crate::filter
//! [`Targets`]: crate::filter::Targets
//! [`FilterFn`]: crate::filter::FilterFn
//! [`DynFilterFn`]: crate::filter::DynFilterFn
//! [level]: tracing_core::Level
//! [`INFO`]: tracing_core::Level::INFO
//! [`DEBUG`]: tracing_core::Level::DEBUG
//! [target]: tracing_core::Metadata::target
//! [`LevelFilter`]: crate::filter::LevelFilter
//! [feat]: crate#feature-flags
use crate::filter;
use tracing_core::{
metadata::Metadata,
span,
subscriber::{Interest, Subscriber},
Event, LevelFilter,
};
use core::any::TypeId;
feature! {
#![feature = "alloc"]
use alloc::boxed::Box;
use core::ops::{Deref, DerefMut};
}
mod context;
mod layered;
pub use self::{context::*, layered::*};
// The `tests` module is `pub(crate)` because it contains test utilities used by
// other modules.
#[cfg(test)]
pub(crate) mod tests;
/// A composable handler for `tracing` events.
///
/// A `Layer` implements a behavior for recording or collecting traces that can
/// be composed together with other `Layer`s to build a [`Subscriber`]. See the
/// [module-level documentation](crate::layer) for details.
///
/// [`Subscriber`]: tracing_core::Subscriber
#[cfg_attr(docsrs, doc(notable_trait))]
pub trait Layer<S>
where
S: Subscriber,
Self: 'static,
{
/// Performs late initialization when attaching a `Layer` to a
/// [`Subscriber`].
///
/// This is a callback that is called when the `Layer` is added to a
/// [`Subscriber`] (e.g. in [`Layer::with_subscriber`] and
/// [`SubscriberExt::with`]). Since this can only occur before the
/// [`Subscriber`] has been set as the default, both the `Layer` and
/// [`Subscriber`] are passed to this method _mutably_. This gives the
/// `Layer` the opportunity to set any of its own fields with values
/// recieved by method calls on the [`Subscriber`].
///
/// For example, [`Filtered`] layers implement `on_layer` to call the
/// [`Subscriber`]'s [`register_filter`] method, and store the returned
/// [`FilterId`] as a field.
///
/// **Note** In most cases, `Layer` implementations will not need to
/// implement this method. However, in cases where a type implementing
/// `Layer` wraps one or more other types that implement `Layer`, like the
/// [`Layered`] and [`Filtered`] types in this crate, that type MUST ensure
/// that the inner `Layer`s' `on_layer` methods are called. Otherwise,
/// functionality that relies on `on_layer`, such as [per-layer filtering],
/// may not work correctly.
///
/// [`Filtered`]: crate::filter::Filtered
/// [`register_filter`]: crate::registry::LookupSpan::register_filter
/// [per-layer filtering]: #per-layer-filtering
/// [`FilterId`]: crate::filter::FilterId
fn on_layer(&mut self, subscriber: &mut S) {
let _ = subscriber;
}
/// Registers a new callsite with this layer, returning whether or not
/// the layer is interested in being notified about the callsite, similarly
/// to [`Subscriber::register_callsite`].
///
/// By default, this returns [`Interest::always()`] if [`self.enabled`] returns
/// true, or [`Interest::never()`] if it returns false.
///
/// <pre class="ignore" style="white-space:normal;font:inherit;">
/// <strong>Note</strong>: This method (and <a href="#method.enabled">
/// <code>Layer::enabled</code></a>) determine whether a span or event is
/// globally enabled, <em>not</em> whether the individual layer will be
/// notified about that span or event. This is intended to be used
/// by layers that implement filtering for the entire stack. Layers which do
/// not wish to be notified about certain spans or events but do not wish to
/// globally disable them should ignore those spans or events in their
/// <a href="#method.on_event"><code>on_event</code></a>,
/// <a href="#method.on_enter"><code>on_enter</code></a>,
/// <a href="#method.on_exit"><code>on_exit</code></a>, and other notification
/// methods.
/// </pre>
///
/// See [the trait-level documentation] for more information on filtering
/// with `Layer`s.
///
/// Layers may also implement this method to perform any behaviour that
/// should be run once per callsite. If the layer wishes to use
/// `register_callsite` for per-callsite behaviour, but does not want to
/// globally enable or disable those callsites, it should always return
/// [`Interest::always()`].
///
/// [`Interest`]: tracing_core::Interest
/// [`Subscriber::register_callsite`]: tracing_core::Subscriber::register_callsite()
/// [`Interest::never()`]: tracing_core::subscriber::Interest::never()
/// [`Interest::always()`]: tracing_core::subscriber::Interest::always()
/// [`self.enabled`]: Layer::enabled()
/// [`Layer::enabled`]: Layer::enabled()
/// [`on_event`]: Layer::on_event()
/// [`on_enter`]: Layer::on_enter()
/// [`on_exit`]: Layer::on_exit()
/// [the trait-level documentation]: #filtering-with-layers
fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
if self.enabled(metadata, Context::none()) {
Interest::always()
} else {
Interest::never()
}
}
/// Returns `true` if this layer is interested in a span or event with the
/// given `metadata` in the current [`Context`], similarly to
/// [`Subscriber::enabled`].
///
/// By default, this always returns `true`, allowing the wrapped subscriber
/// to choose to disable the span.
///
/// <pre class="ignore" style="white-space:normal;font:inherit;">
/// <strong>Note</strong>: This method (and <a href="#method.register_callsite">
/// <code>Layer::register_callsite</code></a>) determine whether a span or event is
/// globally enabled, <em>not</em> whether the individual layer will be
/// notified about that span or event. This is intended to be used
/// by layers that implement filtering for the entire stack. Layers which do
/// not wish to be notified about certain spans or events but do not wish to
/// globally disable them should ignore those spans or events in their
/// <a href="#method.on_event"><code>on_event</code></a>,
/// <a href="#method.on_enter"><code>on_enter</code></a>,
/// <a href="#method.on_exit"><code>on_exit</code></a>, and other notification
/// methods.
/// </pre>
///
///
/// See [the trait-level documentation] for more information on filtering
/// with `Layer`s.
///
/// [`Interest`]: tracing_core::Interest
/// [`Subscriber::enabled`]: tracing_core::Subscriber::enabled()
/// [`Layer::register_callsite`]: Layer::register_callsite()
/// [`on_event`]: Layer::on_event()
/// [`on_enter`]: Layer::on_enter()
/// [`on_exit`]: Layer::on_exit()
/// [the trait-level documentation]: #filtering-with-layers
fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool {
let _ = (metadata, ctx);
true
}
/// Notifies this layer that a new span was constructed with the given
/// `Attributes` and `Id`.
fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, ctx: Context<'_, S>) {
let _ = (attrs, id, ctx);
}
// TODO(eliza): do we want this to be a public API? If we end up moving
// filtering layers to a separate trait, we may no longer want `Layer`s to
// be able to participate in max level hinting...
#[doc(hidden)]
fn max_level_hint(&self) -> Option<LevelFilter> {
None
}
/// Notifies this layer that a span with the given `Id` recorded the given
/// `values`.
// Note: it's unclear to me why we'd need the current span in `record` (the
// only thing the `Context` type currently provides), but passing it in anyway
// seems like a good future-proofing measure as it may grow other methods later...
fn on_record(&self, _span: &span::Id, _values: &span::Record<'_>, _ctx: Context<'_, S>) {}
/// Notifies this layer that a span with the ID `span` recorded that it
/// follows from the span with the ID `follows`.
// Note: it's unclear to me why we'd need the current span in `record` (the
// only thing the `Context` type currently provides), but passing it in anyway
// seems like a good future-proofing measure as it may grow other methods later...
fn on_follows_from(&self, _span: &span::Id, _follows: &span::Id, _ctx: Context<'_, S>) {}
/// Called before [`on_event`], to determine if `on_event` should be called.
///
/// <div class="example-wrap" style="display:inline-block">
/// <pre class="ignore" style="white-space:normal;font:inherit;">
///
/// **Note**: This method determines whether an event is globally enabled,
/// *not* whether the individual `Layer` will be notified about the
/// event. This is intended to be used by `Layer`s that implement
/// filtering for the entire stack. `Layer`s which do not wish to be
/// notified about certain events but do not wish to globally disable them
/// should ignore those events in their [on_event][Self::on_event].
///
/// </pre></div>
///
/// See [the trait-level documentation] for more information on filtering
/// with `Layer`s.
///
/// [`on_event`]: Self::on_event
/// [`Interest`]: tracing_core::Interest
/// [the trait-level documentation]: #filtering-with-layers
#[inline] // collapse this to a constant please mrs optimizer
fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool {
true
}
/// Notifies this layer that an event has occurred.
fn on_event(&self, _event: &Event<'_>, _ctx: Context<'_, S>) {}
/// Notifies this layer that a span with the given ID was entered.
fn on_enter(&self, _id: &span::Id, _ctx: Context<'_, S>) {}
/// Notifies this layer that the span with the given ID was exited.
fn on_exit(&self, _id: &span::Id, _ctx: Context<'_, S>) {}
/// Notifies this layer that the span with the given ID has been closed.
fn on_close(&self, _id: span::Id, _ctx: Context<'_, S>) {}
/// Notifies this layer that a span ID has been cloned, and that the
/// subscriber returned a different ID.
fn on_id_change(&self, _old: &span::Id, _new: &span::Id, _ctx: Context<'_, S>) {}
/// Composes this layer around the given `Layer`, returning a `Layered`
/// struct implementing `Layer`.
///
/// The returned `Layer` will call the methods on this `Layer` and then
/// those of the new `Layer`, before calling the methods on the subscriber
/// it wraps. For example:
///
/// ```rust
/// # use tracing_subscriber::layer::Layer;
/// # use tracing_core::Subscriber;
/// pub struct FooLayer {
/// // ...
/// }
///
/// pub struct BarLayer {
/// // ...
/// }
///
/// pub struct MySubscriber {
/// // ...
/// }
///
/// impl<S: Subscriber> Layer<S> for FooLayer {
/// // ...
/// }
///
/// impl<S: Subscriber> Layer<S> for BarLayer {
/// // ...
/// }
///
/// # impl FooLayer {
/// # fn new() -> Self { Self {} }
/// # }
/// # impl BarLayer {
/// # fn new() -> Self { Self { }}
/// # }
/// # impl MySubscriber {
/// # fn new() -> Self { Self { }}
/// # }
/// # use tracing_core::{span::{Id, Attributes, Record}, Metadata, Event};
/// # impl tracing_core::Subscriber for MySubscriber {
/// # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(1) }
/// # fn record(&self, _: &Id, _: &Record) {}
/// # fn event(&self, _: &Event) {}
/// # fn record_follows_from(&self, _: &Id, _: &Id) {}
/// # fn enabled(&self, _: &Metadata) -> bool { false }
/// # fn enter(&self, _: &Id) {}
/// # fn exit(&self, _: &Id) {}
/// # }
/// let subscriber = FooLayer::new()
/// .and_then(BarLayer::new())
/// .with_subscriber(MySubscriber::new());
/// ```
///
/// Multiple layers may be composed in this manner:
///
/// ```rust
/// # use tracing_subscriber::layer::Layer;
/// # use tracing_core::Subscriber;
/// # pub struct FooLayer {}
/// # pub struct BarLayer {}
/// # pub struct MySubscriber {}
/// # impl<S: Subscriber> Layer<S> for FooLayer {}
/// # impl<S: Subscriber> Layer<S> for BarLayer {}
/// # impl FooLayer {
/// # fn new() -> Self { Self {} }
/// # }
/// # impl BarLayer {
/// # fn new() -> Self { Self { }}
/// # }
/// # impl MySubscriber {
/// # fn new() -> Self { Self { }}
/// # }
/// # use tracing_core::{span::{Id, Attributes, Record}, Metadata, Event};
/// # impl tracing_core::Subscriber for MySubscriber {
/// # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(1) }
/// # fn record(&self, _: &Id, _: &Record) {}
/// # fn event(&self, _: &Event) {}
/// # fn record_follows_from(&self, _: &Id, _: &Id) {}
/// # fn enabled(&self, _: &Metadata) -> bool { false }
/// # fn enter(&self, _: &Id) {}
/// # fn exit(&self, _: &Id) {}
/// # }
/// pub struct BazLayer {
/// // ...
/// }
///
/// impl<S: Subscriber> Layer<S> for BazLayer {
/// // ...
/// }
/// # impl BazLayer { fn new() -> Self { BazLayer {} } }
///
/// let subscriber = FooLayer::new()
/// .and_then(BarLayer::new())
/// .and_then(BazLayer::new())
/// .with_subscriber(MySubscriber::new());
/// ```
fn and_then<L>(self, layer: L) -> Layered<L, Self, S>
where
L: Layer<S>,
Self: Sized,
{