logfire 0.9.0

Rust SDK for Pydantic Logfire
Documentation
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
use std::{
    backtrace::Backtrace,
    borrow::Cow,
    cell::RefCell,
    collections::HashMap,
    panic::PanicHookInfo,
    sync::{Arc, Mutex, Once},
    time::Duration,
};

#[cfg(feature = "data-dir")]
use std::path::{Path, PathBuf};

use opentelemetry::{
    Context,
    logs::{LoggerProvider as _, Severity},
    trace::TracerProvider,
};
use opentelemetry_sdk::{
    logs::{SdkLoggerProvider, log_processor_with_async_runtime::BatchLogProcessor},
    metrics::{
        Aggregation, Instrument, InstrumentKind, SdkMeterProvider, Stream,
        exporter::PushMetricExporter, periodic_reader_with_async_runtime::PeriodicReader,
    },
    runtime,
    trace::{
        BatchConfigBuilder, SdkTracerProvider,
        span_processor_with_async_runtime::BatchSpanProcessor,
    },
};
use tracing::{Subscriber, level_filters::LevelFilter, subscriber::DefaultGuard};
use tracing_opentelemetry::OpenTelemetrySpanExt;
use tracing_subscriber::{EnvFilter, layer::SubscriberExt, registry::LookupSpan};

use crate::{
    __macros_impl::LogfireValue,
    ConfigureError, LogfireConfigBuilder, ShutdownError,
    bridges::tracing::LogfireTracingLayer,
    config::{
        LOGFIRE_ENVIRONMENT, LOGFIRE_SEND_TO_LOGFIRE, LOGFIRE_SERVICE_NAME,
        LOGFIRE_SERVICE_VERSION, SendToLogfire, get_base_url_from_token,
    },
    internal::{
        env::get_optional_env,
        exporters::console::{ConsoleWriter, create_console_processors},
        log_processor_shutdown_hack::LogProcessorShutdownHack,
        logfire_tracer::{GLOBAL_TRACER, LOCAL_TRACER, LogfireTracer},
    },
    metrics,
    ulid_id_generator::UlidIdGenerator,
};

/// A configured Logfire instance which contains configured `opentelemetry`, `tracing` and `log`
/// integrations.
///
/// This instance is created by calling [`logfire::configure()`][crate::configure].
#[derive(Clone)]
pub struct Logfire {
    pub(crate) tracer_provider: SdkTracerProvider,
    pub(crate) tracer: LogfireTracer,
    pub(crate) env_filter: Arc<EnvFilter>,
    pub(crate) subscriber: Arc<dyn Subscriber + Send + Sync>,
    pub(crate) meter_provider: SdkMeterProvider,
    pub(crate) logger_provider: SdkLoggerProvider,
    pub(crate) enable_tracing_metrics: bool,
    pub(crate) shutdown_sender: Arc<Mutex<Option<tokio::sync::oneshot::Sender<()>>>>,
}

impl Logfire {
    /// Create a shutdown guard that will automatically shutdown Logfire when dropped.
    ///
    /// It is recommended to use this guard in the top level of your application to ensure
    /// that Logfire is properly shut down even when exiting due to a panic.
    ///
    /// # Example
    ///
    /// ```rust
    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
    ///     let logfire = logfire::configure()
    /// #        .send_to_logfire(logfire::config::SendToLogfire::IfTokenPresent)
    ///         .finish()?;
    ///
    ///     let guard = logfire.shutdown_guard();
    ///
    ///     logfire::info!("Hello world");
    ///
    ///     guard.shutdown()?;
    ///
    ///     Ok(())
    /// }
    /// ```
    pub fn shutdown_guard(self) -> ShutdownGuard {
        ShutdownGuard {
            logfire: Some(self),
        }
    }

    /// Forcibly flush the current data captured by Logfire.
    ///
    /// Note: this will block until data is flushed. If called from an async context,
    /// consider using `tokio::task::spawn_blocking` or similar to avoid blocking the
    /// async runtime.
    ///
    /// # Errors
    ///
    /// This will error if the underlying OpenTelemetry SDK fails to flush data.
    pub fn force_flush(&self) -> Result<(), opentelemetry_sdk::error::OTelSdkError> {
        self.tracer_provider.force_flush()?;
        self.meter_provider.force_flush()?;
        self.logger_provider.force_flush()?;
        Ok(())
    }

    /// Shuts down the Logfire instance.
    ///
    /// This will flush all data to the opentelemetry exporters and then close all
    /// associated resources.
    ///
    /// # Errors
    ///
    /// See [`ConfigureError`] for possible errors.
    pub fn shutdown(&self) -> Result<(), ShutdownError> {
        // shutdown produces some logs, we don't care about these
        let _guard = Context::enter_telemetry_suppressed_scope();

        self.tracer_provider.shutdown()?;
        self.meter_provider.shutdown()?;
        self.logger_provider.shutdown()?;

        // Send shutdown signal to the background runtime thread
        if let Ok(mut sender_guard) = self.shutdown_sender.lock() {
            if let Some(sender) = sender_guard.take() {
                let _ = sender.send(());
            }
        }

        Ok(())
    }

