libp2p_metrics/
gossipsub.rs

1// Copyright 2021 Protocol Labs.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a
4// copy of this software and associated documentation files (the "Software"),
5// to deal in the Software without restriction, including without limitation
6// the rights to use, copy, modify, merge, publish, distribute, sublicense,
7// and/or sell copies of the Software, and to permit persons to whom the
8// Software is furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
14// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
19// DEALINGS IN THE SOFTWARE.
20
21use prometheus_client::{metrics::counter::Counter, registry::Registry};
22
23pub(crate) struct Metrics {
24    messages: Counter,
25}
26
27impl Metrics {
28    pub(crate) fn new(registry: &mut Registry) -> Self {
29        let sub_registry = registry.sub_registry_with_prefix("gossipsub");
30
31        let messages = Counter::default();
32        sub_registry.register("messages", "Number of messages received", messages.clone());
33
34        Self { messages }
35    }
36}
37
38impl super::Recorder<libp2p_gossipsub::Event> for Metrics {
39    fn record(&self, event: &libp2p_gossipsub::Event) {
40        if let libp2p_gossipsub::Event::Message { .. } = event {
41            self.messages.inc();
42        }
43    }
44}