README.md
1# Exporter Helper
2
3This is a helper exporter that other exporters can depend on. Today, it
4primarily offers queued retries and resource attributes to metric labels conversion.
5
6> :warning: This exporter should not be added to a service pipeline.
7
8## Configuration
9
10The following configuration options can be modified:
11
12- `retry_on_failure`
13 - `enabled` (default = true)
14 - `initial_interval` (default = 5s): Time to wait after the first failure before retrying; ignored if `enabled` is `false`
15 - `max_interval` (default = 30s): Is the upper bound on backoff; ignored if `enabled` is `false`
16 - `max_elapsed_time` (default = 120s): Is the maximum amount of time spent trying to send a batch; ignored if `enabled` is `false`
17- `sending_queue`
18 - `enabled` (default = true)
19 - `num_consumers` (default = 10): Number of consumers that dequeue batches; ignored if `enabled` is `false`
20 - `queue_size` (default = 5000): Maximum number of batches kept in memory before data; ignored if `enabled` is `false`;
21 User should calculate this as `num_seconds * requests_per_second` where:
22 - `num_seconds` is the number of seconds to buffer in case of a backend outage
23 - `requests_per_second` is the average number of requests per seconds.
24- `resource_to_telemetry_conversion`
25 - `enabled` (default = false): If `enabled` is `true`, all the resource attributes will be converted to metric labels by default.
26- `timeout` (default = 5s): Time to wait per individual attempt to send data to a backend.
27
28The full list of settings exposed for this helper exporter are documented [here](factory.go).
29