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

// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.

use mz_ore::metric;
use mz_ore::metrics::MetricsRegistry;
use mz_ore::stats::{histogram_milliseconds_buckets, histogram_seconds_buckets};
use mz_sql::ast::{AstInfo, Statement, StatementKind, SubscribeOutput};
use mz_sql::session::user::User;
use mz_sql_parser::ast::statement_kind_label_value;
use prometheus::{Histogram, HistogramVec, IntCounter, IntCounterVec, IntGaugeVec};

#[derive(Debug, Clone)]
pub struct Metrics {
    pub query_total: IntCounterVec,
    pub active_sessions: IntGaugeVec,
    pub active_subscribes: IntGaugeVec,
    pub active_copy_tos: IntGaugeVec,
    pub queue_busy_seconds: HistogramVec,
    pub determine_timestamp: IntCounterVec,
    pub timestamp_difference_for_strict_serializable_ms: HistogramVec,
    pub commands: IntCounterVec,
    pub storage_usage_collection_time_seconds: HistogramVec,
    pub subscribe_outputs: IntCounterVec,
    pub canceled_peeks: IntCounterVec,
    pub linearize_message_seconds: HistogramVec,
    pub time_to_first_row_seconds: HistogramVec,
    pub statement_logging_records: IntCounterVec,
    pub statement_logging_unsampled_bytes: IntCounterVec,
    pub statement_logging_actual_bytes: IntCounterVec,
    pub message_batch: HistogramVec,
    pub message_handling: HistogramVec,
    pub optimization_notices: IntCounterVec,
    pub append_table_duration_seconds: HistogramVec,
    pub webhook_validation_reduce_failures: IntCounterVec,
    pub webhook_get_appender: IntCounter,
    pub check_scheduling_policies_seconds: HistogramVec,
    pub handle_scheduling_decisions_seconds: HistogramVec,
    pub row_set_finishing_seconds: HistogramVec,
}