    /// Get a tracing layer which can be used to embed this `Logfire` instance into a `tracing_subscriber::Registry`.
    ///
    /// This layer will filter data in the same way the `Logfire` SDK would; via the `RUST_LOG` environment variable
    /// or the default level filter set in the `LogfireConfigBuilder`.
    ///
    /// # Example
    ///
    /// ```rust
    /// use tracing_subscriber::{Registry, layer::SubscriberExt};
    ///
    /// let logfire = logfire::configure()
    ///    .local()  // use local mode to avoid setting global state
    ///    .finish()
    ///    .expect("Failed to configure logfire");
    ///
    /// let subscriber = tracing_subscriber::registry()
    ///    .with(logfire.tracing_layer());
    ///
    /// tracing::subscriber::set_global_default(subscriber)
    ///    .expect("Failed to set global subscriber");
    ///
    /// logfire::info!("Hello world");
    ///
    /// logfire.shutdown().expect("Failed to shutdown logfire");
    /// ```
    #[must_use]
    pub fn tracing_layer<S>(&self) -> LogfireTracingLayer<S>
    where
        S: Subscriber + for<'span> LookupSpan<'span>,
    {
        LogfireTracingLayer::new(
            self.tracer.clone(),
            self.enable_tracing_metrics,
            self.env_filter.clone(),
        )
    }

    /// Called by `LogfireConfigBuilder::finish()`.
    pub(crate) fn from_config_builder(
        config: LogfireConfigBuilder,
    ) -> Result<Logfire, ConfigureError> {
        Self::from_config_builder_and_env(config, None)
    }

    fn from_config_builder_and_env(
        config: LogfireConfigBuilder,
        env: Option<&HashMap<String, String>>,
    ) -> Result<Logfire, ConfigureError> {
        let LogfireParts {
            local,
            tracer,
            env_filter,
            subscriber,
            tracer_provider,
            meter_provider,
            logger_provider,
            enable_tracing_metrics,
            shutdown_sender,
            ..
        } = Self::build_parts(config, env)?;

        if !local {
            // avoid otel logs firing as these messages are sent regarding "global meter provider"
            // being set
            let _guard = Context::enter_telemetry_suppressed_scope();

            tracing::subscriber::set_global_default(subscriber.clone())?;
            let logger = crate::bridges::log::LogfireLogger::init(tracer.clone());
            log::set_logger(logger)?;
            log::set_max_level(logger.max_level());

            GLOBAL_TRACER
                .set(tracer.clone())
                .map_err(|_| ConfigureError::AlreadyConfigured)?;

            let propagator = opentelemetry::propagation::TextMapCompositePropagator::new(vec![
                Box::new(opentelemetry_sdk::propagation::TraceContextPropagator::new()),
                Box::new(opentelemetry_sdk::propagation::BaggagePropagator::new()),
            ]);
            opentelemetry::global::set_text_map_propagator(propagator);

            opentelemetry::global::set_meter_provider(meter_provider.clone());
        }

        Ok(Logfire {
            tracer_provider,
            tracer,
            env_filter,
            subscriber,
            meter_provider,
            logger_provider,
            enable_tracing_metrics,
            shutdown_sender,
        })
    }

    /// Load token from credentials file if available.
    #[cfg(feature = "data-dir")]
    fn load_token_from_credentials_file(
        data_dir: Option<&Path>,
        env: Option<&HashMap<String, String>>,
    ) -> Result<Option<LogfireCredentials>, ConfigureError> {
        // Determine credentials directory
        let credentials_dir = if let Some(dir) = data_dir {
            Cow::Borrowed(dir)
        } else if let Some(dir) = get_optional_env("LOGFIRE_CREDENTIALS_DIR", env)? {
            Cow::Owned(PathBuf::from(dir))
        } else {
            // Default to .logfire in current directory
            Cow::Borrowed(Path::new(".logfire"))
        };

        let credentials_path = credentials_dir.join("logfire_credentials.json");

        // Return None if file doesn't exist (not an error)
        if !credentials_path.exists() {
            return Ok(None);
        }

        // Read and parse credentials file
        let contents = std::fs::read_to_string(&credentials_path).map_err(|e| {
            ConfigureError::CredentialFileError {
                path: credentials_path.clone(),
                error: e.to_string(),
            }
        })?;

        match serde_json::from_str(&contents) {
            Ok(credentials) => Ok(Some(credentials)),
            Err(e) => Err(ConfigureError::CredentialFileError {
                path: credentials_path.clone(),
                error: format!("JSON parse error: {e}"),
            }),
        }
    }

