Crate diem_metrics

Metrics

Counters

Used to measure values that are added to over time, rates can then be used to check how quickly it changes in graphs. An example would be to add every time an incoming message occurs.

use prometheus::register_int_counter_vec;

register_int_counter_vec!(
    "name",
    "description",
    &["dimension_1", "dimension_2"]
);

Gauges

Used to measure values that change level over time. An example would be to set the number of connected peers.

use prometheus::register_int_gauge_vec;

register_int_gauge_vec!(
    "name",
    "description",
    &["dimension_1", "dimension_2"]
);

Histograms

Used to measure histogram values. An example is network connection latency.

use prometheus::register_histogram_vec;

register_histogram_vec!(
    "name",
    "description",
    &["dimension_1", "dimension_2"]
);

Modules

• metric_server

Macros

• monitor
  Helper function to record metrics for external calls. Include call counts, time, and whether it’s inside or not (1 or 0). It assumes a OpMetrics defined as OP_COUNTERS in crate::counters;
• register_histogram
  Create a [Histogram] and registers to default registry.
• register_histogram_vec
  Create a [HistogramVec] and registers to default registry.
• register_int_counter
  Create an [IntCounter] and registers to default registry.
• register_int_counter_vec
  Create an [IntCounterVec] and registers to default registry.
• register_int_gauge
  Create an [IntGauge] and registers to default registry.
• register_int_gauge_vec
  Create an [IntGaugeVec] and registers to default registry.

Structs

• DurationHistogram
  A small wrapper around Histogram to handle the special case of duration buckets. This Histogram will handle the correct granularity for logging time duration in a way that fits the used buckets.
• Histogram
  A [Metric] counts individual observations from an event or sample stream in configurable buckets. Similar to a Summary, it also provides a sum of observations and an observation count.
• HistogramTimer
  Timer to measure and record the duration of an event.
• OpMetrics

Statics

• NUM_METRICS

Functions

• gather_metrics
• get_all_metrics

Type Definitions

• HistogramVec
  A [Collector] that bundles a set of Histograms that all share the same [Desc], but have different values for their variable labels. This is used if you want to count the same thing partitioned by various dimensions (e.g. HTTP request latencies, partitioned by status code and method).
• IntCounter
  The integer version of [Counter]. Provides better performance if metric values are all positive integers (natural numbers).
• IntCounterVec
  The integer version of [CounterVec]. Provides better performance if metric are all positive integers (natural numbers).
• IntGauge
  The integer version of [Gauge]. Provides better performance if metric values are all integers.
• IntGaugeVec
  The integer version of [GaugeVec]. Provides better performance if metric values are all integers.