rs-zero 0.2.6

Rust-first microservice framework inspired by go-zero engineering practices
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

use std::{future::Future, time::Instant};

use tonic::{Code, Status};
use tracing::Instrument;

use crate::observability::{CorrelationContext, MetricsRegistry, RpcMetricLabels};

/// Observes one gRPC unary call without depending on generated service types.
pub async fn observe_rpc_unary<T, Fut>(
    metrics: Option<&MetricsRegistry>,
    service: &str,
    method: &str,
    request_id: Option<&str>,
    future: Fut,
) -> Result<T, Status>
where
    Fut: Future<Output = Result<T, Status>>,
{
    observe_rpc_unary_with_context(metrics, service, method, request_id, None, future).await
}

/// Observes one gRPC unary call with explicit request and trace context.
pub async fn observe_rpc_unary_with_context<T, Fut>(
    metrics: Option<&MetricsRegistry>,
    service: &str,
    method: &str,
    request_id: Option<&str>,
    traceparent: Option<&str>,
    future: Fut,
) -> Result<T, Status>
where
    Fut: Future<Output = Result<T, Status>>,
{
    let started = Instant::now();
    let correlation = CorrelationContext::from_rpc_parts(service, method, request_id, traceparent);
    let span = tracing::info_span!(
        "rs_zero.rpc.unary",
        rpc.service = service,
        rpc.method = method,
        service = service,
        transport = "grpc",
        route = method,
        method = method,
        request_id = correlation.request_id().unwrap_or(""),
        traceparent = correlation.traceparent().unwrap_or(""),
        code = tracing::field::Empty,
        trace_id = tracing::field::Empty,
        span_id = tracing::field::Empty
    );
    #[cfg(feature = "otlp")]
    if let Some(context) =
        traceparent.and_then(crate::observability::opentelemetry_context_from_traceparent)
    {
        use tracing_opentelemetry::OpenTelemetrySpanExt;
        let _ = span.set_parent(context);
    }
    let result = future.instrument(span.clone()).await;
    let code = result.as_ref().err().map(Status::code).unwrap_or(Code::Ok);
    let code_label = format!("{code:?}");
    span.record("code", tracing::field::display(&code_label));
    let correlation = correlation.with_status(code_label.clone());
    if let Some(trace_id) = correlation.trace_id() {
        span.record("trace_id", tracing::field::display(trace_id));
    }
    if let Some(span_id) = correlation.span_id() {
        span.record("span_id", tracing::field::display(span_id));
    }
    let duration = started.elapsed();
    tracing::info!(
        rpc.service = service,
        rpc.method = method,
        service = service,
        transport = "grpc",
        route = method,
        method = method,
        request_id = correlation.request_id().unwrap_or(""),
        traceparent = correlation.traceparent().unwrap_or(""),
        trace_id = correlation.trace_id().unwrap_or(""),
        span_id = correlation.span_id().unwrap_or(""),
        code = %code_label,
        duration_ms = duration.as_secs_f64() * 1000.0,
        "rpc unary observed"
    );
    if let Some(metrics) = metrics {
        metrics.record_rpc_request(RpcMetricLabels::new(service, method, code_label), duration);
    }
    result
}

/// Observes one gRPC unary call and derives correlation fields from tonic metadata.
#[cfg(feature = "rpc")]
pub async fn observe_rpc_unary_with_metadata<T, Fut>(
    metrics: Option<&MetricsRegistry>,
    service: &str,
    method: &str,
    metadata: &tonic::metadata::MetadataMap,
    future: Fut,
) -> Result<T, Status>
where
    Fut: Future<Output = Result<T, Status>>,
{
    let request_id = crate::observability::request_id_from_metadata(metadata);
    let traceparent = crate::observability::traceparent_from_metadata(metadata);
    observe_rpc_unary_with_context(
        metrics,
        service,
        method,
        request_id.as_deref(),
        traceparent.as_deref(),
        future,
    )
    .await
}

/// Records metrics and a log event for one completed gRPC stream snapshot.
#[cfg(feature = "rpc")]
pub fn record_rpc_streaming_snapshot(
    metrics: Option<&MetricsRegistry>,
    service: &str,
    method: &str,
    snapshot: &crate::rpc::streaming::RpcStreamingSnapshot,
) {
    let code = snapshot.code.unwrap_or(Code::Ok);
    let code_label = format!("{code:?}");
    tracing::info!(
        rpc.service = service,
        rpc.method = method,
        code = %code_label,
        sent_messages = snapshot.sent_messages,
        received_messages = snapshot.received_messages,
        "rpc stream observed"
    );
    if let Some(metrics) = metrics {
        metrics.record_rpc_request(
            RpcMetricLabels::new(service, method, code_label),
            snapshot.duration,
        );
    }
}