    #[expect(clippy::too_many_lines)]
    fn build_parts(
        config: LogfireConfigBuilder,
        env: Option<&HashMap<String, String>>,
    ) -> Result<LogfireParts, ConfigureError> {
        let mut token = config.token;
        if token.is_none() {
            token = get_optional_env("LOGFIRE_TOKEN", env)?;
        }

        #[cfg_attr(
            not(feature = "data-dir"),
            expect(unused_mut, reason = "only mutated on data-dir feature")
        )]
        let mut advanced_options = config.advanced.unwrap_or_default();

        // Try loading from credentials file if still no token
        #[cfg(feature = "data-dir")]
        if token.is_none() {
            if let Some(credentials) =
                Self::load_token_from_credentials_file(config.data_dir.as_deref(), env)?
            {
                token = Some(credentials.token);
                advanced_options.base_url = advanced_options
                    .base_url
                    .or(Some(credentials.logfire_api_url));
            }
        }

        let send_to_logfire = LOGFIRE_SEND_TO_LOGFIRE.resolve(config.send_to_logfire, env)?;

        let send_to_logfire = match send_to_logfire {
            SendToLogfire::Yes => true,
            SendToLogfire::IfTokenPresent => token.is_some(),
            SendToLogfire::No => false,
        };

        let mut tracer_provider_builder = SdkTracerProvider::builder();
        let mut logger_provider_builder = SdkLoggerProvider::builder();
        let mut meter_provider_builder = SdkMeterProvider::builder();

        if let Some(id_generator) = advanced_options.id_generator {
            tracer_provider_builder = tracer_provider_builder.with_id_generator(id_generator);
        } else {
            tracer_provider_builder =
                tracer_provider_builder.with_id_generator(UlidIdGenerator::new());
        }

        // Add service-specific resources from config
        let mut service_resource_builder = opentelemetry_sdk::Resource::builder();

        if let Some(service_name) = LOGFIRE_SERVICE_NAME.resolve(config.service_name, env)? {
            service_resource_builder = service_resource_builder.with_service_name(service_name);
        }

        if let Some(service_version) =
            LOGFIRE_SERVICE_VERSION.resolve(config.service_version, env)?
        {
            service_resource_builder = service_resource_builder.with_attribute(
                opentelemetry::KeyValue::new("service.version", service_version),
            );
        }

        if let Some(environment) = LOGFIRE_ENVIRONMENT.resolve(config.environment, env)? {
            service_resource_builder = service_resource_builder.with_attribute(
                opentelemetry::KeyValue::new("deployment.environment.name", environment),
            );
        }

        // Use "default" resource first so that user-provided resources can override it
        let service_resource = service_resource_builder.build();
        for resource in [service_resource]
            .into_iter()
            .chain(advanced_options.resources)
        {
            tracer_provider_builder = tracer_provider_builder.with_resource(resource.clone());
            logger_provider_builder = logger_provider_builder.with_resource(resource.clone());
            meter_provider_builder = meter_provider_builder.with_resource(resource);
        }

        let mut http_headers: Option<HashMap<String, String>> = None;

        let logfire_base_url = if send_to_logfire {
            let Some(token) = &token else {
                return Err(ConfigureError::TokenRequired);
            };

            http_headers
                .get_or_insert_default()
                .insert("Authorization".to_string(), format!("Bearer {token}"));

            Some(
                advanced_options
                    .base_url
                    .as_deref()
                    .unwrap_or_else(|| get_base_url_from_token(token)),
            )
        } else {
            None
        };

        let shutdown_sender = if let Some(logfire_base_url) = logfire_base_url {
            let (shutdown_tx, span_processor, log_processor, metrics_processor) =
                spawn_runtime_and_exporters(
                    logfire_base_url,
                    http_headers,
                    config.metrics.is_some(),
                )?;

            tracer_provider_builder = tracer_provider_builder.with_span_processor(span_processor);
            logger_provider_builder = logger_provider_builder.with_log_processor(log_processor);
            if let Some(metrics_processor) = metrics_processor {
                meter_provider_builder = meter_provider_builder.with_reader(metrics_processor);
            }

            Arc::new(Mutex::new(Some(shutdown_tx)))
        } else {
            Arc::new(Mutex::new(None))
        };

        let console_processors = config
            .console_options
            .map(|o| create_console_processors(Arc::new(ConsoleWriter::new(o))));

        if let Some((span_processor, log_processor)) = console_processors {
            tracer_provider_builder = tracer_provider_builder.with_span_processor(span_processor);
            logger_provider_builder = logger_provider_builder.with_log_processor(log_processor);
        }

        for span_processor in config.additional_span_processors {
            tracer_provider_builder = tracer_provider_builder.with_span_processor(span_processor);
        }

        let tracer_provider = tracer_provider_builder.build();
        let tracer = tracer_provider.tracer("logfire");

        if let Some(metrics) = config.metrics {
            for reader in metrics.additional_readers {
                meter_provider_builder = meter_provider_builder.with_reader(reader);
            }
        }

        let view = |i: &Instrument| {
            if i.kind() != InstrumentKind::Histogram {
                return None;
            }

            let scale = {
                let histograms = metrics::EXPONENTIAL_HISTOGRAMS.read().ok()?;
                *histograms.get(i.name())?
            };

            Stream::builder()
                .with_aggregation(Aggregation::Base2ExponentialHistogram {
                    max_size: 160,
                    max_scale: scale, // Upper bound on resolution
                    record_min_max: true,
                })
                .build()
                .ok()
        };
        meter_provider_builder = meter_provider_builder.with_view(view);
        let meter_provider = meter_provider_builder.build();

        for log_processor in advanced_options.log_record_processors {
            logger_provider_builder = logger_provider_builder.with_log_processor(log_processor);
        }

        let logger_provider = logger_provider_builder.build();
        let logger = Arc::new(logger_provider.logger("logfire"));

        let default_level_filter = config.default_level_filter.unwrap_or(if send_to_logfire {
            // by default, send everything to the logfire platform, for best UX
            LevelFilter::TRACE
        } else {
            // but if printing locally, just set INFO
            LevelFilter::INFO
        });

        let mut filter_builder = env_filter::Builder::new();
        if let Ok(filter) = std::env::var("RUST_LOG") {
            filter_builder.parse(&filter);
        } else {
            filter_builder.parse(&default_level_filter.to_string());
        }

        let tracer = LogfireTracer {
            inner: tracer,
            meter_provider: meter_provider.clone(),
            logger,
            handle_panics: config.install_panic_handler,
            filter: Arc::new(filter_builder.build()),
        };

        let filter = Arc::new(
            tracing_subscriber::EnvFilter::builder()
                .with_default_directive(default_level_filter.into())
                // but allow the user to override this with `RUST_LOG`
                .from_env()?,
        );

        let subscriber = tracing_subscriber::registry().with(LogfireTracingLayer::new(
            tracer.clone(),
            advanced_options.enable_tracing_metrics,
            filter.clone(),
        ));

        if config.install_panic_handler {
            install_panic_handler();
        }

        Ok(LogfireParts {
            local: config.local,
            tracer,
            env_filter: filter,
            subscriber: Arc::new(subscriber),
            tracer_provider,
            meter_provider,
            logger_provider,
            enable_tracing_metrics: advanced_options.enable_tracing_metrics,
            shutdown_sender,
            #[cfg(test)]
            metadata: TestMetadata {
                send_to_logfire,
                logfire_token: token,
                logfire_base_url: logfire_base_url.map(str::to_string),
            },
        })
    }
}

