restructured scraper docs, added information about creating scrapable endpoints
Scott Anderson
parent
16fc047afa
commit
ec165e20d1
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: Scrape data
|
||||
seotitle: Scrape data using InfluxDB scrapers
|
||||
weight: 102
|
||||
description: >
|
||||
Scrape data from InfluxDB instances or remote endpoints using InfluxDB scrapers.
|
||||
Create a scraper in the InfluxDB UI to collect metrics from a specified target.
|
||||
aliases:
|
||||
- /v2.0/collect-data/scraper-metrics-endpoint
|
||||
v2.0/tags: [scraper]
|
||||
menu:
|
||||
v2_0:
|
||||
name: Scrape data
|
||||
parent: Collect data
|
||||
---
|
||||
|
||||
InfluxDB scrapers collect data from specified targets at regular intervals,
|
||||
then write the scraped data to an InfluxDB bucket.
|
||||
Scrapers can collect data from any HTTP/S-accessible endpoints that provide data
|
||||
in the [Prometheus data format](https://prometheus.io/docs/instrumenting/exposition_formats/).
|
||||
|
||||
The following articles provide information about creating and managing InfluxDB data scrapers:
|
||||
|
||||
{{< children >}}
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
title: Manage scrapers
|
||||
seotitle: Manage InfluxDB scrapers
|
||||
description: Create, update, and delete InfluxDB data scrapers in the InfluxDB user interface.
|
||||
menu:
|
||||
v2_0:
|
||||
name: Manage scrapers
|
||||
parent: Scrape data
|
||||
weight: 201
|
||||
---
|
||||
|
||||
The following articles walk through managing InfluxDB scrapers:
|
||||
|
||||
{{< children >}}
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
title: Create a scraper
|
||||
seotitle: Create an InfluxDB scraper
|
||||
description: Create an InfluxDB scraper that collects data from InfluxDB or a remote endpoint.
|
||||
menu:
|
||||
v2_0:
|
||||
parent: Manage scrapers
|
||||
weight: 301
|
||||
---
|
||||
|
||||
Create a new scraper in the InfluxDB user interface (UI).
|
||||
|
||||
## Create a scraper in the InfluxDB UI
|
||||
1. Click **Organizations** in the left navigation menu.
|
||||
|
||||
{{< img-hd src="/img/organizations-icon.png" />}}
|
||||
|
||||
2. In the list of organizations, click the name of your organization.
|
||||
3. Click the **Scrapers** tab.
|
||||
4. Click **+ Create Scraper**.
|
||||
5. Provide a **Name** for the scraper.
|
||||
5. Select a **Bucket** in which to store the scraped data.
|
||||
6. Enter the **Target URL** to scrape. The default URL value is `http://localhost:9999/metrics`
|
||||
which provides InfluxDB-specific metrics in the [Prometheus data format](https://prometheus.io/docs/instrumenting/exposition_formats/).
|
||||
7. Click **Finish**.
|
||||
|
||||
The new scraper will begin scraping data after approximately 10 seconds,
|
||||
then continue scraping in 10 second intervals.
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
title: Delete a scraper
|
||||
seotitle: Delete an InfluxDB scraper
|
||||
description: Delete an InfluxDB scraper in the InfluxDB user interface.
|
||||
menu:
|
||||
v2_0:
|
||||
parent: Manage scrapers
|
||||
weight: 303
|
||||
---
|
||||
|
||||
Delete a scraper from the InfluxDB user interface (UI).
|
||||
|
||||
## Delete a scraper from the InfluxDB UI
|
||||
1. Click **Organizations** in the left navigation menu.
|
||||
|
||||
{{< img-hd src="/img/organizations-icon.png" />}}
|
||||
|
||||
2. In the list of organizations, click the name of your organization.
|
||||
3. Click the **Scrapers** tab. A listing of any existing scrapers appears with the
|
||||
**Name**, **URL**, and **BUCKET** for each scraper.
|
||||
4. Hover over the scraper you would like to delete and click the **Delete** button
|
||||
that appears on the far right of the scraper list item.
|
||||
5. Click **Confirm**.
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
title: Update a scraper
|
||||
seotitle: Update an InfluxDB scraper
|
||||
description: Update an InfluxDB scraper that collects data from InfluxDB or a remote endpoint.
|
||||
menu:
|
||||
v2_0:
|
||||
parent: Manage scrapers
|
||||
weight: 302
|
||||
---
|
||||
|
||||
Update a scraper in the InfluxDB user interface (UI).
|
||||
|
||||
{{% note %}}
|
||||
Scraper **Target URLs** and **BUCKETS** can not be updated.
|
||||
To modify either, [create a new scraper](/v2.0/collect-data/scrape-data/manage-scrapers/create-a-scraper).
|
||||
{{% /note %}}
|
||||
|
||||
## Update a scraper in the InfluxDB UI
|
||||
1. Click **Organizations** in the left navigation menu.
|
||||
|
||||
{{< img-hd src="/img/organizations-icon.png" />}}
|
||||
|
||||
2. In the list of organizations, click the name of your organization.
|
||||
3. Click the **Scrapers** tab. A listing of any existing scrapers appears with the
|
||||
**Name**, **URL**, and **BUCKET** for each scraper.
|
||||
4. Hover over the scraper you would like to update and click the edit icon (pencil)
|
||||
that appears next to the scrape name.
|
||||
5. Enter a new name for the scraper. Hit return or click out of the name field to save the change.
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: Create scrapable endpoints
|
||||
seotitle: Create scrapable endpoints for InfluxDB
|
||||
description: placeholder
|
||||
menu:
|
||||
v2_0:
|
||||
parent: Scrape data
|
||||
weight: 202
|
||||
v2.0/tags: [scraper]
|
||||
---
|
||||
|
||||
InfluxDB scrapers can collect data from any HTTP/S-accessible endpoint, provided the returned data
|
||||
is in the [Prometheus data format](https://prometheus.io/docs/instrumenting/exposition_formats/).
|
||||
The links below provide information about the Prometheus data format as well
|
||||
as tools and clients that will generate Prometheus-formatted metrics for you.
|
||||
|
||||
## Prometheus Node Exporter
|
||||
The [Prometheus Node Exporter](https://github.com/prometheus/node_exporter) exposes
|
||||
a wide variety of hardware- and kernel-related metrics for **\*nix** systems.
|
||||
|
||||
##### Helpful links
|
||||
[Monitoring linux host metrics with the Node Exporter](https://prometheus.io/docs/guides/node-exporter/)
|
||||
|
||||
## Prometheus exporters and integrations
|
||||
[Prometheus exporters and integrations](https://prometheus.io/docs/instrumenting/exporters/)
|
||||
export Prometheus metrics from third-party systems or services.
|
||||
|
||||
##### Helpful links
|
||||
[List of third-party exporters](https://prometheus.io/docs/instrumenting/exporters/#third-party-exporters)
|
||||
[Write a custom Prometheus exporter](https://prometheus.io/docs/instrumenting/writing_exporters/)
|
||||
|
||||
## Prometheus client libraries
|
||||
[Prometheus client libraries](https://prometheus.io/docs/instrumenting/clientlibs/)
|
||||
instrument applications for each of their respective languages.
|
||||
Application metrics are output to an HTTP/S endpoint from which they can be scraped.
|
||||
|
||||
##### Helpful links
|
||||
[Instrumenting a Go application for Prometheus](https://prometheus.io/docs/guides/go-application/)
|
||||
[Write Prometheus client libraries](https://prometheus.io/docs/instrumenting/writing_clientlibs/)
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
---
|
||||
title: Create a scraper
|
||||
weight: 102
|
||||
seotitle: Create a scraper
|
||||
description: >
|
||||
Use the InfluxDB UI to configure a scraper for collecting metrics from InfluxDB instances or third-party systems.
|
||||
v2.0/tags: [scraper]
|
||||
menu:
|
||||
v2_0:
|
||||
name: Create a scraper
|
||||
parent: Collect data
|
||||
---
|
||||
|
||||
An InfluxDB scraper collects data from specified targets at regular intervals and then writes the scraped data to a bucket. Scrapers can collect data from available data sources as long as the data is in the [Prometheus data format](https://prometheus.io/docs/instrumenting/exposition_formats/), which is supported by InfluxDB.
|
||||
|
||||
To quickly create a scraper in InfluxDB 2.0, you can use the InfluxDB 2.0 user interface (UI) to specify the target URL and the bucket to store the data. The scraped data is collected in the Prometheus data format and then transformed to match the InfluxDB data structure in the buckets.
|
||||
|
||||
## Use the InfluxDB UI to create a scraper
|
||||
|
||||
Follow the steps below to configure an InfluxDB scraper. The steps below use the InfluxDB
|
||||
`/metrics` HTTP endpoint as an example. This endpoint provides InfluxDB-specific metrics in the Prometheus data format.
|
||||
|
||||
1. Open a web browser to access the InfluxDB 2.0 user interface
|
||||
([localhost:9999](http://localhost:9999)). The **Getting started with InfluxDB 2.0** screen appears.
|
||||
2. In the navigation bar on the left, click **Organizations** and then click the name of your organization. The **Organization** page appears for the selected organization.
|
||||
3. Click the **Scrapers** tab. A listing of any existing scrapers appears, listing the **URL** and the **BUCKET** name.
|
||||
4. Click **Create Scraper**. The **Data Loading** page appears with **Add Scraper Target** options to define a scraper.
|
||||
5. From the **Bucket** listing, select the bucket for collecting the data.
|
||||
6. Enter the **Target URL** to use for the Prometheus `/metrics` HTTP endpoint. The default URL value is `http://localhost:9999/metrics`.
|
||||
7. Click **Finish**. Your new scraper appears in the scraper listing, displaying the values you specified for the **URL** and the **BUCKET**.
|
||||
|
||||
The new scraper is now collecting data into the InfluxDB bucket you specified.
|
||||
|
||||
## Next steps
|
||||
|
||||
Now that you have data ready to be explored, you can:
|
||||
|
||||
* **Query data.** To get started querying the data stored in InfluxDB buckets using the InfluxDB user interface (UI) and the `influx` command line interface (CLI), see [Query data in InfluxDB](/v2.0/query-data).
|
||||
|
||||
* **Process data.** To learn about creating tasks for processing and analyzing data, see [Process data with InfluxDB tasks](/v2.0/process-data)
|
||||
|
||||
* **Visualize data.** To learn how to build dashboards for visualizing your data, see [Visualize data with the InfluxDB UI](/v2.0/visualize-data).
|
||||
Loading…
Reference in New Issue