Skip to content

Commit

Permalink
Add warning about the Prometheus receiver's capabilities (#2176)
Browse files Browse the repository at this point in the history
* Add warning about the Prometheus receiver's capabilities

We will eventually find a long-term solution to these problems but in the meantime let the users know about the limitations.

* Make modifications

* Fix typo

Co-authored-by: Bogdan Drutu <lazy@splunk.com>
  • Loading branch information
rakyll and Bogdan Drutu committed Nov 18, 2020
1 parent 02781c0 commit 7761a6e
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions receiver/prometheusreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,19 @@ Receives metric data in [Prometheus](https://prometheus.io/) format. See the

Supported pipeline types: metrics

## ⚠️ Warning

Note: This component is currently work in progress. It has several limitations
and please don't use it if the following limitations is a concern:

* Collector cannot auto-scale the scraping yet when multiple replicas of the
collector is run.
* When running multiple replicas of the collector with the same config, it will
scrape the targets multiple times.
* Users need to configure each replica with different scraping configuration
if they want to manually shard the scraping.
* The Prometheus receiver is a stateful component.

## Getting Started

This receiver is a drop-in replacement for getting Prometheus to scrape your
Expand Down

0 comments on commit 7761a6e

Please sign in to comment.