/// A guard that automatically shuts down Logfire when dropped.
///
/// Create this guard by calling [`Logfire::shutdown_guard()`] to ensure clean shutdown
/// when the guard goes out of scope.
#[must_use = "this should be kept alive until logging should be stopped"]
pub struct ShutdownGuard {
    logfire: Option<Logfire>,
}

impl ShutdownGuard {
    /// Shutdown the Logfire instance.
    ///
    /// This will flush all spans and metrics to the exporter.
    ///
    /// # Errors
    ///
    /// See [`ShutdownError`] for possible errors.
    pub fn shutdown(mut self) -> Result<(), ShutdownError> {
        self.shutdown_inner()
    }

    fn shutdown_inner(&mut self) -> Result<(), ShutdownError> {
        if let Some(logfire) = self.logfire.take() {
            logfire.shutdown()?;
        }
        Ok(())
    }
}

#[allow(clippy::print_stderr)]
impl Drop for ShutdownGuard {
    fn drop(&mut self) {
        if let Err(error) = self.shutdown_inner() {
            eprintln!("failed to shutdown logfire cleanly: {error:#?}");
        }
    }
}

struct LogfireParts {
    local: bool,
    tracer: LogfireTracer,
    env_filter: Arc<EnvFilter>,
    subscriber: Arc<dyn Subscriber + Send + Sync>,
    tracer_provider: SdkTracerProvider,
    meter_provider: SdkMeterProvider,
    logger_provider: SdkLoggerProvider,
    enable_tracing_metrics: bool,
    shutdown_sender: Arc<Mutex<Option<tokio::sync::oneshot::Sender<()>>>>,
    #[cfg(test)]
    metadata: TestMetadata,
}

#[cfg(test)]
struct TestMetadata {
    send_to_logfire: bool,
    logfire_token: Option<String>,
    logfire_base_url: Option<String>,
}

/// Install `handler` as part of a chain of panic handlers.
fn install_panic_handler() {
    fn panic_hook(info: &PanicHookInfo) {
        LogfireTracer::try_with(|tracer| {
            if !tracer.handle_panics {
                // this tracer is not handling panics
                return;
            }

            let message = if let Some(s) = info.payload().downcast_ref::<&str>() {
                s
            } else if let Some(s) = info.payload().downcast_ref::<String>() {
                s
            } else {
                ""
            };

            let location = info.location();
            tracer.export_log(
                None,
                &tracing::Span::current().context(),
                format!("panic: {message}"),
                Severity::Error,
                crate::__json_schema!(backtrace),
                location.map(|l| Cow::Owned(l.file().to_string())),
                location.map(std::panic::Location::line),
                None,
                [LogfireValue::new(
                    "backtrace",
                    Some(Backtrace::capture().to_string().into()),
                )],
            );
        });
    }

    static INSTALLED: Once = Once::new();
    INSTALLED.call_once(|| {
        let prev = std::panic::take_hook();
        std::panic::set_hook(Box::new(move |info| {
            panic_hook(info);
            prev(info);
        }));
    });
}

