Skip to main content

rws_server/app/controller/metrics/
mod.rs

1#[cfg(test)]
2mod tests;
3
4use crate::controller::Controller;
5use crate::range::Range;
6use crate::request::{METHOD, Request};
7use crate::response::{Response, STATUS_CODE_REASON_PHRASE};
8use crate::server::ConnectionInfo;
9
10/// Prometheus metrics endpoint: `GET /metrics`.
11///
12/// Returns every metric in the Prometheus text exposition format
13/// (`text/plain; version=0.0.4`), or the protobuf format — the one that
14/// carries native histograms — when the scraper's `Accept` prefers it.
15pub struct MetricsController;
16
17const PROMETHEUS_CONTENT_TYPE: &str = "text/plain; version=0.0.4";
18
19impl Controller for MetricsController {
20    /// Only for `metrics_allow` clients (loopback and private ranges by
21    /// default, since 18.27.0): the rest fall through to a `404`.
22    fn is_matching(request: &Request, connection: &ConnectionInfo) -> bool {
23        request.method == METHOD.get
24            && request.request_uri == "/metrics"
25            && crate::server_config::ServerConfig::current().metrics_allow.trusts(&crate::ip_filter::client_ip(request, &connection.client.ip))
26    }
27
28    fn process(request: &Request, mut response: Response, _connection: &ConnectionInfo) -> Response {
29        MetricsController::fill_response(request, &mut response);
30        response
31    }
32}
33
34impl MetricsController {
35    /// Text format, or protobuf (with native histograms) when `Accept` asks for it.
36    fn fill_response(request: &Request, response: &mut Response) {
37        use crate::metrics::exposition;
38        let (body, content_type) = match request.header("Accept").map(|h| &*h.value) {
39            Some(accept) if exposition::accepts_protobuf(accept) => (exposition::protobuf(), exposition::PROTOBUF_CONTENT_TYPE),
40            _ => (crate::metrics::prometheus_text().into_bytes(), PROMETHEUS_CONTENT_TYPE),
41        };
42        response.status_code = *STATUS_CODE_REASON_PHRASE.n200_ok.status_code;
43        response.reason_phrase = STATUS_CODE_REASON_PHRASE.n200_ok.reason_phrase.to_string();
44        response.content_range_list = vec![
45            Range::get_content_range(body, content_type.to_string())
46        ];
47    }
48
49    pub fn is_matching_request(request: &Request) -> bool {
50        request.method == METHOD.get && request.request_uri == "/metrics"
51    }
52
53    pub fn process_request(request: &Request, mut response: Response) -> Response {
54        MetricsController::fill_response(request, &mut response);
55        response
56    }
57}