#metrics #telemetry #yaml

metrics-observer-yaml

A metrics-core compatible observer that outputs YAML

2 releases

0.1.1 Jul 30, 2019
0.1.0 Jul 30, 2019

#32 in #telemetry

Download history 1370/week @ 2023-10-29 1209/week @ 2023-11-05 1350/week @ 2023-11-12 1040/week @ 2023-11-19 1425/week @ 2023-11-26 1573/week @ 2023-12-03 1074/week @ 2023-12-10 752/week @ 2023-12-17 2333/week @ 2023-12-24 758/week @ 2023-12-31 923/week @ 2024-01-07 946/week @ 2024-01-14 1114/week @ 2024-01-21 1422/week @ 2024-01-28 1080/week @ 2024-02-04 1175/week @ 2024-02-11

4,806 downloads per month
Used in 9 crates (2 directly)

MIT license

180KB
3K SLoC

metrics-observer-yaml

conduct-badge downloads-badge release-badge docs-badge license-badge

metrics-observer-yaml is a metrics-core compatible observer that outputs YAML.

code of conduct

NOTE: All conversations and contributions to this project shall adhere to the Code of Conduct.


lib.rs:

Observes metrics in YAML format.

Metric scopes are used to provide the hierarchy and indentation of metrics. As an example, for a snapshot with two metrics — server.msgs_received and server.msgs_sent — we would expect to see this output:

server:
  msgs_received: 42
  msgs_sent: 13

If we added another metric — configuration_reloads — we would expect to see:

configuration_reloads: 2
server:
  msgs_received: 42
  msgs_sent: 13

Metrics are sorted alphabetically.

Histograms

Histograms are rendered with a configurable set of quantiles that are provided when creating an instance of YamlBuilder. They are formatted using human-readable labels when displayed to the user. For example, 0.0 is rendered as "min", 1.0 as "max", and anything in between using the common "pXXX" format i.e. a quantile of 0.5 or percentile of 50 would be p50, a quantile of 0.999 or percentile of 99.9 would be p999, and so on.

All histograms have the sample count of the histogram provided in the output.

connect_time count: 15
connect_time min: 1334
connect_time p50: 1934
connect_time p99: 5330
connect_time max: 139389

Dependencies

~3MB
~53K SLoC