Documentation

Scrape Prometheus metrics

This page documents an earlier version of InfluxDB. InfluxDB v2.3 is the latest stable version. View this page in the v2.3 documentation.

Use Telegraf, InfluxDB scrapers, or the prometheus.scrape Flux function to scrape Prometheus-formatted metrics from an HTTP-accessible endpoint and store them in InfluxDB.

Use Telegraf

To use Telegraf to scrape Prometheus-formatted metrics from an HTTP-accessible endpoint and write them to InfluxDB, follow these steps:

  1. Add the Prometheus input plugin to your Telegraf configuration file.
    1. Set the urls to scrape metrics from.
    2. Set the metric_version configuration option to specify which metric parsing version to use (version 2 is recommended).
  2. Add the InfluxDB v2 output plugin to your Telegraf configuration file and configure it to to write to InfluxDB.
Example telegraf.conf
# ...

## Collect Prometheus formatted metrics
[[inputs.prometheus]]
  urls = ["http://example.com/metrics"]
  metric_version = 2

## Write Prometheus formatted metrics to InfluxDB
[[outputs.influxdb_v2]]
  urls = ["http://localhost:8086"]
  token = "$INFLUX_TOKEN"
  organization = "example-org"
  bucket = "example-bucket"

# ...

Use an InfluxDB scraper

InfluxDB scrapers automatically scrape Prometheus-formatted metrics from an HTTP-accessible endpoint at a regular interval.

Create a scraper with the InfluxDB API

Use the InfluxDB API /api/v2/scrapers endpoint to manage scrapers and member privileges for scrapers.

To create a scraper, send an HTTP POST request to the /api/v2/scrapers endpoint.

POST http://localhost:8086/api/v2/scrapers

Include the following in your request:

RequirementInclude by
API token with write: orgs/YOUR_ORG_ID/scrapers permissionUse the Authorization header and the Bearer or Token scheme.
OrganizationPass as orgID in the request body.
Scraper namePass as name in the request body.
Format of scraped dataPass as type in the request body. Prometheus data format (prometheus) is the only supported type.
URL endpoint to scrapePass as url in the request body.

Optionally, to force the scraper to skip TLS verification and ignore self-signed certificates at the url, pass "allowInsecure": true in the request body.

Example

curl -v --request POST http://localhost:8086/api/v2/scrapers \
  --header "Authorization: Token ${INFLUX_TOKEN}" \
  --header 'Content-type: application/json' \
  --data-binary @- << JSON
    {
      "name": "Scraper name",
      "type": "prometheus",
      "url": "http://localhost:9090/metrics",
      "orgID": "${INFLUX_ORG}",
      "bucketID": "c55193a037c3b0ca",
      "allowInsecure": true
    }
JSON

Create a scraper with the InfluxDB UI

To use the InfluxDB UI to manage scrapers, see Scrape data using InfluxDB scrapers.

Use prometheus.scrape()

To use the prometheus.scrape() Flux function to scrape Prometheus-formatted metrics from an HTTP-accessible endpoint and write them to InfluxDB, do the following in your Flux script:

  1. Import the experimental/prometheus package.
  2. Use prometheus.scrape() and provide the URL to scrape metrics from.
  3. Use to() and specify the InfluxDB bucket to write the scraped metrics to.
Example Flux script
import "experimental/prometheus"

prometheus.scrape(url: "http://example.com/metrics")
    |> to(bucket: "example-bucket")
  1. (Optional) To scrape Prometheus metrics at regular intervals using Flux, add your Flux scraping script as an InfluxDB task.

For information about scraping Prometheus-formatted metrics with prometheus.scrape(), see Scrape Prometheus metrics with Flux.


Was this page helpful?

Thank you for your feedback!


Set your InfluxDB URL

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.