This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Prometheus metrics for RPC calls (#7088)
* WS and HTTP middlewares added * Prometheus endpoint added * Counters renamed * Proper style for inc * Metrics initialization re-written * Rework to handler middleware * Introduce transport prefix for metrics * String shortened * Commented code removed, new line inserted * One more string shortened * Wasm build fixed * Wasm build fixed once again * Rework to shared metrics * Added collectors label * Tilde removed from cargo * Switch to owned metrics in parameters
- Loading branch information
Showing
6 changed files
with
157 additions
and
29 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| // This file is part of Substrate. | ||
|
|
||
| // Copyright (C) 2020 Parity Technologies (UK) Ltd. | ||
| // SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0 | ||
|
|
||
| // This program is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
|
|
||
| // This program is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU General Public License for more details. | ||
|
|
||
| // You should have received a copy of the GNU General Public License | ||
| // along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
|
|
||
| //! Middleware for RPC requests. | ||
|
|
||
| use jsonrpc_core::{ | ||
| Middleware as RequestMiddleware, Metadata, | ||
| Request, Response, FutureResponse, FutureOutput | ||
| }; | ||
| use prometheus_endpoint::{ | ||
| Registry, CounterVec, PrometheusError, | ||
| Opts, register, U64 | ||
| }; | ||
|
|
||
| use futures::{future::Either, Future}; | ||
|
|
||
| /// Metrics for RPC middleware | ||
| #[derive(Debug, Clone)] | ||
| pub struct RpcMetrics { | ||
| rpc_calls: CounterVec<U64>, | ||
| } | ||
|
|
||
| impl RpcMetrics { | ||
| /// Create an instance of metrics | ||
| pub fn new(metrics_registry: Option<&Registry>) -> Result<Self, PrometheusError> { | ||
| metrics_registry.and_then(|r| { | ||
| Some(RpcMetrics { | ||
| rpc_calls: register(CounterVec::new( | ||
| Opts::new( | ||
| "rpc_calls_total", | ||
| "Number of rpc calls received", | ||
| ), | ||
| &["protocol"] | ||
| ).ok()?, r).ok()?, | ||
| }) | ||
| }).ok_or(PrometheusError::Msg("Cannot register metric".to_string())) | ||
| } | ||
| } | ||
|
|
||
| /// Middleware for RPC calls | ||
| pub struct RpcMiddleware { | ||
| metrics: Option<RpcMetrics>, | ||
| transport_label: String, | ||
| } | ||
|
|
||
| impl RpcMiddleware { | ||
| /// Create an instance of middleware with provided metrics | ||
| /// transport_label is used as a label for Prometheus collector | ||
| pub fn new(metrics: Option<RpcMetrics>, transport_label: &str) -> Self { | ||
| RpcMiddleware { | ||
| metrics, | ||
| transport_label: String::from(transport_label), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl<M: Metadata> RequestMiddleware<M> for RpcMiddleware { | ||
| type Future = FutureResponse; | ||
| type CallFuture = FutureOutput; | ||
|
|
||
| fn on_request<F, X>(&self, request: Request, meta: M, next: F) -> Either<FutureResponse, X> | ||
| where | ||
| F: Fn(Request, M) -> X + Send + Sync, | ||
| X: Future<Item = Option<Response>, Error = ()> + Send + 'static, | ||
| { | ||
| if let Some(ref metrics) = self.metrics { | ||
| metrics.rpc_calls.with_label_values(&[self.transport_label.as_str()]).inc(); | ||
| } | ||
|
|
||
| Either::B(next(request, meta)) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters