rustfs-obs 0.0.3

Observability and monitoring tools for RustFS, providing metrics, logging, and tracing capabilities.
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
140
141
142
143
144
145

// Copyright 2024 RustFS Team
//
// 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.

/// Descriptors of metrics related to cluster object and bucket usage
use crate::metrics::{MetricDescriptor, MetricName, new_gauge_md, subsystems};

/// Bucket labels
pub const BUCKET_LABEL: &str = "bucket";
/// Range labels
pub const RANGE_LABEL: &str = "range";

lazy_static::lazy_static! {
    pub static ref USAGE_SINCE_LAST_UPDATE_SECONDS_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageSinceLastUpdateSeconds,
            "Time since last update of usage metrics in seconds",
            &[],
            subsystems::CLUSTER_USAGE_OBJECTS
        );

    pub static ref USAGE_TOTAL_BYTES_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageTotalBytes,
            "Total cluster usage in bytes",
            &[],
            subsystems::CLUSTER_USAGE_OBJECTS
        );

    pub static ref USAGE_OBJECTS_COUNT_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageObjectsCount,
            "Total cluster objects count",
            &[],
            subsystems::CLUSTER_USAGE_OBJECTS
        );

    pub static ref USAGE_VERSIONS_COUNT_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageVersionsCount,
            "Total cluster object versions (including delete markers) count",
            &[],
            subsystems::CLUSTER_USAGE_OBJECTS
        );

    pub static ref USAGE_DELETE_MARKERS_COUNT_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageDeleteMarkersCount,
            "Total cluster delete markers count",
            &[],
            subsystems::CLUSTER_USAGE_OBJECTS
        );

    pub static ref USAGE_BUCKETS_COUNT_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageBucketsCount,
            "Total cluster buckets count",
            &[],
            subsystems::CLUSTER_USAGE_OBJECTS
        );

    pub static ref USAGE_OBJECTS_DISTRIBUTION_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageSizeDistribution,
            "Cluster object size distribution",
            &[RANGE_LABEL],
            subsystems::CLUSTER_USAGE_OBJECTS
        );

    pub static ref USAGE_VERSIONS_DISTRIBUTION_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageVersionCountDistribution,
            "Cluster object version count distribution",
            &[RANGE_LABEL],
            subsystems::CLUSTER_USAGE_OBJECTS
        );
}

lazy_static::lazy_static! {
    pub static ref USAGE_BUCKET_TOTAL_BYTES_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageBucketTotalBytes,
            "Total bucket size in bytes",
            &[BUCKET_LABEL],
            subsystems::CLUSTER_USAGE_BUCKETS
        );

    pub static ref USAGE_BUCKET_OBJECTS_TOTAL_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageBucketObjectsCount,
            "Total objects count in bucket",
            &[BUCKET_LABEL],
            subsystems::CLUSTER_USAGE_BUCKETS
        );

    pub static ref USAGE_BUCKET_VERSIONS_COUNT_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageBucketVersionsCount,
            "Total object versions (including delete markers) count in bucket",
            &[BUCKET_LABEL],
            subsystems::CLUSTER_USAGE_BUCKETS
        );

    pub static ref USAGE_BUCKET_DELETE_MARKERS_COUNT_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageBucketDeleteMarkersCount,
            "Total delete markers count in bucket",
            &[BUCKET_LABEL],
            subsystems::CLUSTER_USAGE_BUCKETS
        );

    pub static ref USAGE_BUCKET_QUOTA_TOTAL_BYTES_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageBucketQuotaTotalBytes,
            "Total bucket quota in bytes",
            &[BUCKET_LABEL],
            subsystems::CLUSTER_USAGE_BUCKETS
        );

    pub static ref USAGE_BUCKET_OBJECT_SIZE_DISTRIBUTION_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageBucketObjectSizeDistribution,
            "Bucket object size distribution",
            &[RANGE_LABEL, BUCKET_LABEL],
            subsystems::CLUSTER_USAGE_BUCKETS
        );

    pub static ref USAGE_BUCKET_OBJECT_VERSION_COUNT_DISTRIBUTION_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::UsageBucketObjectVersionCountDistribution,
            "Bucket object version count distribution",
            &[RANGE_LABEL, BUCKET_LABEL],
            subsystems::CLUSTER_USAGE_BUCKETS
        );
}