elfo-telemeter 0.1.11

A telemeter collecting metrics
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

//! Interaction with the `metrics` crate.
//! Records metrics in the Prometheus exposition format.
//!
//! A lot of code here is highly inspired by `metrics-exporter-prometheus`, and
//! even copy-pasted from it with removing some useful features. Firstly, push
//! gateways aren't supported. Secondly, histogram 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.
//!
//! I'm going to extend the original crate to reuse code.

#![warn(rust_2018_idioms, unreachable_pub, missing_docs)]

use std::sync::Arc;

use tracing::error;

use elfo_core::Schema;

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

pub mod protocol;

mod actor;
mod config;
mod recorder;
mod render;
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.
pub fn init() -> Schema {
    let storage = Arc::new(Storage::new());
    let recorder = Recorder::new(storage.clone());
    let schema = actor::new(storage);

    if let Err(err) = metrics::set_boxed_recorder(Box::new(recorder)) {
        error!(error = %err, "failed to set a metric recorder");
    }

    schema
}

/// Installs a global metric recorder and returns a group to handle metrics.
#[deprecated] // TODO(v0.2): revise this method.
pub fn new() -> Schema {
    init()
}