Module metrics

Available on crate feature component only.

Crate-specific metrics functionality.

This module re-exports the contents of the metrics crate. This is effectively a way to monkey-patch the functions in this module into the metrics crate, at least from the point of view of the other code in this crate.

Code in this crate that wants to use metrics should use crate::metrics;, so that this module shadows the metrics crate.

This trick is probably good to avoid in general, because it could be confusing, but in this limited case, it seems like a clean option.

Modules

• atomics
  Atomic types used for metrics.

Macros

• counter
  Registers a counter.
• describe_counter
  Describes a counter.
• describe_gauge
  Describes a gauge.
• describe_histogram
  Describes a histogram.
• gauge
  Registers a gauge.
• histogram
  Registers a histogram.

Structs

• Counter
  A counter.
• Gauge
  A gauge.
• Histogram
  A histogram.
• Key
  A metric identifier.
• KeyHasher
  Key-specific hashing algorithm.
• KeyName
  Name component of a key.
• Label
  Metadata for a metric key in the form of a key/value pair.
• Level
  Describes the level of verbosity of a metric event.
• Metadata
  Metadata describing a metric event. This provides additional context to Recorder, allowing for fine-grained filtering.
• NoopRecorder
  A no-op recorder.
• SetRecorderError
  Error returned when trying to install a global recorder when another has already been installed.

Enums

• GaugeValue
  Value of a gauge operation.
• Unit
  Units for a given metric.

Constants

• MISSED_BLOCKS

Traits

• CounterFn
  A counter handler.
• GaugeFn
  A gauge handler.
• HistogramFn
  A histogram handler.
• IntoF64
  An object which can be converted into a f64 representation.
• IntoLabels
  A value that can be converted to a vector of Labels.
• Recorder
  A trait for registering and recording metrics.

Functions

• register_metrics
  Registers all metrics used by this crate.
• set_global_recorder
  Sets the global recorder.
• with_local_recorder
  Runs the closure with the given recorder set as the global recorder for the duration.

Type Aliases

• SharedString
  An allocation-optimized string.