Skip to content

Commit

Permalink
formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Gordon authored and Gordon committed Jun 18, 2024
1 parent d9de74e commit 18b4e83
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions telemetry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ source code defining those configs can be found in [config.go](./datadog/config.

#### Datadog Configs

`Enabled`: Set to `true` to enable metrics emission to Datadog.
* `Enabled`: Set to `true` to enable metrics emission to Datadog.

`StatsdAddr`: The address of the Datadog StatsD client. This is needed if the metrics should be
* `StatsdAddr`: The address of the Datadog StatsD client. This is needed if the metrics should be
emitted from Datadog.

`Namespace`: This will appear as the `Namespace` tag in Datadog.
* `Namespace`: This will appear as the `Namespace` tag in Datadog.

### Datadog Methods

Expand All @@ -38,13 +38,13 @@ be found in [config.go](./prometheus/config.go).

#### Prometheus Configs

`Enabled`: Set to true to enable metrics emission to Prometheus.
* `Enabled`: Set to true to enable metrics emission to Prometheus.

`Namespace` and `Subsystem`: These fields will be added as prefixes to the metrics name.
* `Namespace` and `Subsystem`: These fields will be added as prefixes to the metrics name.
For example, if `Namespace` is `app` and `Subsystem` is `api`, then the full metrics name of
`request_success` will be `app_api_request_success`.

`HistogramBucketCount`: The number of buckets used for Histogram typed metrics. Default is 10.
* `HistogramBucketCount`: The number of buckets used for Histogram typed metrics. Default is 10.

### Prometheus Methods

Expand All @@ -55,16 +55,16 @@ using these four basic Prometheus metrics. The following subsection documents th
implementation notes. For more information on the four basic Prometheus metrics, please see
[here](https://prometheus.io/docs/tutorials/understanding_metric_types/).

`Gauge`: This method wraps the `Gauge` metrics of Prometheus.
* `Gauge`: This method wraps the `Gauge` metrics of Prometheus.

`Decr` and `Incr`: Implemented using the `Gauge` metrics of Prometheus.
* `Decr` and `Incr`: Implemented using the `Gauge` metrics of Prometheus.

`Count`: This method wraps the `Count` metrics of Prometheus. Note that after deployment or instance
* `Count`: This method wraps the `Count` metrics of Prometheus. Note that after deployment or instance
restart, `Count` will reset to 0. This is by design in Prometheus.

`IncMonotonic` and `Error`: Implemented using the `Count` metrics of Prometheus.
* `IncMonotonic` and `Error`: Implemented using the `Count` metrics of Prometheus.

`Histogram`: This method wraps the `Histogram` metrics of Prometheus with linear buckets.
* `Histogram`: This method wraps the `Histogram` metrics of Prometheus with linear buckets.

`Time` and `Latency`: Implemented using the `Summary` metrics of Prometheus, with pre-defined
* `Time` and `Latency`: Implemented using the `Summary` metrics of Prometheus, with pre-defined
quantile observations: p50, p90, and p99.

0 comments on commit 18b4e83

Please sign in to comment.