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

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

use crate::metrics::{MetricDescriptor, MetricName, MetricSubsystem, new_counter_md, new_gauge_md, subsystems};

lazy_static::lazy_static! {
    pub static ref API_REJECTED_AUTH_TOTAL_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRejectedAuthTotal,
            "Total number of requests rejected for auth failure",
            &["type"],
            subsystems::API_REQUESTS
        );

    pub static ref API_REJECTED_HEADER_TOTAL_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRejectedHeaderTotal,
            "Total number of requests rejected for invalid header",
            &["type"],
            MetricSubsystem::ApiRequests
        );

    pub static ref API_REJECTED_TIMESTAMP_TOTAL_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRejectedTimestampTotal,
            "Total number of requests rejected for invalid timestamp",
            &["type"],
            MetricSubsystem::ApiRequests
        );

    pub static ref API_REJECTED_INVALID_TOTAL_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRejectedInvalidTotal,
            "Total number of invalid requests",
            &["type"],
            MetricSubsystem::ApiRequests
        );

    pub static ref API_REQUESTS_WAITING_TOTAL_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::ApiRequestsWaitingTotal,
            "Total number of requests in the waiting queue",
            &["type"],
            MetricSubsystem::ApiRequests
        );

    pub static ref API_REQUESTS_INCOMING_TOTAL_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::ApiRequestsIncomingTotal,
            "Total number of incoming requests",
            &["type"],
            MetricSubsystem::ApiRequests
        );

    pub static ref API_REQUESTS_IN_FLIGHT_TOTAL_MD: MetricDescriptor =
        new_gauge_md(
            MetricName::ApiRequestsInFlightTotal,
            "Total number of requests currently in flight",
            &["name", "type"],
            MetricSubsystem::ApiRequests
        );

    pub static ref API_REQUESTS_TOTAL_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRequestsTotal,
            "Total number of requests",
            &["name", "type"],
            MetricSubsystem::ApiRequests
        );

    pub static ref API_REQUESTS_ERRORS_TOTAL_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRequestsErrorsTotal,
            "Total number of requests with (4xx and 5xx) errors",
            &["name", "type"],
            MetricSubsystem::ApiRequests
        );

    pub static ref API_REQUESTS_5XX_ERRORS_TOTAL_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRequests5xxErrorsTotal,
            "Total number of requests with 5xx errors",
            &["name", "type"],
            MetricSubsystem::ApiRequests
        );

    pub static ref API_REQUESTS_4XX_ERRORS_TOTAL_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRequests4xxErrorsTotal,
            "Total number of requests with 4xx errors",
            &["name", "type"],
            MetricSubsystem::ApiRequests
        );

    pub static ref API_REQUESTS_CANCELED_TOTAL_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRequestsCanceledTotal,
            "Total number of requests canceled by the client",
            &["name", "type"],
            MetricSubsystem::ApiRequests
        );

    pub static ref API_REQUESTS_TTFB_SECONDS_DISTRIBUTION_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiRequestsTTFBSecondsDistribution,
            "Distribution of time to first byte across API calls",
            &["name", "type", "le"],
            MetricSubsystem::ApiRequests
        );

    pub static ref API_TRAFFIC_SENT_BYTES_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiTrafficSentBytes,
            "Total number of bytes sent",
            &["type"],
            MetricSubsystem::ApiRequests
        );

    pub static ref API_TRAFFIC_RECV_BYTES_MD: MetricDescriptor =
        new_counter_md(
            MetricName::ApiTrafficRecvBytes,
            "Total number of bytes received",
            &["type"],
            MetricSubsystem::ApiRequests
        );
}