ockam_api 0.93.0

Ockam's request-response API
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

use opentelemetry::global;
use opentelemetry_sdk::logs::LoggerProvider;
use opentelemetry_sdk::trace::TracerProvider;
use tracing_appender::non_blocking::WorkerGuard;

/// The Tracing guard contains a guard closing the logging appender
/// and optionally the logger/tracer providers which can be used to force the flushing
/// of spans and log records
#[derive(Debug)]
pub struct TracingGuard {
    _worker_guard: Option<WorkerGuard>,
    logger_provider: Option<LoggerProvider>,
    tracer_provider: Option<TracerProvider>,
}

impl TracingGuard {
    /// Create a new tracing guard
    pub fn new(
        worker_guard: WorkerGuard,
        logger_provider: LoggerProvider,
        tracer_provider: TracerProvider,
    ) -> TracingGuard {
        TracingGuard {
            _worker_guard: Some(worker_guard),
            logger_provider: Some(logger_provider),
            tracer_provider: Some(tracer_provider),
        }
    }

    /// Create a Tracing guard when distributed tracing is deactivated
    pub fn guard_only(worker_guard: WorkerGuard) -> TracingGuard {
        TracingGuard {
            _worker_guard: Some(worker_guard),
            logger_provider: None,
            tracer_provider: None,
        }
    }

    /// Create a Tracing guard when only distributed tracing is activated
    pub fn tracing_only(tracer_provider: TracerProvider) -> TracingGuard {
        TracingGuard {
            _worker_guard: None,
            logger_provider: None,
            tracer_provider: Some(tracer_provider),
        }
    }

    pub async fn shutdown(self) {
        _ = tokio::task::spawn_blocking(|| {
            global::shutdown_tracer_provider();
        })
        .await
    }

    /// Export the current batches of spans and log records
    /// This is used right after a background node has started to get the first logs
    /// and in tests otherwise
    pub async fn force_flush(&self) {
        let logger_provider = self.logger_provider.clone();
        let tracer_provider = self.tracer_provider.clone();
        _ = tokio::task::spawn_blocking(|| {
            if let Some(logger_provider) = logger_provider {
                logger_provider.force_flush();
            }
            if let Some(tracer_provider) = tracer_provider {
                tracer_provider.force_flush();
            }
        })
        .await;
    }
}