impl Metrics {
    pub(crate) fn register_into(registry: &MetricsRegistry) -> Self {
        Self {
            query_total: registry.register(metric!(
                name: "mz_query_total",
                help: "The total number of queries issued of the given type since process start.",
                var_labels: ["session_type", "statement_type"],
            )),
            active_sessions: registry.register(metric!(
                name: "mz_active_sessions",
                help: "The number of active coordinator sessions.",
                var_labels: ["session_type"],
            )),
            active_subscribes: registry.register(metric!(
                name: "mz_active_subscribes",
                help: "The number of active SUBSCRIBE queries.",
                var_labels: ["session_type"],
            )),
            active_copy_tos: registry.register(metric!(
                name: "mz_active_copy_tos",
                help: "The number of active COPY TO queries.",
                var_labels: ["session_type"],
            )),
            queue_busy_seconds: registry.register(metric!(
                name: "mz_coord_queue_busy_seconds",
                help: "The number of seconds the coord queue was processing before it was empty. This is a sampled metric and does not measure the full coord queue wait/idle times.",
                buckets: histogram_seconds_buckets(0.000_128, 32.0)
            )),
            determine_timestamp: registry.register(metric!(
                name: "mz_determine_timestamp",
                help: "The total number of calls to determine_timestamp.",
                var_labels:["respond_immediately", "isolation_level", "compute_instance"],
            )),
            timestamp_difference_for_strict_serializable_ms: registry.register(metric!(
                name: "mz_timestamp_difference_for_strict_serializable_ms",
                help: "Difference in timestamp in milliseconds for running in strict serializable vs serializable isolation level.",
                var_labels:["compute_instance"],
                buckets: histogram_milliseconds_buckets(1., 8000.),
            )),
            commands: registry.register(metric!(
                name: "mz_adapter_commands",
                help: "The total number of adapter commands issued of the given type since process start.",
                var_labels: ["command_type", "status", "application_name"],
            )),
            storage_usage_collection_time_seconds: registry.register(metric!(
                name: "mz_storage_usage_collection_time_seconds",
                help: "The number of seconds the coord spends collecting usage metrics from storage.",
                buckets: histogram_seconds_buckets(0.000_128, 8.0)
            )),
            subscribe_outputs: registry.register(metric!(
                name: "mz_subscribe_outputs",
                help: "The total number of different subscribe outputs used",
                var_labels: ["session_type", "subscribe_output"],
            )),
            canceled_peeks: registry.register(metric!(
                name: "mz_canceled_peeks_total",
                help: "The total number of canceled peeks since process start.",
            )),
            linearize_message_seconds: registry.register(metric!(
                name: "mz_linearize_message_seconds",
                help: "The number of seconds it takes to linearize strict serializable messages",
                var_labels: ["type", "immediately_handled"],
                buckets: histogram_seconds_buckets(0.000_128, 8.0),
            )),
            time_to_first_row_seconds: registry.register(metric! {
                name: "mz_time_to_first_row_seconds",
                help: "Latency of an execute for a successful query from pgwire's perspective",
                var_labels: ["instance_id", "isolation_level", "strategy"],
                buckets: histogram_seconds_buckets(0.000_128, 32.0)
            }),
            statement_logging_records: registry.register(metric! {
                name: "mz_statement_logging_record_count",
                help: "The total number of SQL statements tagged with whether or not they were recorded.",
                var_labels: ["sample"],
            }),
            statement_logging_unsampled_bytes: registry.register(metric!(
                name: "mz_statement_logging_unsampled_bytes",
                help: "The total amount of SQL text that would have been logged if statement logging were unsampled.",
            )),
            statement_logging_actual_bytes: registry.register(metric!(
                name: "mz_statement_logging_actual_bytes",
                help: "The total amount of SQL text that was logged by statement logging.",
            )),
            message_batch: registry.register(metric!(
                name: "mz_coordinator_message_batch_size",
                help: "Message batch size handled by the coordinator.",
                buckets: vec![0., 1., 2., 3., 4., 6., 8., 12., 16., 24., 32., 48., 64.],
            )),
            message_handling: registry.register(metric!(
                name: "mz_slow_message_handling",
                help: "Latency for ALL coordinator messages. 'slow' is in the name for legacy reasons, but is not accurate.",
                var_labels: ["message_kind"],
                buckets: histogram_seconds_buckets(0.000_128, 32.0),
            )),
            optimization_notices: registry.register(metric!(
                name: "mz_optimization_notices",
                help: "Number of optimization notices per notice type.",
                var_labels: ["notice_type"],
            )),
            append_table_duration_seconds: registry.register(metric!(
                name: "mz_append_table_duration_seconds",
                help: "Latency for appending to any (user or system) table.",
                buckets: histogram_seconds_buckets(0.128, 32.0),
            )),
            webhook_validation_reduce_failures: registry.register(metric!(
                name: "mz_webhook_validation_reduce_failures",
                help: "Count of how many times we've failed to reduce a webhook source's CHECK statement.",
                var_labels: ["reason"],
            )),
            webhook_get_appender: registry.register(metric!(
                name: "mz_webhook_get_appender_count",
                help: "Count of getting a webhook appender from the Coordinator.",
            )),
            check_scheduling_policies_seconds: registry.register(metric!(
                name: "mz_check_scheduling_policies_seconds",
                help: "The time each policy in `check_scheduling_policies` takes.",
                var_labels: ["policy", "thread"],
                buckets: histogram_seconds_buckets(0.000_128, 8.0),
            )),
            handle_scheduling_decisions_seconds: registry.register(metric!(
                name: "mz_handle_scheduling_decisions_seconds",
                help: "The time `handle_scheduling_decisions` takes.",
                var_labels: ["altered_a_cluster"],
                buckets: histogram_seconds_buckets(0.000_128, 8.0),
            )),
            row_set_finishing_seconds: registry.register(metric!(
                name: "mz_row_set_finishing_seconds",
                help: "The time it takes to run RowSetFinishing::finish.",
                buckets: histogram_seconds_buckets(0.000_128, 16.0),
            )),
        }
    }

    pub(crate) fn row_set_finishing_seconds(&self) -> Histogram {
        self.row_set_finishing_seconds.with_label_values(&[])
    }

    pub(crate) fn session_metrics(&self) -> SessionMetrics {
        SessionMetrics {
            row_set_finishing_seconds: self.row_set_finishing_seconds(),
        }
    }
}

/// Metrics associated with a [`crate::session::Session`].
#[derive(Debug, Clone)]
pub struct SessionMetrics {
    row_set_finishing_seconds: Histogram,
}

impl SessionMetrics {
    pub(crate) fn row_set_finishing_seconds(&self) -> &Histogram {
        &self.row_set_finishing_seconds
    }
}

pub(crate) fn session_type_label_value(user: &User) -> &'static str {
    match user.is_internal() {
        true => "system",
        false => "user",
    }
}

pub(crate) fn statement_type_label_value<T>(stmt: &Statement<T>) -> &'static str
where
    T: AstInfo,
{
    statement_kind_label_value(StatementKind::from(stmt))
}

pub(crate) fn subscribe_output_label_value<T>(output: &SubscribeOutput<T>) -> &'static str
where
    T: AstInfo,
{
    match output {
        SubscribeOutput::Diffs => "diffs",
        SubscribeOutput::WithinTimestampOrderBy { .. } => "within_timestamp_order_by",
        SubscribeOutput::EnvelopeUpsert { .. } => "envelope_upsert",
        SubscribeOutput::EnvelopeDebezium { .. } => "envelope_debezium",
    }
}