/// Helper for installing a logfire guard locally to a thread.
///
/// FIXME: This is still a bit of a mess, it's only implemented far enough to make tests pass...
#[doc(hidden)]
pub struct LocalLogfireGuard {
    prior: Option<LogfireTracer>,
    #[expect(dead_code, reason = "tracing RAII guard")]
    tracing_guard: DefaultGuard,
    logfire: Logfire,
}

impl LocalLogfireGuard {
    /// Get the current meter provider
    #[must_use]
    pub fn meter_provider(&self) -> &SdkMeterProvider {
        &self.logfire.meter_provider
    }

    /// Convenience function to release this guard and shutdown Logfire.
    pub fn shutdown(self) -> Result<(), ShutdownError> {
        let logfire = self.logfire.clone();
        drop(self); // ensure the guard is dropped before shutdown
        logfire.shutdown()
    }
}

impl Drop for LocalLogfireGuard {
    fn drop(&mut self) {
        // FIXME: if drop order is not consistent with creation order, does this create strange
        // state?
        LOCAL_TRACER.with_borrow_mut(|local_logfire| {
            *local_logfire = self.prior.take();
        });
    }
}

#[doc(hidden)] // used in tests
#[must_use]
pub fn set_local_logfire(logfire: Logfire) -> LocalLogfireGuard {
    let prior =
        LOCAL_TRACER.with_borrow_mut(|local_logfire| local_logfire.replace(logfire.tracer.clone()));

    let tracing_guard = tracing::subscriber::set_default(logfire.subscriber.clone());

    // TODO: metrics??

    LocalLogfireGuard {
        prior,
        tracing_guard,
        logfire,
    }
}

/// Credentials stored in `logfire_credentials.json` files
#[cfg(feature = "data-dir")]
#[derive(serde::Deserialize)]
struct LogfireCredentials {
    token: String,
    #[expect(dead_code, reason = "not used for now")]
    project_name: String,
    #[expect(dead_code, reason = "not used for now")]
    project_url: String,
    logfire_api_url: String,
}

/// Spawns a tokio runtime in a background thread and creates exporters which will use
/// that runtime.
///
/// As per <https://github.com/open-telemetry/opentelemetry-rust/pull/3084>, using a
/// runtime with suppression is the recommended way to avoid the export process
/// generating telemetry logs (and creating both noise and an infinite cycle).
///
/// It also has the benefit for the `grpc` export that the tonic channel can be created
/// successfully in all cases; it _needs_ a tokio runtime and this way we don't need
/// the user to call `logfire::configure` inside an async context.
#[allow(clippy::type_complexity)] // internal type, not exposed to users
fn spawn_runtime_and_exporters(
    logfire_base_url: &str,
    http_headers: Option<HashMap<String, String>>,
    enable_metrics: bool,
) -> Result<
    (
        tokio::sync::oneshot::Sender<()>,
        BatchSpanProcessor<runtime::Tokio>,
        LogProcessorShutdownHack<BatchLogProcessor<runtime::Tokio>>,
        Option<PeriodicReader<impl PushMetricExporter + use<>>>,
    ),
    ConfigureError,
> {
    thread_local! {
        static SUPPRESS_GUARD: RefCell<Option<opentelemetry::ContextGuard>> = const { RefCell::new(None) };
    }

    let rt = tokio::runtime::Builder::new_current_thread()
        .enable_all()
        .worker_threads(1)
        .on_thread_start(|| {
            let suppress_guard = Context::enter_telemetry_suppressed_scope();
            SUPPRESS_GUARD.with(|guard| {
                *guard.borrow_mut() = Some(suppress_guard);
            });
        })
        .on_thread_stop(|| {
            SUPPRESS_GUARD.with(|guard| {
                if let Some(suppress_guard) = guard.borrow_mut().take() {
                    drop(suppress_guard);
                }
            });
        })
        .thread_name("logfire-export-runtime")
        .build()
        .map_err(|e| ConfigureError::Other(e.into()))?;

    let handle = rt.handle().clone();

    // Create oneshot channel for shutdown signaling
    let (shutdown_tx, shutdown_rx) = tokio::sync::oneshot::channel::<()>();

    // Spawn the runtime into a background thread
    std::thread::Builder::new()
        .name("logfire-export-runtime".into())
        .spawn(move || {
            let _guard = Context::enter_telemetry_suppressed_scope();
            let _ = rt.block_on(shutdown_rx);
        })
        .map_err(|e| {
            ConfigureError::Other(format!("failed to create logfire exporter: {e:?}").into())
        })?;

    let (span_processor, log_processor, metrics_processor) = std::thread::scope(|s| {
        s.spawn(|| -> Result<_, ConfigureError> {
            // all these processors spawn tasks on the runtime when they are created.
            let _guard = handle.enter();

            let span_processor = BatchSpanProcessor::builder(
                crate::exporters::span_exporter(logfire_base_url, http_headers.clone())?,
                runtime::Tokio,
            )
            .with_batch_config(
                BatchConfigBuilder::default()
                    .with_scheduled_delay(Duration::from_millis(500)) // 500 matches Python
                    .build(),
            )
            .build();

            let log_processor = LogProcessorShutdownHack::new(
                BatchLogProcessor::builder(
                    crate::exporters::log_exporter(logfire_base_url, http_headers.clone())?,
                    runtime::Tokio,
                )
                .build(),
            );

            let metrics_processor = if enable_metrics {
                Some(
                    PeriodicReader::builder(
                        crate::exporters::metric_exporter(logfire_base_url, http_headers)?,
                        runtime::Tokio,
                    )
                    .build(),
                )
            } else {
                None
            };

            Ok((span_processor, log_processor, metrics_processor))
        })
        .join()
        .map_err(|_| ConfigureError::Other("failed to create logfire processors".into()))?
    })?;

    Ok((
        shutdown_tx,
        span_processor,
        log_processor,
        metrics_processor,
    ))
}

