open-telemetry
/
opentelemetry-collector
mirror of https://github.com/open-telemetry/opentelemetry-collector.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
opentelemetry-collector/exporter/prometheusremotewriteexporter
History
alrex aa60edff16
rename DoubleSum -> Sum (#3583) 
* rename DoubleSum -> Sum

* update changelog

* revert pict changes
 		2021-07-12 15:21:51 -07:00
..
img Add Cortex and Prometheus Remote Write exporter design (#1464) 2020-08-11 10:39:12 -07:00
testdata Validate that remote write queue settings are not negative (#3213) 2021-05-17 18:19:22 -07:00
DESIGN.md fix some typos (#2671) 2021-03-11 11:11:28 -08:00
README.md Make editorial changes to the PRW exporter README (#3212) 2021-05-19 10:59:11 -04:00
config.go Remove QueueSettings (#3210) 2021-05-18 13:07:03 -07:00
config_test.go Replace Viper with Koanf to add map case sensitivity (#3337) 2021-06-13 23:20:14 -07:00
exporter.go rename DoubleSum -> Sum (#3583) 2021-07-12 15:21:51 -07:00
exporter_test.go rename DoubleSum -> Sum (#3583) 2021-07-12 15:21:51 -07:00
factory.go Change exporterhelper to accept ExporterCreateSettings instead of just logger (#3569) 2021-07-08 10:57:10 -07:00
factory_test.go Add componenttest.NewNop*CreateSettings to simplify tests (#3375) 2021-06-08 10:49:35 -04:00
helper.go rename DoubleSum -> Sum (#3583) 2021-07-12 15:21:51 -07:00
helper_test.go Move pdata in the new package (#3483) 2021-06-25 01:17:31 +03:00
testutil_test.go rename DoubleSum -> Sum (#3583) 2021-07-12 15:21:51 -07:00

README.md

Prometheus Remote Write Exporter

Prometheus Remote Write Exporter sends OpenTelemetry metrics to Prometheus remote write compatible backends such as Cortex and Thanos. By default, this exporter requires TLS and offers queued retry capabilities.

Supported pipeline types: metrics

⚠️ Non-cumulative monotonic, histogram, and summary OTLP metrics are dropped by this exporter.

A design doc is available to document in detail how this exporter works.

Getting Started

The following settings are required:

  • endpoint (no default): The remote write URL to send remote write samples.

By default, TLS is enabled:

  • insecure (default = false): whether to enable client transport security for the exporter's connection.

As a result, the following parameters are also required:

  • cert_file (no default): path to the TLS cert to use for TLS required connections. Should only be used if insecure is set to false.
  • key_file (no default): path to the TLS key to use for TLS required connections. Should only be used if insecure is set to false.

The following settings can be optionally configured:

  • external_labels: list of labels to be attached to each metric data point
  • headers: additional headers attached to each HTTP request.
    • Note the following headers cannot be changed: Content-Encoding, Content-Type, X-Prometheus-Remote-Write-Version, and User-Agent.
  • namespace: prefix attached to each exported metric name.
  • remote_write_queue: fine tuning for queueing and sending of the outgoing remote writes.
    • queue_size: number of OTLP metrics that can be queued.
    • num_consumers: minimum number of workers to use to fan out the outgoing requests.

Example:

exporters:
  prometheusremotewrite:
    endpoint: "https://my-cortex:7900/api/v1/push"

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically: