risingwave_frontend/scheduler/distributed/
stats.rs

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
// Copyright 2024 RisingWave Labs
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::sync::LazyLock;

use prometheus::core::{AtomicI64, AtomicU64, GenericCounter, GenericGauge};
use prometheus::{
    exponential_buckets, histogram_opts, register_histogram_with_registry,
    register_int_counter_with_registry, register_int_gauge_with_registry, Histogram, Registry,
};
use risingwave_common::monitor::GLOBAL_METRICS_REGISTRY;

#[derive(Clone)]
pub struct DistributedQueryMetrics {
    pub running_query_num: GenericGauge<AtomicI64>,
    pub rejected_query_counter: GenericCounter<AtomicU64>,
    pub completed_query_counter: GenericCounter<AtomicU64>,
    pub query_latency: Histogram,
}

pub static GLOBAL_DISTRIBUTED_QUERY_METRICS: LazyLock<DistributedQueryMetrics> =
    LazyLock::new(|| DistributedQueryMetrics::new(&GLOBAL_METRICS_REGISTRY));

impl DistributedQueryMetrics {
    fn new(registry: &Registry) -> Self {
        let running_query_num = register_int_gauge_with_registry!(
            "distributed_running_query_num",
            "The number of running query of distributed execution mode",
            registry
        )
        .unwrap();

        let rejected_query_counter = register_int_counter_with_registry!(
            "distributed_rejected_query_counter",
            "The number of rejected query in distributed execution mode. ",
            registry
        )
        .unwrap();

        let completed_query_counter = register_int_counter_with_registry!(
            "distributed_completed_query_counter",
            "The number of query ended successfully in distributed execution mode",
            registry
        )
        .unwrap();

        let opts = histogram_opts!(
            "distributed_query_latency",
            "latency of query executed successfully in distributed execution mode",
            exponential_buckets(0.01, 2.0, 23).unwrap()
        );

        let query_latency = register_histogram_with_registry!(opts, registry).unwrap();

        Self {
            running_query_num,
            rejected_query_counter,
            completed_query_counter,
            query_latency,
        }
    }

    /// Create a new `DistributedQueryMetrics` instance used in tests or other places.
    pub fn for_test() -> Self {
        GLOBAL_DISTRIBUTED_QUERY_METRICS.clone()
    }
}