#[cfg(test)]
mod tests {
    use std::{
        sync::{
            Arc,
            atomic::{AtomicBool, Ordering},
        },
        time::Duration,
    };

    use opentelemetry_sdk::{
        metrics::{
            InMemoryMetricExporter, PeriodicReader,
            data::{Metric, MetricData},
            reader::MetricReader,
        },
        trace::{SpanData, SpanProcessor},
    };

    use crate::{
        ConfigureError, Logfire,
        config::{BoxedMetricReader, MetricsOptions, SendToLogfire},
        configure, f64_exponential_histogram, f64_histogram, u64_exponential_histogram,
        u64_histogram,
    };

    #[test]
    fn test_send_to_logfire() {
        for (env, setting, expected) in [
            (vec![], None, Err(ConfigureError::TokenRequired)),
            (vec![("LOGFIRE_TOKEN", "a")], None, Ok(true)),
            (vec![("LOGFIRE_SEND_TO_LOGFIRE", "no")], None, Ok(false)),
            (
                vec![("LOGFIRE_SEND_TO_LOGFIRE", "yes")],
                None,
                Err(ConfigureError::TokenRequired),
            ),
            (
                vec![("LOGFIRE_SEND_TO_LOGFIRE", "yes"), ("LOGFIRE_TOKEN", "a")],
                None,
                Ok(true),
            ),
            (
                vec![("LOGFIRE_SEND_TO_LOGFIRE", "if-token-present")],
                None,
                Ok(false),
            ),
            (
                vec![
                    ("LOGFIRE_SEND_TO_LOGFIRE", "if-token-present"),
                    ("LOGFIRE_TOKEN", "a"),
                ],
                None,
                Ok(true),
            ),
            (
                vec![("LOGFIRE_SEND_TO_LOGFIRE", "no"), ("LOGFIRE_TOKEN", "a")],
                Some(SendToLogfire::Yes),
                Ok(true),
            ),
            (
                vec![("LOGFIRE_SEND_TO_LOGFIRE", "no"), ("LOGFIRE_TOKEN", "a")],
                Some(SendToLogfire::IfTokenPresent),
                Ok(true),
            ),
            (
                vec![("LOGFIRE_SEND_TO_LOGFIRE", "no")],
                Some(SendToLogfire::IfTokenPresent),
                Ok(false),
            ),
        ] {
            let env: std::collections::HashMap<String, String> =
                env.into_iter().map(|(k, v)| (k.into(), v.into())).collect();

            let mut config = crate::configure();
            if let Some(value) = setting {
                config = config.send_to_logfire(value);
            }

            let md = Logfire::build_parts(config, Some(&env)).map(|parts| parts.metadata);

            if let Ok(md) = &md {
                assert!(!md.send_to_logfire || md.logfire_token.is_some());
                assert!(
                    !md.send_to_logfire
                        || md.logfire_base_url.as_deref()
                            == Some("https://logfire-us.pydantic.dev")
                );
            }

            let result = md.as_ref().map(|md| md.send_to_logfire);

            match (expected, result) {
                (Ok(exp), Ok(actual)) => assert_eq!(exp, actual),
                // compare strings because ConfigureError doesn't implement PartialEq
                (Err(exp), Err(actual)) => assert_eq!(exp.to_string(), actual.to_string()),
                (expected, result) => panic!("expected {expected:?}, got {result:?}"),
            }
        }
    }

    #[derive(Debug)]
    struct TestShutdownProcessor {
        shutdown_called: Arc<AtomicBool>,
    }

    impl SpanProcessor for TestShutdownProcessor {
        fn on_start(&self, _: &mut opentelemetry_sdk::trace::Span, _: &opentelemetry::Context) {}

        fn on_end(&self, _: SpanData) {}

        fn force_flush(&self) -> opentelemetry_sdk::error::OTelSdkResult {
            Ok(())
        }

