From ab0852ab80e3c7b50ee98f76485eec4cfa4bbb47 Mon Sep 17 00:00:00 2001 From: Jake Morrison Date: Sat, 13 Jul 2024 19:21:47 -0500 Subject: [PATCH] Update docs --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 52074ba..10ff496 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ handler to respond to metrics requests, or you can add a route/endpoint to This module supports the standard Exometer probe types such as counter, as well as using [labels](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels), -which is more natural for Prometheus, e.g.. +which is more natural for Prometheus, e.g.: api_http_requests_total{method="POST", handler="/messages"} @@ -43,7 +43,7 @@ The result might look something like this for an API service: ## Prometheus histograms vs Exometer histograms There is a fundamental difference between Exometer histograms and Prometheus -histograms. Exometer histogram buckets are dynamic, so when you get e.g. the +histograms. Exometer histogram buckets are dynamic, so when you get e.g., the 95% bucket, it depends on the actual samples. Prometheus histograms have a static range, and are perhaps best thought of as having multiple counters, one for each bucket. Because of this, we need to predefine the bucket ranges that @@ -64,7 +64,7 @@ This will pull in Exometer and its dependencies. Configure Exometer to use the custom [probes](https://github.com/Feuerlabs/exometer_core/blob/master/doc/README.md#Built-in_entries_and_probes) -defined in this module, e.g. in `config/config.exs`. +defined in this module, e.g., in `config/config.exs`. ```elixir config :exometer_core,