Add revised pages for scraper and telegraf config

pull/35/head
stevebang 2019-02-06 01:47:44 -08:00
parent 1f070d056d
commit 43e983290d
2 changed files with 33 additions and 52 deletions

View File

@ -1,11 +1,11 @@
---
title: Collect metrics using Telegraf
seotitle: Create a Telegraf configuration to collect system metrics
title: Create a Telegraf configuration
seotitle: Create a Telegraf configuration
description: >
Create a Telegraf configuration to collect system metrics
Use the InfluxDB UI to create Telegraf configurations for collecting metrics data
menu:
v2_0:
name : Collect metrics using Telegraf
name : Create a Telegraf configuration
parent: Collect data
weight: 2
---
@ -17,56 +17,36 @@ menu:
* All plugins are not currently supported. Check back for additional plugin support!
* If you have a Telegraf agent (v. 1.8 or later) running, you can enable the InfluxDB v2 output plugin to "dual land" data using both your existing InfluxDB 1.x and InfluxDB 2.0 instances.
## Configure a Telegraf connection to use the System Telegraf plugins
## Create a Telegraf configuration
Follow the steps below to configure your Telegraf plugins and connection for
collecting system statistics.
Follow the steps below to use the InfluxDB UI to create a Telegraf configuration for collecting time series data.
1. Open a web browser to your InfluxDB 2.0 instance [localhost:9999](http://localhost:9999).
The login screen for the UI (user interface) appears.
2. Log in using your username and password. The **Getting started with InfluxDB 2.0** screen appears.
3. Click **Configure a Data Collector**. A new dialog appears with the **Telegraf** selected.
4. Click **Create Configuration**. The **Data Loading** page appears with the heading **Select Telegraf Plugins to add to your bucket**.
5. Select your predefined **Bucket**, click the **System** option, and then
click **Continue**. A page with **Plugins to Configure** appears.
6. Review the list of **Plugins to Configure**. Click **Continue** repeatedly to cycle through
information on each of the System plugins and then continue to the next step. Alternatively, click **Skip to Verify** to immediately proceed to the next step.
7. On the **Listen for Telegraf Data** page, follow the three listed steps to install Telegraf,
configure your API Token, and start Telegraf on your local instance.
8. Verify that you correctly completed these steps by clicking **Listen for Data** (if you don't
see this, scroll down the internal frame). A "Connection Found!" message appears.
9. After verifying your new connection, click **Finish**. Your configuration name
1. Open a web browser to access the InfluxDB 2.0 user interface
([localhost:9999](http://localhost:9999)). The login screen appears.
2. Log in using your username and password. The **Getting started with InfluxDB 2.0** screen appears.
3. To access the **Telegraf Configurations** page, you can 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.
4. Click **Create Configuration**. The **Data Loading** page appears with the heading "Select Telegraf Plugins to add to your bucket."
5. 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.
6. Review the list of **Plugins to Configure** for any configuration requirements.
* Plugins listed with a green checks in front require no additional configuration steps.
* 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.
7. 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.
8. 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.
9. Click **Finish**. Your configuration name
and the associated bucket name appears in the list of Telegraf connections.
After configuring your Telegraf plugins and connection, you can create a dashboard
that displays your system statistics.
You have configured Telegraf plugins that can collect data and add them to your InfluxDB buckets.
## Create a dashboard to display system statistics
## Next steps
The steps below will guide you to creating a dashboard and adding a cell that
displays a system measurement that your InfluxDB 2.0 server instance is now collecting.
Now that you have a bucket of data ready for exploration, you can:
1. Click **Dashboards** in the navigation bar on the left. You should see the
**Dashboards** page that lists any existing dashboards.
2. Click **Create Dashboard**. A new dashboard appears.
3. Click **Name this Dashboard** and enter a name (for example, "System Stats").
4. Click **Add Cell**. A new page appears to define a cell to appear in your
new dashboard.
5. Click **Name this Cell** and enter a cell name (for example, "Maximum CPU Usage").
6. In the lower left, select the bucket that is collecting your system statistics.
Under **_measurement**, a listing of available measurements appears.
7. Click **cpu**. A new **_field** listing appears.
8. Scroll down the list and select **usage_system**. A new **cpu** listing appears.
9. In the **cpu** listing, select **cpu-total**.
10. In the **AGGREGATE FUNCTIONS** listing on the right, select **max**.
11. Click **Submit**, located above **AGGREGATE FUNCTIONS**. A line graph displaying
recently collected data appears.
12. To finish adding the cell, click the green box with a check symbol (located in the
upper right of the page). Your new dashboard with one cell now appears.
* **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).
You have now created a dashboard with one cell displaying a system measurement based on
data collected using the Telegraf plugins and connection that you configured. You can
continue to explore the new time series data being collected in your bucket by creating
new cells and trying out different visualizations and cell displays.
For more information on creating InfluxDB 2.0 dashboards, see [Visualize data with InfluxDB](http://v2.dpcs.influxdata.com/v2.0/visualize-data/).
* **Visualize data.** To learn how to build dashboards for visualizing your data, see [Visualize data with the InfluxDB UI](/v2.0/visualize-data).

View File

@ -17,10 +17,11 @@ To quickly create a scraper in InfluxDB 2.0, you can use the InfluxDB 2.0 user i
## Use the InfluxDB UI to configure a scraper for data collection
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 that uses an
`/metrics` HTTP endpoint for collecting metrics and loading the scraped data into a bucket.
1. Open a web browser to your InfluxDB 2.0 instance
([localhost:9999](http://localhost:9999)). The login screen for the UI (user interface) appears.
1. Open a web browser to access the InfluxDB 2.0 user interface
([localhost:9999](http://localhost:9999)). The login screen appears.
2. Log in using your username and password. The **Getting started with InfluxDB 2.0** screen appears.
3. 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.
4. Click the **Scrapers** tab. A listing of any existing scrapers appears, listing the **URL** and the **BUCKET** name.