Updates based on feedback
parent
c1d4da329c
commit
d6f6b406a5
|
|
@ -24,11 +24,8 @@ Follow the steps below to use the InfluxDB UI to create a Telegraf configuration
|
|||
|
||||
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. To access the **Telegraf Configurations** page, you can use either of the following two paths:
|
||||
2. To access the **Telegraf Configurations** page, use either of the following two paths:
|
||||
* Click **Organizations** in the navigation bar on the far left of the page, click on an organization, and then click the **Telegraf** tab.
|
||||
|
||||
OR
|
||||
|
||||
* Click **Configure a Data Collector** and then select the **Telegraf** tab.
|
||||
3. Click **Create Configuration**. The **Data Loading** page appears with the heading "Select Telegraf Plugins to add to your bucket."
|
||||
4. Select your predefined **Bucket**, select one or more of the available options (**System**, **Docker**, **Kubernetes**, **NGINX**, or **Redis**), and then click **Continue**. A page with **Plugins to Configure** appears.
|
||||
|
|
@ -37,6 +34,17 @@ Follow the steps below to use the InfluxDB UI to create a Telegraf configuration
|
|||
* To configure a plugin or access plugin documentation, click the plugin name.
|
||||
* Click **Continue** repeatedly to cycle through information on each of the plugins and then continue to the next step. Alternatively, you can click **Skip to Verify** to immediately proceed to the next step.
|
||||
6. On the **Listen for Telegraf Data** page, complete the three steps to install Telegraf, configure your API Token, and start Telegraf on your local instance.
|
||||
|
||||
1. Install the latest Telegraf version.
|
||||
* See the note above for specifics about supported versions.
|
||||
* The latest Telegraf version can be downloaded from the [InfluxData Downloads](https://portal.influxdata.com/downloads/) page.
|
||||
2. Configure your API token as an environment variable.
|
||||
* The API token grants Telegraf access to your InfluxDB 2.0 instance.
|
||||
* Copy the code from this page and run the code on your terminal window to set an environment variable with your token.
|
||||
3. Start the Telegraf service
|
||||
* Copy the code from this page and run it in a terminal window.
|
||||
* When you start Telegraf with the `-config` flag provided, Telegraf will download the configuration file generated by InfluxDB 2.0 and start Telegraf using that configuration file.
|
||||
|
||||
7. Verify that you have correctly completed the steps by clicking **Listen for Data** (if you don't see this button, scroll down the internal frame or create a larger browser window). A **Connection Found!** message appears.
|
||||
8. Click **Finish**. Your configuration name
|
||||
and the associated bucket name appears in the list of Telegraf connections.
|
||||
|
|
@ -45,7 +53,7 @@ You have configured Telegraf plugins that can collect data and add them to your
|
|||
|
||||
## Next steps
|
||||
|
||||
Now that you have a bucket of data ready for exploration, you can:
|
||||
Now that you have data ready for exploration, 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).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,24 +1,23 @@
|
|||
---
|
||||
title: Scrape data using the /metrics endpoint
|
||||
title: Create a scraper
|
||||
weight: 102
|
||||
seotitle: Scrape data using the /metrics endpoint
|
||||
seotitle: Create a scraper
|
||||
description: >
|
||||
Use the InfluxDB UI to configure a scraper with a /metrics endpoint for collecting metrics from InfluxDB instances or third-party systems.
|
||||
Use the InfluxDB UI to configure a scraper for collecting metrics from InfluxDB instances or third-party systems.
|
||||
menu:
|
||||
v2_0:
|
||||
name: Scrape data using the /metrics endpoint
|
||||
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 capture hardware and OS metrics from third-party systems or even from InfluxDB instances. In InfluxDB 2.0, the metrics are scraped from
|
||||
`/metrics` HTTP endpoints, in the [Prometheus data format](https://prometheus.io/docs/instrumenting/exposition_formats/), which is supported by InfluxDB.
|
||||
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](https://prometheus.io/docs/instrumenting/exposition_formats/) and then transformed to match the InfluxDB data structure in the buckets.
|
||||
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 configure a scraper for data collection
|
||||
## Use the InfluxDB UI to create a scraper
|
||||
|
||||
Follow the steps below to configure an InfluxDB scraper that uses an
|
||||
`/metrics` HTTP endpoint for collecting metrics and loading the scraped data into a bucket.
|
||||
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.
|
||||
|
|
@ -33,7 +32,7 @@ The new scraper is now collecting data into the InfluxDB bucket you specified.
|
|||
|
||||
## Next steps
|
||||
|
||||
Now that you have a bucket of data ready for exploration, you can:
|
||||
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).
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ description: >
|
|||
Use Quick Start to create a scraper to collect InfluxDB metrics into a bucket.
|
||||
menu:
|
||||
v2_0:
|
||||
name: Quick start to data collection
|
||||
name: Quick start
|
||||
parent: Collect data
|
||||
---
|
||||
|
||||
|
|
@ -14,23 +14,22 @@ menu:
|
|||
>
|
||||
>If you missed the change to select Quick Start or you want to learn how to configure a scraper yourself, see [Scrape data using the /metrics endpoint](influxdb/v2.0/collect-data/scraper-endpoint/).
|
||||
|
||||
## Use **Quick Start** to collect InfluxDB metrics
|
||||
## Use Quick Start to collect InfluxDB metrics
|
||||
|
||||
When you start InfluxDB 2.0 for the first time, you are guided to configure a user, an organization, and a bucket (see [Set up InfluxDB](/v2.0/get-started/#setup-influxdb)). After completing the setup, the next page displays "Let's start collecting data!" and three options.
|
||||
|
||||
On this page, click **Quick Start**.
|
||||
The following message appears in a popup alert:
|
||||
The following message briefly appears in a pop-up alert:
|
||||
|
||||
`The InfluxDB Scraper has been configured for http://localhost:9999/metrics.`
|
||||
"The InfluxDB Scraper has been configured for http://localhost:9999/metrics."
|
||||
|
||||
Behind the scenes, here's what happened:
|
||||
|
||||
1. InfluxDB 2.0 configured a scraper named "InfluxDB Scraper."
|
||||
|
||||
* The target URL points to the `/metrics` HTTP endpoint of your
|
||||
local InfluxDB instance: http://localhost:9999/metrics. The `/metrics` HTTP endpoint monitors your InfluxDB instance, collects metrics from it, and provides the data in the [Prometheus data format](https://prometheus.io/docs/instrumenting/exposition_formats/).
|
||||
* The bucket configured to collect the scraped data is the initial
|
||||
bucket that you named previously in [Set up InfluxDB](/v2.0/get-started/#setup-influxdb).
|
||||
local InfluxDB instance: `http://localhost:9999/metrics`. The `/metrics` HTTP endpoint monitors your InfluxDB instance, collects metrics from it, and provides the data in the [Prometheus data format](https://prometheus.io/docs/instrumenting/exposition_formats/).
|
||||
* InfluxDB stores the scraped data in the default bucket created in [the initial setup procedure](/v2.0/get-started/#setup-influxdb).
|
||||
|
||||
2. The InfluxDB Scraper immediately started collecting InfluxDB data and
|
||||
writing it into your bucket.
|
||||
|
|
@ -39,12 +38,14 @@ To see a sample of the data being collected in Prometheus format, you can use on
|
|||
|
||||
* In a web browser, open the InfluxDB Scraper URL (http://localhost:9999/metrics).
|
||||
|
||||
* In a terminal window, run the following cURL command: `curl http://localhost:9999/metrics`.
|
||||
|
||||
* In a terminal window, run the following cURL command:
|
||||
```
|
||||
curl http://localhost:9999/metrics`.
|
||||
```
|
||||
|
||||
## Next steps
|
||||
|
||||
Now that you have a bucket of data ready for exploration, you can:
|
||||
Now that you have data ready for exploration, 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).
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue