origin-telemetry 0.1.0

Tracing setup and logging conventions for Origin.
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

//! Correlation spans.
//!
//! Every long-running platform operation opens one of these, so a log line can be
//! traced back to the sync run, job or account that produced it.

use origin_domain::{AccountId, ConnectorId, JobId, SyncId};
use tracing::Span;

/// Span covering one synchronisation run.
pub fn sync(sync: &SyncId, connector: &ConnectorId, account: &AccountId) -> Span {
    tracing::info_span!(
        "sync",
        sync_id = sync.as_str(),
        connector = connector.as_str(),
        account_id = account.as_str(),
    )
}

/// Span covering one background job.
pub fn job(job: &JobId, kind: &str) -> Span {
    tracing::info_span!("job", job_id = job.as_str(), kind = kind)
}

/// Span covering one outbound request, for rate-limit and latency analysis.
pub fn request(connector: &ConnectorId, operation: &str) -> Span {
    tracing::debug_span!(
        "request",
        connector = connector.as_str(),
        operation = operation
    )
}