        fn shutdown_with_timeout(&self, _: Duration) -> opentelemetry_sdk::error::OTelSdkResult {
            self.shutdown_called.store(true, Ordering::Relaxed);
            Ok(())
        }
    }

    #[test]
    fn test_shutdown_guard_drop() {
        let shutdown_called = Arc::new(AtomicBool::new(false));

        {
            let logfire = configure()
                .local()
                .send_to_logfire(false)
                .with_additional_span_processor(TestShutdownProcessor {
                    shutdown_called: shutdown_called.clone(),
                })
                .finish()
                .expect("failed to configure logfire");

            let _guard = logfire.shutdown_guard();

            // Guard is alive here, shutdown should not have been called
            assert!(!shutdown_called.load(Ordering::Relaxed));
        }

        // Guard is dropped here, shutdown should be called
        assert!(shutdown_called.load(Ordering::Relaxed));
    }

    #[test]
    fn test_drop_multiple_shutdown_guard() {
        let shutdown_called = Arc::new(AtomicBool::new(false));

        let logfire = configure()
            .local()
            .send_to_logfire(false)
            .with_additional_span_processor(TestShutdownProcessor {
                shutdown_called: shutdown_called.clone(),
            })
            .finish()
            .expect("failed to configure logfire");

        // Having multiple shutdown guards should not cause issues when they are dropped
        {
            let _guard1 = logfire.clone().shutdown_guard();
            let _guard2 = logfire.shutdown_guard();

            // Guards are alive here, shutdown should not have been called
            assert!(!shutdown_called.load(Ordering::Relaxed));
        }

        // Guards have been dropped, shutdown should be called
        assert!(shutdown_called.load(Ordering::Relaxed));
    }

    #[test]
    fn test_manual_shutdown() {
        let shutdown_called = Arc::new(AtomicBool::new(false));

        let logfire = configure()
            .local()
            .send_to_logfire(false)
            .with_additional_span_processor(TestShutdownProcessor {
                shutdown_called: shutdown_called.clone(),
            })
            .finish()
            .expect("failed to configure logfire");

        // Not shutdown yet
        assert!(!shutdown_called.load(Ordering::Relaxed));

        // Manual shutdown should work
        logfire.shutdown().expect("shutdown should succeed");

        // Shutdown should have been called
        assert!(shutdown_called.load(Ordering::Relaxed));
    }

    #[test]
    #[allow(clippy::unwrap_used)]
    #[should_panic(expected = "OtelError(AlreadyShutdown)")]
    fn test_multiple_shutdown_calls() {
        let logfire = configure()
            .local()
            .send_to_logfire(false)
            .finish()
            .expect("failed to configure logfire");

        // First `shutdown` call should succeed
        logfire.shutdown().expect("first shutdown should succeed");

        // Second `shutdown` call should fail
        logfire.shutdown().unwrap();
    }

    #[test]
    #[cfg(feature = "data-dir")]
    fn test_credentials_file_loading() {
        const CREDENTIALS_JSON: &str = r#"{
    "token": "test_token_123",
    "project_name": "test-project",
    "project_url": "https://logfire-eu.pydantic.dev/test-org/test-project",
    "logfire_api_url": "https://test-api-url.com"
}"#;

        let temp_dir = tempfile::tempdir().expect("failed to create temp dir");

        // Write credentials file
        let credentials_path = temp_dir.path().join("logfire_credentials.json");
        std::fs::write(&credentials_path, CREDENTIALS_JSON).unwrap();

        // Test that credentials are loaded when using with_data_dir
        let config = crate::configure()
            .local()
            .send_to_logfire(SendToLogfire::IfTokenPresent)
            .with_data_dir(temp_dir.path());

        let md = Logfire::build_parts(config, None).unwrap().metadata;

