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

// 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.

/// bucket level s3 metric descriptor
use crate::metrics::{MetricDescriptor, MetricName, new_counter_md, new_gauge_md, new_histogram_md, subsystems};

lazy_static::lazy_static! {
    pub static ref BUCKET_API_TRAFFIC_SENT_BYTES_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiTrafficSentBytes,
            "Total number of bytes received for a bucket",
            &["bucket", "type"],
            subsystems::BUCKET_API
        );

    pub static ref BUCKET_API_TRAFFIC_RECV_BYTES_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiTrafficRecvBytes,
            "Total number of bytes sent for a bucket",
            &["bucket", "type"],
            subsystems::BUCKET_API
        );

    pub static ref BUCKET_API_REQUESTS_IN_FLIGHT_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::ApiRequestsInFlightTotal,
            "Total number of requests currently in flight for a bucket",
            &["bucket", "name", "type"],
            subsystems::BUCKET_API
        );

    pub static ref BUCKET_API_REQUESTS_TOTAL_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRequestsTotal,
            "Total number of requests for a bucket",
            &["bucket", "name", "type"],
            subsystems::BUCKET_API
        );

    pub static ref BUCKET_API_REQUESTS_CANCELED_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRequestsCanceledTotal,
            "Total number of requests canceled by the client for a bucket",
            &["bucket", "name", "type"],
            subsystems::BUCKET_API
        );

    pub static ref BUCKET_API_REQUESTS_4XX_ERRORS_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRequests4xxErrorsTotal,
            "Total number of requests with 4xx errors for a bucket",
            &["bucket", "name", "type"],
            subsystems::BUCKET_API
        );

    pub static ref BUCKET_API_REQUESTS_5XX_ERRORS_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRequests5xxErrorsTotal,
            "Total number of requests with 5xx errors for a bucket",
            &["bucket", "name", "type"],
            subsystems::BUCKET_API
        );

    pub static ref BUCKET_API_REQUESTS_TTFB_SECONDS_DISTRIBUTION_MD: MetricDescriptor =
        new_histogram_md(
            MetricName::ApiRequestsTTFBSecondsDistribution,
            "Distribution of time to first byte across API calls for a bucket",
            &["bucket", "name", "le", "type"],
            subsystems::BUCKET_API
        );
}