2 unstable releases
0.2.0 | Sep 10, 2024 |
---|---|
0.1.0 | Aug 27, 2021 |
#128 in Memory management
53KB
1K
SLoC
Metriki
Metriki is a rust library ported from Dropwizard Metrics.
Like Dropwizard Metrics, Metriki aggregates metrics on client-side and outputs limited amount data.
Quick Start
// create a timer to track the execution rate and latency of this function
// to use macros you will need to turn on `macros` feature of metriki_core
#[timed]
fn your_function() {
// a function metered by a timer for its rate and latency
}
use metriki_core::global::global_registry;
use metriki_influxdb_reporter::InfluxDbReporterBuilder;
// by default, the timer is registered in this global_registry()
let registry = global_registry();
// start a reporter to send data into influxdb
InfluxDbReporterBuilder::default()
.url("localhost:8086")
.username(String::from("influxdbuser"))
.password(String::from("yourpassword"))
.database("db")
.registry(registry.clone())
.build()
.unwrap()
.start();
Components
- Metrics (doc) (crate)
- Reporters / Exporters
- Instruments
- jemalloc: tracking jemalloc stats (doc) (crate).
- tracing: tracing subscriber layer (doc) (crate).
- tower + hyper: tower layer for metriki integration (doc) (crate).
- warp: warp middleware to inject metriki
MetricsRegistry
(doc) (crate). - r2d2: monitoring database connection usage (doc) (crate).
- tokio: monitoring tokio internals using tokio_metrics (doc) (crate).
Concepts
Metrics
- Counter: a value that can be increased and decreased.
- Meter: measures rate of an event.
- Histogram: records distribution of data over time.
- Timer: a combination of meter and histogram.
- Gauge: a function that provides value when queried.
MetricsRegistry
An entrypoint and holder of all metrics.
MetricsSet
A trait to be implemented so that dynamic metrics can be added into registry. Metrics from the set are pulled into registry everytime when reporters and exporters pulling values from the registry.
Reporter
A component to report metric data periodically. Typically used for data sinks which has a push-model.
Exporter
A component to expose metric data to external queriers. Typically for pull based data sinks.
License
MIT/Apache-2.0
lib.rs
:
Metriki Jemalloc Instrumentation
This library provide metrics of jemalloc memory allocator.
The data is fetched from a library called jemalloc-ctl
, and we
are using the tikv maintained version of
it. It is recommended to
use that version of jemallocator too.
The instrumentation is provided as a MetricsSet
. Use
MetricsRegistry::register_metrics_set
to add it to your metriki
registry.
An example can be found in our github repo.
Dependencies
~3.5–8.5MB
~91K SLoC