elfo-telemeter 0.2.0-alpha.21

Collects and exposes metrics of the elfo system
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

//! Interaction with the `metrics` crate. [Configuration].
//!
//! Records metrics in the OpenMetrics exposition format.
//!
//! Note that push gateways aren't supported, histogram buckets overrides
//! don't work, only summaries.
//!
//! All metrics include information about the actor, where they were produced.
//! Such information is added as labels. By default, only the `actor_group`
//! label is added, but it's possible to provide `actor_key` on a group basis.
//! It's useful, if a group has few actors inside.
//!
//! [Configuration]: config::Config

#![cfg_attr(docsrs, feature(doc_cfg))]

use std::sync::Arc;

use tracing::error;

use elfo_core::Blueprint;

use self::{recorder::Recorder, storage::Storage};

pub mod config;
pub mod protocol;

mod actor;
mod hyper;
mod metrics;
mod recorder;
mod render;
mod stats;
mod storage;

#[cfg(feature = "unstable")]
mod allocator;

#[cfg(feature = "unstable")]
pub use allocator::AllocatorStats;

/// Installs a global metric recorder and returns a group to handle metrics.
///
/// # Example
/// ```
/// # use elfo_core as elfo;
///
/// let topology = elfo::Topology::empty();
/// let telemeters = topology.local("telemeters");
///
/// // Usually, it's `elfo::batteries::telemeter::init`.
/// telemeters.mount(elfo_telemeter::init());
/// ```
pub fn init() -> Blueprint {
    let storage = Arc::new(Storage::default());
    let recorder = Recorder::new(storage.clone());
    let blueprint = actor::new(storage);

    match ::metrics::set_boxed_recorder(Box::new(recorder)) {
        Ok(_) => stats::register(),
        Err(err) => error!(error = %err, "failed to set a metric recorder"),
    }

    blueprint
}