        assert_eq!(md.send_to_logfire, true);
        assert_eq!(md.logfire_token.as_deref(), Some("test_token_123"));
        assert_eq!(
            md.logfire_base_url.as_deref(),
            Some("https://test-api-url.com")
        );
    }

    #[test]
    #[cfg(feature = "data-dir")]
    fn test_credentials_file_loading_env_var() {
        const CREDENTIALS_JSON: &str = r#"{
    "token": "test_token_123",
    "project_name": "test-project",
    "project_url": "https://logfire-eu.pydantic.dev/test-org/test-project",
    "logfire_api_url": "https://test-api-url.com"
}"#;

        let temp_dir = tempfile::tempdir().expect("failed to create temp dir");

        // Write credentials file
        let credentials_path = temp_dir.path().join("logfire_credentials.json");
        std::fs::write(&credentials_path, CREDENTIALS_JSON).unwrap();

        // Test that credentials are loaded when using with_data_dir
        let config = crate::configure().local();

        let env: std::collections::HashMap<String, String> = [(
            "LOGFIRE_CREDENTIALS_DIR".to_string(),
            temp_dir.path().display().to_string(),
        )]
        .into_iter()
        .collect();

        let md = Logfire::build_parts(config, Some(&env)).unwrap().metadata;

        assert_eq!(md.send_to_logfire, true);
        assert_eq!(md.logfire_token.as_deref(), Some("test_token_123"));
        assert_eq!(
            md.logfire_base_url.as_deref(),
            Some("https://test-api-url.com")
        );
    }

    #[test]
    #[cfg(feature = "data-dir")]
    fn test_credentials_file_error_handling() {
        // Create a temporary directory using tempfile
        let temp_dir = tempfile::tempdir().expect("failed to create temp dir");
        let credentials_path = temp_dir.path().join("logfire_credentials.json");

        // Test with invalid JSON
        std::fs::write(&credentials_path, "invalid json").unwrap();

        let result = crate::configure()
            .local()
            .send_to_logfire(true) // This should require a token
            .with_data_dir(temp_dir.path())
            .finish();

        // Should get a credential file error due to invalid JSON
        assert!(result.is_err());
        if let Err(e) = result {
            assert!(matches!(
                e,
                crate::ConfigureError::CredentialFileError { .. }
            ));
        }
        // temp_dir is cleaned up automatically
    }

    #[test]
    #[cfg(feature = "data-dir")]
    fn test_no_credentials_file_fallback() {
        // Create a temporary directory without any credentials file using tempfile
        let temp_dir = tempfile::tempdir().expect("failed to create temp dir");

        let result = crate::configure()
            .local()
            .send_to_logfire(true) // This should require a token
            .with_data_dir(temp_dir.path())
            .finish();

        // Should get TokenRequired error since no credentials file exists
        assert!(result.is_err());
        if let Err(e) = result {
            assert!(matches!(e, crate::ConfigureError::TokenRequired));
        }
        // temp_dir is cleaned up automatically
    }

    #[test]
    fn test_panic_handler_disabled() {
        // other tests check enabled (default)

        use crate::config::AdvancedOptions;
        use opentelemetry_sdk::logs::{InMemoryLogExporter, SimpleLogProcessor};

        let log_exporter = InMemoryLogExporter::default();

        let logfire = configure()
            .local()
            .send_to_logfire(false)
            .with_install_panic_handler(false)
            .with_advanced_options(
                AdvancedOptions::default()
                    .with_log_processor(SimpleLogProcessor::new(log_exporter.clone())),
            )
            .finish()
            .expect("failed to configure logfire");

        let guard = crate::set_local_logfire(logfire);

        let _result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
            panic!("test panic");
        }));

        guard.shutdown().expect("shutdown should succeed");

        let logs = log_exporter.get_emitted_logs().unwrap();
        assert!(logs.is_empty());
    }

    #[test]
    #[allow(clippy::unwrap_used)]
    fn test_exponential_histogram_view() {
        let exporter = InMemoryMetricExporter::default();
        let reader = PeriodicReader::builder(exporter.clone()).build();
        let logfire = configure()
            .send_to_logfire(false)
            .with_metrics(Some(MetricsOptions {
                additional_readers: vec![BoxedMetricReader::new(Box::new(reader.clone()))],
            }))
            .finish()
            .expect("failed to configure logfire");

        let _guard = logfire.shutdown_guard();

        let f64_hist = f64_histogram("f64_hist").build();
        f64_hist.record(1.0, &[]);
        let u64_hist = u64_histogram("u64_hist").build();
        u64_hist.record(20, &[]);

        let f64_exp = f64_exponential_histogram("f64_exp", 2).build();
        f64_exp.record(1.0, &[]);
        f64_exp.record(1.5, &[]);
        f64_exp.record(2.0, &[]);
        f64_exp.record(3.0, &[]);
        f64_exp.record(10.0, &[]);

        let u64_exp = u64_exponential_histogram("u64_exp", 2).build();
        u64_exp.record(10, &[]);

        reader.force_flush().unwrap();

        let metrics = exporter.get_finished_metrics().unwrap();

        for scope_metics in metrics[0].scope_metrics() {
            for (name, expected) in [
                ("f64_hist", false),
                ("u64_hist", false),
                ("f64_exp", true),
                ("u64_exp", true),
            ] {
                let metric = scope_metics.metrics().find(|m| m.name() == name).unwrap();
                assert_eq!(expected, is_exponential_histogram(metric));
            }
        }
    }

    fn is_exponential_histogram(metric: &Metric) -> bool {
        match metric.data() {
            opentelemetry_sdk::metrics::data::AggregatedMetrics::F64(metric_data) => {
                is_exponential_histogram_metric_data(metric_data)
            }
            opentelemetry_sdk::metrics::data::AggregatedMetrics::U64(metric_data) => {
                is_exponential_histogram_metric_data(metric_data)
            }
            opentelemetry_sdk::metrics::data::AggregatedMetrics::I64(metric_data) => {
                is_exponential_histogram_metric_data(metric_data)
            }
        }
    }

    fn is_exponential_histogram_metric_data<T>(data: &MetricData<T>) -> bool {
        matches!(
            data,
            opentelemetry_sdk::metrics::data::MetricData::ExponentialHistogram(_)
        )
    }
}