hive-router 0.2.0

GraphQL router for Federation, part of the Hive platform
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

use std::time::Instant;

use opentelemetry::{
    metrics::{Counter, Histogram, Meter},
    KeyValue,
};

use crate::telemetry::metrics::capture::Capture;
#[cfg(debug_assertions)]
use crate::telemetry::metrics::catalog::debug_assert_attrs;
use crate::telemetry::metrics::catalog::{labels, names, values};

struct SupergraphInstruments {
    poll_total: Option<Counter<u64>>,
    poll_duration: Option<Histogram<f64>>,
    process_duration: Option<Histogram<f64>>,
}

impl SupergraphInstruments {
    fn is_poll_enabled(&self) -> bool {
        self.poll_total.is_some() || self.poll_duration.is_some()
    }

    fn is_process_enabled(&self) -> bool {
        self.process_duration.is_some()
    }
}

pub struct SupergraphPollState<'a> {
    instruments: &'a SupergraphInstruments,
    started_at: Instant,
}

pub struct SupergraphProcessState<'a> {
    instruments: &'a SupergraphInstruments,
    started_at: Instant,
}

pub struct SupergraphMetrics {
    instruments: SupergraphInstruments,
}

impl SupergraphMetrics {
    pub fn new(meter: Option<&Meter>) -> Self {
        let poll_total = meter.map(|meter| {
            meter
                .u64_counter(names::SUPERGRAPH_POLL_TOTAL)
                .with_description("Total number of supergraph poll attempts")
                .build()
        });
        let poll_duration = meter.map(|meter| {
            meter
                .f64_histogram(names::SUPERGRAPH_POLL_DURATION)
                .with_unit("s")
                .with_description("Duration of supergraph poll processing")
                .build()
        });

        let process_duration = meter.map(|meter| {
            meter
                .f64_histogram(names::SUPERGRAPH_PROCESS_DURATION)
                .with_unit("s")
                .with_description("Duration of supergraph processing")
                .build()
        });

        Self {
            instruments: SupergraphInstruments {
                poll_total,
                poll_duration,
                process_duration,
            },
        }
    }

    pub fn capture_poll<'a>(&'a self) -> Capture<SupergraphPollState<'a>> {
        if !self.instruments.is_poll_enabled() {
            return Capture::disabled();
        }

        Capture::enabled(SupergraphPollState {
            instruments: &self.instruments,
            started_at: Instant::now(),
        })
    }

    pub fn capture_process<'a>(&'a self) -> Capture<SupergraphProcessState<'a>> {
        if !self.instruments.is_process_enabled() {
            return Capture::disabled();
        }

        Capture::enabled(SupergraphProcessState {
            instruments: &self.instruments,
            started_at: Instant::now(),
        })
    }
}

impl<'a> Capture<SupergraphPollState<'a>> {
    pub fn finish_not_modified(self) {
        self.record(values::SupergraphPollResult::NotModified);
    }

    pub fn finish_updated(self) {
        self.record(values::SupergraphPollResult::Updated);
    }

    pub fn finish_error(self) {
        self.record(values::SupergraphPollResult::Error);
    }

    fn record(self, result: values::SupergraphPollResult) {
        let Some(state) = self.take() else {
            return;
        };

        let attributes = [KeyValue::new(labels::RESULT, result.as_str())];

        if let Some(counter) = &state.instruments.poll_total {
            #[cfg(debug_assertions)]
            debug_assert_attrs(names::SUPERGRAPH_POLL_TOTAL, &attributes);
            counter.add(1, &attributes);
        }

        if let Some(histogram) = &state.instruments.poll_duration {
            #[cfg(debug_assertions)]
            debug_assert_attrs(names::SUPERGRAPH_POLL_DURATION, &attributes);
            histogram.record(state.started_at.elapsed().as_secs_f64(), &attributes);
        }
    }
}

impl<'a> Capture<SupergraphProcessState<'a>> {
    pub fn finish_ok(self) {
        self.record(values::SupergraphProcessStatus::Ok);
    }

    pub fn finish_error(self) {
        self.record(values::SupergraphProcessStatus::Error);
    }

    fn record(self, status: values::SupergraphProcessStatus) {
        let Some(state) = self.take() else {
            return;
        };

        if let Some(histogram) = &state.instruments.process_duration {
            let attributes = [KeyValue::new(labels::STATUS, status.as_str())];
            #[cfg(debug_assertions)]
            debug_assert_attrs(names::SUPERGRAPH_PROCESS_DURATION, &attributes);
            histogram.record(state.started_at.elapsed().as_secs_f64(), &attributes);
        }
    }
}