Crate telemetry[][src]

Telemetry is a mechanism used to capture metrics in an application, to later store the data locally or upload it to a server for statistical analysis.

Examples of usage:

  • capturing the speed of an operation;
  • finding out if a remote service is often down, and how much impact this has on users;
  • finding out if users are actually using a feature;
  • finding out how the duration of a session;
  • determine the operating system on which the application is executed;
  • determining the configuration of the application;
  • capturing the operations that slow down the application;
  • determining the amount of I/O performed by the application;

This crate provides an API for recording such data in Histograms and then serializing the data. Uploading the data or storing th data is out of the scope of this crate.

Memory note: the memory used by a histogram is recollected only when its instance of telemetry::Service is garbage-collected. In other words, if a histogram goes out of scope for some reason, its data remains in telemetry and will be stored and/or uploaded in accordance with the configuration of this telemetry instance.

See Mozilla Telemetry Server for an open-source implementation of a server implementing the Telemetry protocol.

Re-exports

pub use plain::Histogram;
pub use keyed::KeyedHistogram;

Modules

keyed

Definition of keyed histograms, for data in a set known dynamically.

plain

Definition of plain histograms, for data in a set known at compile-time.

Structs

Service

Enums

SerializationFormat

A subformat of Json to use for serialization.

Subset

A subset of data to serialize.

Traits

Flatten

A value that can be represented as a u32.