From cf57236ffbd30f4f65e230776ffc27874a592be4 Mon Sep 17 00:00:00 2001 From: stevebang Date: Wed, 23 Jan 2019 21:48:06 -0800 Subject: [PATCH 01/19] new quickstart page for collecting data --- content/v2.0/collect-data/_index.md | 8 ++- content/v2.0/collect-data/quickstart.md | 68 +++++++++++++++++++++++++ 2 files changed, 75 insertions(+), 1 deletion(-) create mode 100644 content/v2.0/collect-data/quickstart.md diff --git a/content/v2.0/collect-data/_index.md b/content/v2.0/collect-data/_index.md index 03e26d701..65aade591 100644 --- a/content/v2.0/collect-data/_index.md +++ b/content/v2.0/collect-data/_index.md @@ -9,4 +9,10 @@ menu: weight: 2 --- -_More information about collecting data with InfluxDB v2.0 is coming shortly._ +**Note: More guides appearing shortly!** + +The following guides will give you a taste of how you can use the InfluxDB user +interface (UI) to collect data into InfluxDB 2.0 buckets and display the data +in dashboards. + +{{< children >}} diff --git a/content/v2.0/collect-data/quickstart.md b/content/v2.0/collect-data/quickstart.md new file mode 100644 index 000000000..c035b103f --- /dev/null +++ b/content/v2.0/collect-data/quickstart.md @@ -0,0 +1,68 @@ +--- +title: Quick start to collecting system metrics from InfluxDB 2.0 OSS +seotitle: Quick start to collecting data from InfluxDB 2.0 OSS +description: > + Use the InfluxDB 2.0 user interface to quickly configure Telegraf plugins and start monitoring system statistics. +menu: + v2_0: + name: Quick start to collect system metrics + parent: Collect data + weight: 1 +--- + +Follow the steps described here to quickly configure Telegraf plugins and to +start collecting system metrics from your InfluxDB 2.0 OSS instance. + + +## Configure a connection for available Telegraf plugins + +Follow the steps below to configure your Telegraf plugins and connection for +collecting system statistics. + +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. +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 plugins and then continue to the next step. Alternatively, click + **Skip to Verify** to proceed to the next step. +7. On the **Listen for Telegraf Data** page, follow the 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 + 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. + +## Create a dashboard to display system statistics + +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. + +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. + +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. From 80e2e888f20bc089d3323453f8dfc1cab225ab85 Mon Sep 17 00:00:00 2001 From: stevebang Date: Thu, 24 Jan 2019 00:39:47 -0800 Subject: [PATCH 02/19] Add new scraper page and update other content --- content/v2.0/collect-data/advanced.md | 11 +++++++++ content/v2.0/collect-data/quickstart.md | 9 ++++--- content/v2.0/collect-data/scraper.md | 33 +++++++++++++++++++++++++ 3 files changed, 49 insertions(+), 4 deletions(-) create mode 100644 content/v2.0/collect-data/advanced.md create mode 100644 content/v2.0/collect-data/scraper.md diff --git a/content/v2.0/collect-data/advanced.md b/content/v2.0/collect-data/advanced.md new file mode 100644 index 000000000..4be461cc4 --- /dev/null +++ b/content/v2.0/collect-data/advanced.md @@ -0,0 +1,11 @@ +--- +title: Configure Telegraf to collect data into InfluxDB 2.0 OSS +seotitle: Configure Telegraf to collect data into InfluxDB 2.0 OSS +description: > + Configure a Telegraf plugin to start collecting data from InfluxDB 2.0 OSS +menu: + v2_0: + name: Configure Telegraf to collect data + parent: Collect data + weight: 2 +--- diff --git a/content/v2.0/collect-data/quickstart.md b/content/v2.0/collect-data/quickstart.md index c035b103f..8087384f4 100644 --- a/content/v2.0/collect-data/quickstart.md +++ b/content/v2.0/collect-data/quickstart.md @@ -1,6 +1,6 @@ --- -title: Quick start to collecting system metrics from InfluxDB 2.0 OSS -seotitle: Quick start to collecting data from InfluxDB 2.0 OSS +title: Quick start to collecting system metrics from InfluxDB 2.0 +seotitle: Quick start to collecting data from InfluxDB 2.0 description: > Use the InfluxDB 2.0 user interface to quickly configure Telegraf plugins and start monitoring system statistics. menu: @@ -10,8 +10,7 @@ menu: weight: 1 --- -Follow the steps described here to quickly configure Telegraf plugins and to -start collecting system metrics from your InfluxDB 2.0 OSS instance. +Follow the steps described here to quickly configure Telegraf plugins and to start collecting system metrics from your InfluxDB 2.0 OSS instance. ## Configure a connection for available Telegraf plugins @@ -66,3 +65,5 @@ You have now created a dashboard with one cell displaying a system measurement b 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/). diff --git a/content/v2.0/collect-data/scraper.md b/content/v2.0/collect-data/scraper.md new file mode 100644 index 000000000..4c68d17c7 --- /dev/null +++ b/content/v2.0/collect-data/scraper.md @@ -0,0 +1,33 @@ +--- +title: Scrape Prometheus Node Exporter data +seotitle: Scrape Prometheus Node Exporter data +description: > + Use InfluxDB 2.0 with the Prometheus Node Exporter to scrape, store, and display data. +menu: + v2_0: + name: Scrape data using Prometheus node exporter + parent: Collect data + weight: 3 +--- + +The [Prometheus Node Exporter](https://github.com/prometheus/node_exporter#node-exporter) and supported collectors capture hardware and OS metrics from third-party systems and translate the data into the popular Prometheus format, which is supported by InfluxDB. You can easily configure Node Exporter-generated output to be scraped into an InfluxDB 2.0 bucket for monitoring in dashboards. + +After you have installed the Prometheus Node Exporter, follow the steps below to configure an InfluxDB 2.0 scraper to collect Node Exporter-generated data into an InfluxDB 2.0 bucket. + +## Configure an InfluxDB scraper for capturing Prometheus Node Explorer data + +Follow the steps here to capture Prometheus format data into an InfluxDB 2.0 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. +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 your organization. +4. Click the **Scrapers** tab. A listing of existing scrapers appears, listing the **URL** and the **BUCKET** name. +5. Click **Create Scraper**. The **Data Loading** page appears with a for to **Add Scraper Target**. +6. In the **Bucket** listing, select the bucket to be used for collecting data from the Prometheus Node Exporter. +7. Enter the **Target URL** for the Prometheus `/metrics` HTTP endpoint for the Node Explorer. The default URL value for Node Explorer is `http://localhost:9100/metrics`. +8. Click **Finish**. The new scraper for Node Explorer appears as a new row in the listing of scrapers and displays the values for the **URL** and the **BUCKET**. + +The new scraper for the Prometheus Node Exporter is now collecting data into the InfluxDB bucket you specified. + +For information on creating InfluxDB 2.0 dashboards that use the Node Exporter data, see [Visualize data with InfluxDB](http://v2.dpcs.influxdata.com/v2.0/visualize-data/). From f7403d938fba006f7f89e2a4bba3ca7fc8fe9bf9 Mon Sep 17 00:00:00 2001 From: stevebang Date: Sun, 27 Jan 2019 23:23:05 -0800 Subject: [PATCH 03/19] Rename and update files based on feedback --- .../{advanced.md => advanced-telegraf.md} | 8 +++ content/v2.0/collect-data/quickstart.md | 69 ------------------- .../v2.0/collect-data/scraper-quickstart.md | 33 +++++++++ content/v2.0/collect-data/scraper.md | 33 --------- 4 files changed, 41 insertions(+), 102 deletions(-) rename content/v2.0/collect-data/{advanced.md => advanced-telegraf.md} (50%) delete mode 100644 content/v2.0/collect-data/quickstart.md create mode 100644 content/v2.0/collect-data/scraper-quickstart.md delete mode 100644 content/v2.0/collect-data/scraper.md diff --git a/content/v2.0/collect-data/advanced.md b/content/v2.0/collect-data/advanced-telegraf.md similarity index 50% rename from content/v2.0/collect-data/advanced.md rename to content/v2.0/collect-data/advanced-telegraf.md index 4be461cc4..021ed4d61 100644 --- a/content/v2.0/collect-data/advanced.md +++ b/content/v2.0/collect-data/advanced-telegraf.md @@ -9,3 +9,11 @@ menu: parent: Collect data weight: 2 --- + + + +>**Note:** + +* Telegraf 1.9.x is required to use the https:// option with Telegraf. +* Currently, not all plugins are supported. +* If you are already have a Telegraf agent running, you can use v. 1.8 or later and add the InfluxDB v2 output plugin to "dual land" data into your existing InfluxDB 1.x and InfluxDB 2.0 instances. diff --git a/content/v2.0/collect-data/quickstart.md b/content/v2.0/collect-data/quickstart.md deleted file mode 100644 index 8087384f4..000000000 --- a/content/v2.0/collect-data/quickstart.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Quick start to collecting system metrics from InfluxDB 2.0 -seotitle: Quick start to collecting data from InfluxDB 2.0 -description: > - Use the InfluxDB 2.0 user interface to quickly configure Telegraf plugins and start monitoring system statistics. -menu: - v2_0: - name: Quick start to collect system metrics - parent: Collect data - weight: 1 ---- - -Follow the steps described here to quickly configure Telegraf plugins and to start collecting system metrics from your InfluxDB 2.0 OSS instance. - - -## Configure a connection for available Telegraf plugins - -Follow the steps below to configure your Telegraf plugins and connection for -collecting system statistics. - -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. -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 plugins and then continue to the next step. Alternatively, click - **Skip to Verify** to proceed to the next step. -7. On the **Listen for Telegraf Data** page, follow the 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 - 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. - -## Create a dashboard to display system statistics - -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. - -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. - -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/). diff --git a/content/v2.0/collect-data/scraper-quickstart.md b/content/v2.0/collect-data/scraper-quickstart.md new file mode 100644 index 000000000..00c011da5 --- /dev/null +++ b/content/v2.0/collect-data/scraper-quickstart.md @@ -0,0 +1,33 @@ +--- +title: Use a scraper to collect InfluxDB 2.0 metrics +seotitle: Use a scraper to collect InfluxDB 2.0 metrics +description: > + Use a scraper defined in the InfluxDB 2.0 UI to collect system statistics into a bucket. +menu: + v2_0: + name: Use a scraper to collect InfluxDB 2.0 metrics + parent: Collect data + weight: 1 +--- + +You can use the InfluxDB 2.0 user interface (UI) to quickly define a scraper that can capture hardware and OS metrics from third-party systems and translate the data into the popular Prometheus format, which is supported by InfluxDB. + +Follow the steps below to configure an InfluxDB 2.0 scraper to collect metrics generated by InfluxDB 2.0 into a bucket. + +## Configure an InfluxDB scraper to collect InfluxDB 2.0 metrics + +Follow the steps here to capture Prometheus format data into an InfluxDB 2.0 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. +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. +5. Click **Create Scraper**. The **Data Loading** page appears with **Add Scraper Target** options to define a scraper. +6. From the **Bucket** listing, select the bucket that you wan to be use to collect data. +7. Enter the **Target URL** to use for the Prometheus `/metrics` HTTP endpoint. The default URL value is `http://localhost:9100/metrics`. +8. Click **Finish**. The new scraper for Node Explorer appears as a new row in the listing of scrapers and displays the values for the **URL** and the **BUCKET**. + +The new scraper for the Prometheus Node Exporter is now collecting data into the InfluxDB bucket you specified. + +For information on creating InfluxDB 2.0 dashboards that use the Node Exporter data, see [Visualize data with InfluxDB](http://v2.dpcs.influxdata.com/v2.0/visualize-data/). diff --git a/content/v2.0/collect-data/scraper.md b/content/v2.0/collect-data/scraper.md deleted file mode 100644 index 4c68d17c7..000000000 --- a/content/v2.0/collect-data/scraper.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Scrape Prometheus Node Exporter data -seotitle: Scrape Prometheus Node Exporter data -description: > - Use InfluxDB 2.0 with the Prometheus Node Exporter to scrape, store, and display data. -menu: - v2_0: - name: Scrape data using Prometheus node exporter - parent: Collect data - weight: 3 ---- - -The [Prometheus Node Exporter](https://github.com/prometheus/node_exporter#node-exporter) and supported collectors capture hardware and OS metrics from third-party systems and translate the data into the popular Prometheus format, which is supported by InfluxDB. You can easily configure Node Exporter-generated output to be scraped into an InfluxDB 2.0 bucket for monitoring in dashboards. - -After you have installed the Prometheus Node Exporter, follow the steps below to configure an InfluxDB 2.0 scraper to collect Node Exporter-generated data into an InfluxDB 2.0 bucket. - -## Configure an InfluxDB scraper for capturing Prometheus Node Explorer data - -Follow the steps here to capture Prometheus format data into an InfluxDB 2.0 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. -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 your organization. -4. Click the **Scrapers** tab. A listing of existing scrapers appears, listing the **URL** and the **BUCKET** name. -5. Click **Create Scraper**. The **Data Loading** page appears with a for to **Add Scraper Target**. -6. In the **Bucket** listing, select the bucket to be used for collecting data from the Prometheus Node Exporter. -7. Enter the **Target URL** for the Prometheus `/metrics` HTTP endpoint for the Node Explorer. The default URL value for Node Explorer is `http://localhost:9100/metrics`. -8. Click **Finish**. The new scraper for Node Explorer appears as a new row in the listing of scrapers and displays the values for the **URL** and the **BUCKET**. - -The new scraper for the Prometheus Node Exporter is now collecting data into the InfluxDB bucket you specified. - -For information on creating InfluxDB 2.0 dashboards that use the Node Exporter data, see [Visualize data with InfluxDB](http://v2.dpcs.influxdata.com/v2.0/visualize-data/). From 5cdbaf85f0ee7b484fb58ebfc7e30f7fe25651a7 Mon Sep 17 00:00:00 2001 From: stevebang Date: Sun, 27 Jan 2019 23:26:24 -0800 Subject: [PATCH 04/19] Remove old files and update. --- .../v2.0/collect-data/advanced-telegraf.md | 58 +++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/content/v2.0/collect-data/advanced-telegraf.md b/content/v2.0/collect-data/advanced-telegraf.md index 021ed4d61..5904636cb 100644 --- a/content/v2.0/collect-data/advanced-telegraf.md +++ b/content/v2.0/collect-data/advanced-telegraf.md @@ -17,3 +17,61 @@ menu: * Telegraf 1.9.x is required to use the https:// option with Telegraf. * Currently, not all plugins are supported. * If you are already have a Telegraf agent running, you can use v. 1.8 or later and add the InfluxDB v2 output plugin to "dual land" data into your existing InfluxDB 1.x and InfluxDB 2.0 instances. + +Follow the steps described here to quickly configure Telegraf plugins and to start collecting system metrics from your InfluxDB 2.0 OSS instance. + + +## Configure a connection for available Telegraf plugins + +Follow the steps below to configure your Telegraf plugins and connection for +collecting system statistics. + +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. +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 plugins and then continue to the next step. Alternatively, click + **Skip to Verify** to proceed to the next step. +7. On the **Listen for Telegraf Data** page, follow the 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 + 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. + +## Create a dashboard to display system statistics + +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. + +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. + +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/). From 9f7c7fa46851d2ff11d8f699a3e9b1add534fa2c Mon Sep 17 00:00:00 2001 From: stevebang Date: Sun, 27 Jan 2019 23:46:11 -0800 Subject: [PATCH 05/19] Update Telegraf config steps --- .../v2.0/collect-data/advanced-telegraf.md | 29 ++++++++----------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/content/v2.0/collect-data/advanced-telegraf.md b/content/v2.0/collect-data/advanced-telegraf.md index 5904636cb..e7263461e 100644 --- a/content/v2.0/collect-data/advanced-telegraf.md +++ b/content/v2.0/collect-data/advanced-telegraf.md @@ -1,27 +1,23 @@ --- -title: Configure Telegraf to collect data into InfluxDB 2.0 OSS -seotitle: Configure Telegraf to collect data into InfluxDB 2.0 OSS +title: Create a Telegraf configuration to collect system metrics +seotitle: Create a Telegraf configuration to collect system metrics description: > - Configure a Telegraf plugin to start collecting data from InfluxDB 2.0 OSS + Create a Telegraf configuration to collect system metrics menu: v2_0: - name: Configure Telegraf to collect data + name : Create a Telegraf configuration to collect system metrics parent: Collect data weight: 2 --- - - >**Note:** -* Telegraf 1.9.x is required to use the https:// option with Telegraf. -* Currently, not all plugins are supported. -* If you are already have a Telegraf agent running, you can use v. 1.8 or later and add the InfluxDB v2 output plugin to "dual land" data into your existing InfluxDB 1.x and InfluxDB 2.0 instances. +* Telegraf 1.9.2 or later must be used +* Telegraf 1.9.x is required to use the `https://` option. +* 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. -Follow the steps described here to quickly configure Telegraf plugins and to start collecting system metrics from your InfluxDB 2.0 OSS instance. - - -## Configure a connection for available Telegraf plugins +## Configure a Telegraf connection to use the System Telegraf plugins Follow the steps below to configure your Telegraf plugins and connection for collecting system statistics. @@ -30,13 +26,12 @@ collecting system statistics. 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. +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 plugins and then continue to the next step. Alternatively, click - **Skip to Verify** to proceed to the next step. -7. On the **Listen for Telegraf Data** page, follow the steps to install Telegraf, + 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. From 4fe166e56d772fbc4c55e153ed742bff13ccf08e Mon Sep 17 00:00:00 2001 From: stevebang Date: Tue, 5 Feb 2019 12:43:25 -0800 Subject: [PATCH 06/19] update pages --- content/v2.0/collect-data/_index.md | 4 +-- .../v2.0/collect-data/advanced-telegraf.md | 4 +-- .../v2.0/collect-data/scraper-quickstart.md | 6 ++-- content/v2.0/collect-data/scraper-scraping.md | 35 +++++++++++++++++++ 4 files changed, 42 insertions(+), 7 deletions(-) create mode 100644 content/v2.0/collect-data/scraper-scraping.md diff --git a/content/v2.0/collect-data/_index.md b/content/v2.0/collect-data/_index.md index 65aade591..1edb765a9 100644 --- a/content/v2.0/collect-data/_index.md +++ b/content/v2.0/collect-data/_index.md @@ -1,5 +1,5 @@ --- -title: Collect data with InfluxDB +title: Collect data with InfluxDB 2.0 description: > InfluxDB provides multiple ways to collect time series data including using Telegraf, using InfluxDB's built-in data scraper, and using line protocol. @@ -9,8 +9,6 @@ menu: weight: 2 --- -**Note: More guides appearing shortly!** - The following guides will give you a taste of how you can use the InfluxDB user interface (UI) to collect data into InfluxDB 2.0 buckets and display the data in dashboards. diff --git a/content/v2.0/collect-data/advanced-telegraf.md b/content/v2.0/collect-data/advanced-telegraf.md index e7263461e..c214293cb 100644 --- a/content/v2.0/collect-data/advanced-telegraf.md +++ b/content/v2.0/collect-data/advanced-telegraf.md @@ -1,11 +1,11 @@ --- -title: Create a Telegraf configuration to collect system metrics +title: Collect metrics using Telegraf seotitle: Create a Telegraf configuration to collect system metrics description: > Create a Telegraf configuration to collect system metrics menu: v2_0: - name : Create a Telegraf configuration to collect system metrics + name : Collect metrics using Telegraf parent: Collect data weight: 2 --- diff --git a/content/v2.0/collect-data/scraper-quickstart.md b/content/v2.0/collect-data/scraper-quickstart.md index 00c011da5..c3c09404d 100644 --- a/content/v2.0/collect-data/scraper-quickstart.md +++ b/content/v2.0/collect-data/scraper-quickstart.md @@ -26,8 +26,10 @@ Follow the steps here to capture Prometheus format data into an InfluxDB 2.0 buc 5. Click **Create Scraper**. The **Data Loading** page appears with **Add Scraper Target** options to define a scraper. 6. From the **Bucket** listing, select the bucket that you wan to be use to collect data. 7. Enter the **Target URL** to use for the Prometheus `/metrics` HTTP endpoint. The default URL value is `http://localhost:9100/metrics`. -8. Click **Finish**. The new scraper for Node Explorer appears as a new row in the listing of scrapers and displays the values for the **URL** and the **BUCKET**. +8. Click **Finish**. Your new scraper appears in the scraper listing, displaying the values you specified for the **URL** and the **BUCKET**. -The new scraper for the Prometheus Node Exporter is now collecting data into the InfluxDB bucket you specified. +The new scraper for is now collecting data into the InfluxDB bucket you specified. For information on creating InfluxDB 2.0 dashboards that use the Node Exporter data, see [Visualize data with InfluxDB](http://v2.dpcs.influxdata.com/v2.0/visualize-data/). + +To learn more about diff --git a/content/v2.0/collect-data/scraper-scraping.md b/content/v2.0/collect-data/scraper-scraping.md new file mode 100644 index 000000000..c8d80ec93 --- /dev/null +++ b/content/v2.0/collect-data/scraper-scraping.md @@ -0,0 +1,35 @@ +--- +title: Scrape data using the /metrics endpoint +seotitle: Scrape data using the /metrics endpoint +description: > + Scrape data into an InfluxDB bucket. +menu: + v2_0: + name: Scrape data using the /metrics endpoint + parent: Collect data + weight: 1 +--- + +You can use the InfluxDB 2.0 user interface (UI) to quickly define a scraper that can capture hardware and OS metrics from third-party systems and translate the data into the popular Prometheus format, which is supported by InfluxDB. + +Follow the steps below to configure an InfluxDB 2.0 scraper to collect metrics generated by InfluxDB 2.0 into a bucket. + +## Configure an InfluxDB scraper to collect InfluxDB 2.0 metrics + +Follow the steps here to capture Prometheus format data into an InfluxDB 2.0 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. +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. +5. Click **Create Scraper**. The **Data Loading** page appears with **Add Scraper Target** options to define a scraper. +6. From the **Bucket** listing, select the bucket that you wan to be use to collect data. +7. Enter the **Target URL** to use for the Prometheus `/metrics` HTTP endpoint. The default URL value is `http://localhost:9100/metrics`. +8. Click **Finish**. Your new scraper appears in the scraper listing, displaying the values you specified for the **URL** and the **BUCKET**. + +The new scraper for is now collecting data into the InfluxDB bucket you specified. + +For information on creating InfluxDB 2.0 dashboards that use the Node Exporter data, see [Visualize data with InfluxDB](http://v2.dpcs.influxdata.com/v2.0/visualize-data/). + +To learn more about From 309e2a9789e27738ed57718dfe09fc694cbac08d Mon Sep 17 00:00:00 2001 From: stevebang Date: Tue, 5 Feb 2019 22:54:58 -0800 Subject: [PATCH 07/19] New version of quick start page --- .../v2.0/collect-data/scraper-quickstart.md | 53 ++++++++++++------- 1 file changed, 33 insertions(+), 20 deletions(-) diff --git a/content/v2.0/collect-data/scraper-quickstart.md b/content/v2.0/collect-data/scraper-quickstart.md index c3c09404d..0b3cb3b08 100644 --- a/content/v2.0/collect-data/scraper-quickstart.md +++ b/content/v2.0/collect-data/scraper-quickstart.md @@ -1,35 +1,48 @@ --- -title: Use a scraper to collect InfluxDB 2.0 metrics -seotitle: Use a scraper to collect InfluxDB 2.0 metrics +title: Quick start to data collection +seotitle: Quick start to data collection description: > - Use a scraper defined in the InfluxDB 2.0 UI to collect system statistics into a bucket. + Use Quick Start to create a scraper to collect InfluxDB metrics into a bucket. menu: v2_0: - name: Use a scraper to collect InfluxDB 2.0 metrics + name: Quick start to data collection parent: Collect data weight: 1 --- -You can use the InfluxDB 2.0 user interface (UI) to quickly define a scraper that can capture hardware and OS metrics from third-party systems and translate the data into the popular Prometheus format, which is supported by InfluxDB. +>**Note:** The steps below only apply during your initial configuration and usage of your InfluxDB 2.0 instance. The page described below is not available after clicking one of the three options. For steps on configuring a scraper yourself, see [Scrape data using the /metrics endpoint](influxdb/v2.0/scraper-endpoint/). -Follow the steps below to configure an InfluxDB 2.0 scraper to collect metrics generated by InfluxDB 2.0 into a bucket. +## Use **Quick Start** to collect InfluxDB metrics -## Configure an InfluxDB scraper to collect InfluxDB 2.0 metrics +When you start InfluxDB 2.0 for the first time, you are guided to configure a user, organization, and a bucket. +After you complete this initial configuration, the next page includes "Let's start collecting data!" and three options. +This page guides you on using the **Quick Start** option. -Follow the steps here to capture Prometheus format data into an InfluxDB 2.0 bucket. +On the page that includes "Let's start collecting data!" and three options, click **Quick Start**. The following message appears in a popup alert: -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. 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. -5. Click **Create Scraper**. The **Data Loading** page appears with **Add Scraper Target** options to define a scraper. -6. From the **Bucket** listing, select the bucket that you wan to be use to collect data. -7. Enter the **Target URL** to use for the Prometheus `/metrics` HTTP endpoint. The default URL value is `http://localhost:9100/metrics`. -8. Click **Finish**. Your new scraper appears in the scraper listing, displaying the values you specified for the **URL** and the **BUCKET**. +`The InfluxDB Scraper has been configured for http://localhost:9999/metrics.` -The new scraper for is now collecting data into the InfluxDB bucket you specified. +Behind the scenes, here's what happened: -For information on creating InfluxDB 2.0 dashboards that use the Node Exporter data, see [Visualize data with InfluxDB](http://v2.dpcs.influxdata.com/v2.0/visualize-data/). +* 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 you named on the previous page. +* The InfluxDB Scraper immediately started collecting InfluxDB data and + writing it into your bucket. -To learn more about +To see a sample of the data being collected in Prometheus format, you can use one of the following methods to display a sample of the exposed InfluxDB metrics in the Prometheus text-based format: + +* Open the InfluxDB Scraper URL (http://localhost:9999/metrics) in a web browser. A sample of the data appears in a text file, with the data in the Prometheus format. + +* 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: + +* **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). + +* **Visualize data.** To learn how to build dashboards for visualizing your data, see [Visualize data with the InfluxDB UI](/v2.0/visualize-data). From 48a9f3a7064385d56ce89022746cb262b137bc2c Mon Sep 17 00:00:00 2001 From: stevebang Date: Tue, 5 Feb 2019 23:50:55 -0800 Subject: [PATCH 08/19] Edit quick start page --- .../v2.0/collect-data/scraper-quickstart.md | 25 +++++++++++-------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/content/v2.0/collect-data/scraper-quickstart.md b/content/v2.0/collect-data/scraper-quickstart.md index 0b3cb3b08..be621e121 100644 --- a/content/v2.0/collect-data/scraper-quickstart.md +++ b/content/v2.0/collect-data/scraper-quickstart.md @@ -10,31 +10,34 @@ menu: weight: 1 --- ->**Note:** The steps below only apply during your initial configuration and usage of your InfluxDB 2.0 instance. The page described below is not available after clicking one of the three options. For steps on configuring a scraper yourself, see [Scrape data using the /metrics endpoint](influxdb/v2.0/scraper-endpoint/). +>**Note:** The steps below are available on a page that appears after you complete the initial configuration described in [Set up InfluxDB](/v2.0/get-started/#setup-influxdb). After clicking one of the three options, the page is no longer available. +> +>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 -When you start InfluxDB 2.0 for the first time, you are guided to configure a user, organization, and a bucket. -After you complete this initial configuration, the next page includes "Let's start collecting data!" and three options. -This page guides you on using the **Quick Start** option. +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 the page that includes "Let's start collecting data!" and three options, click **Quick Start**. The following message appears in a popup alert: +On this page, click **Quick Start**. +The following message appears in a popup alert: `The InfluxDB Scraper has been configured for http://localhost:9999/metrics.` Behind the scenes, here's what happened: -* InfluxDB 2.0 configured a scraper named "InfluxDB Scraper" - - The target URL points to the `/metrics` HTTP endpoint of your +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 you named on the previous page. -* The InfluxDB Scraper immediately started collecting InfluxDB data and + * 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). + +2. The InfluxDB Scraper immediately started collecting InfluxDB data and writing it into your bucket. To see a sample of the data being collected in Prometheus format, you can use one of the following methods to display a sample of the exposed InfluxDB metrics in the Prometheus text-based format: -* Open the InfluxDB Scraper URL (http://localhost:9999/metrics) in a web browser. A sample of the data appears in a text file, with the data in the Prometheus format. +* 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`. From 1d568f797d625963915af82d57db0a50d06845f9 Mon Sep 17 00:00:00 2001 From: stevebang Date: Wed, 6 Feb 2019 00:28:01 -0800 Subject: [PATCH 09/19] Add new page on configuring scrapers --- content/v2.0/collect-data/scraper-scraping.md | 27 +++++++++++-------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/content/v2.0/collect-data/scraper-scraping.md b/content/v2.0/collect-data/scraper-scraping.md index c8d80ec93..bff5142ec 100644 --- a/content/v2.0/collect-data/scraper-scraping.md +++ b/content/v2.0/collect-data/scraper-scraping.md @@ -2,7 +2,7 @@ title: Scrape data using the /metrics endpoint seotitle: Scrape data using the /metrics endpoint description: > - Scrape data into an InfluxDB bucket. + Configure a scraper to collect data into an InfluxDB bucket. menu: v2_0: name: Scrape data using the /metrics endpoint @@ -10,26 +10,31 @@ menu: weight: 1 --- -You can use the InfluxDB 2.0 user interface (UI) to quickly define a scraper that can capture hardware and OS metrics from third-party systems and translate the data into the popular Prometheus format, 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 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. -Follow the steps below to configure an InfluxDB 2.0 scraper to collect metrics generated by InfluxDB 2.0 into a bucket. +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. -## Configure an InfluxDB scraper to collect InfluxDB 2.0 metrics +## Use the InfluxDB UI to configure a scraper for data collection -Follow the steps here to capture Prometheus format data into an InfluxDB 2.0 bucket. +Follow the steps below to configure an InfluxDB scraper for collecting metrics 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. + ([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. 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. 5. Click **Create Scraper**. The **Data Loading** page appears with **Add Scraper Target** options to define a scraper. -6. From the **Bucket** listing, select the bucket that you wan to be use to collect data. -7. Enter the **Target URL** to use for the Prometheus `/metrics` HTTP endpoint. The default URL value is `http://localhost:9100/metrics`. +6. From the **Bucket** listing, select the bucket for collecting the data. +7. Enter the **Target URL** to use for the Prometheus `/metrics` HTTP endpoint. The default URL value is `http://localhost:9999/metrics`. 8. Click **Finish**. Your new scraper appears in the scraper listing, displaying the values you specified for the **URL** and the **BUCKET**. -The new scraper for is now collecting data into the InfluxDB bucket you specified. +The new scraper is now collecting data into the InfluxDB bucket you specified. -For information on creating InfluxDB 2.0 dashboards that use the Node Exporter data, see [Visualize data with InfluxDB](http://v2.dpcs.influxdata.com/v2.0/visualize-data/). +## Next steps -To learn more about +Now that you have a bucket of 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). + +* **Visualize data.** To learn how to build dashboards for visualizing your data, see [Visualize data with the InfluxDB UI](/v2.0/visualize-data). From 1f070d056d0e17f4408f512bc992e5f4702b0303 Mon Sep 17 00:00:00 2001 From: stevebang Date: Wed, 6 Feb 2019 00:34:11 -0800 Subject: [PATCH 10/19] Tweak scraper content and rename file --- .../{scraper-scraping.md => scraper-metrics-endpoint.md} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename content/v2.0/collect-data/{scraper-scraping.md => scraper-metrics-endpoint.md} (89%) diff --git a/content/v2.0/collect-data/scraper-scraping.md b/content/v2.0/collect-data/scraper-metrics-endpoint.md similarity index 89% rename from content/v2.0/collect-data/scraper-scraping.md rename to content/v2.0/collect-data/scraper-metrics-endpoint.md index bff5142ec..2202519bd 100644 --- a/content/v2.0/collect-data/scraper-scraping.md +++ b/content/v2.0/collect-data/scraper-metrics-endpoint.md @@ -2,7 +2,7 @@ title: Scrape data using the /metrics endpoint seotitle: Scrape data using the /metrics endpoint description: > - Configure a scraper to collect data into an InfluxDB bucket. + Use the InfluxDB UI to configure a scraper with a /metrics endpoint for collecting metrics from InfluxDB instances or third-party systems. menu: v2_0: name: Scrape data using the /metrics endpoint @@ -17,7 +17,7 @@ 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 for collecting metrics 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. From 43e983290dded455233aaca07a65cde28be45482 Mon Sep 17 00:00:00 2001 From: stevebang Date: Wed, 6 Feb 2019 01:47:44 -0800 Subject: [PATCH 11/19] Add revised pages for scraper and telegraf config --- .../v2.0/collect-data/advanced-telegraf.md | 78 +++++++------------ .../collect-data/scraper-metrics-endpoint.md | 7 +- 2 files changed, 33 insertions(+), 52 deletions(-) diff --git a/content/v2.0/collect-data/advanced-telegraf.md b/content/v2.0/collect-data/advanced-telegraf.md index c214293cb..b73ac15d9 100644 --- a/content/v2.0/collect-data/advanced-telegraf.md +++ b/content/v2.0/collect-data/advanced-telegraf.md @@ -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). diff --git a/content/v2.0/collect-data/scraper-metrics-endpoint.md b/content/v2.0/collect-data/scraper-metrics-endpoint.md index 2202519bd..25d45274e 100644 --- a/content/v2.0/collect-data/scraper-metrics-endpoint.md +++ b/content/v2.0/collect-data/scraper-metrics-endpoint.md @@ -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. From 19135d691bfece8428aeef4a7a4747ba2f2c95c4 Mon Sep 17 00:00:00 2001 From: stevebang Date: Wed, 6 Feb 2019 01:52:17 -0800 Subject: [PATCH 12/19] Add next step for processing datata --- content/v2.0/collect-data/advanced-telegraf.md | 2 ++ content/v2.0/collect-data/scraper-metrics-endpoint.md | 2 ++ content/v2.0/collect-data/scraper-quickstart.md | 2 ++ 3 files changed, 6 insertions(+) diff --git a/content/v2.0/collect-data/advanced-telegraf.md b/content/v2.0/collect-data/advanced-telegraf.md index b73ac15d9..72955a3a6 100644 --- a/content/v2.0/collect-data/advanced-telegraf.md +++ b/content/v2.0/collect-data/advanced-telegraf.md @@ -49,4 +49,6 @@ Now that you have a bucket of 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). +* **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). diff --git a/content/v2.0/collect-data/scraper-metrics-endpoint.md b/content/v2.0/collect-data/scraper-metrics-endpoint.md index 25d45274e..0a2664242 100644 --- a/content/v2.0/collect-data/scraper-metrics-endpoint.md +++ b/content/v2.0/collect-data/scraper-metrics-endpoint.md @@ -38,4 +38,6 @@ Now that you have a bucket of 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). +* **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). diff --git a/content/v2.0/collect-data/scraper-quickstart.md b/content/v2.0/collect-data/scraper-quickstart.md index be621e121..3dbdb0fbc 100644 --- a/content/v2.0/collect-data/scraper-quickstart.md +++ b/content/v2.0/collect-data/scraper-quickstart.md @@ -48,4 +48,6 @@ Now that you have a bucket of 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). +* **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). From 4ea3a1b2d150187006321485f4af139d32b43a9d Mon Sep 17 00:00:00 2001 From: stevebang Date: Wed, 6 Feb 2019 02:04:19 -0800 Subject: [PATCH 13/19] Modify note about supporte plugins --- content/v2.0/collect-data/advanced-telegraf.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/v2.0/collect-data/advanced-telegraf.md b/content/v2.0/collect-data/advanced-telegraf.md index 72955a3a6..076f047be 100644 --- a/content/v2.0/collect-data/advanced-telegraf.md +++ b/content/v2.0/collect-data/advanced-telegraf.md @@ -14,7 +14,7 @@ menu: * Telegraf 1.9.2 or later must be used * Telegraf 1.9.x is required to use the `https://` option. -* All plugins are not currently supported. Check back for additional plugin support! +* All Telegraf plugins are supported, but only a subset are configurable using the InfluxDB UI. * 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. ## Create a Telegraf configuration From b96a9523e76099f4b406af3e82017961c5d47032 Mon Sep 17 00:00:00 2001 From: stevebang Date: Wed, 6 Feb 2019 10:04:11 -0800 Subject: [PATCH 14/19] Changes based on feedback --- content/v2.0/collect-data/advanced-telegraf.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/v2.0/collect-data/advanced-telegraf.md b/content/v2.0/collect-data/advanced-telegraf.md index 076f047be..8d0848ef3 100644 --- a/content/v2.0/collect-data/advanced-telegraf.md +++ b/content/v2.0/collect-data/advanced-telegraf.md @@ -2,7 +2,7 @@ title: Create a Telegraf configuration seotitle: Create a Telegraf configuration description: > - Use the InfluxDB UI to create Telegraf configurations for collecting metrics data + Use the InfluxDB UI to create Telegraf configurations for collecting metrics data. menu: v2_0: name : Create a Telegraf configuration @@ -10,12 +10,12 @@ menu: weight: 2 --- ->**Note:** - +{{% note %}} * Telegraf 1.9.2 or later must be used * Telegraf 1.9.x is required to use the `https://` option. * All Telegraf plugins are supported, but only a subset are configurable using the InfluxDB UI. * 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. +{{% /note %}} ## Create a Telegraf configuration From 29e4879ba3a4e708457f56a869ee01506816c023 Mon Sep 17 00:00:00 2001 From: stevebang Date: Wed, 6 Feb 2019 10:09:07 -0800 Subject: [PATCH 15/19] update based on feedback --- content/v2.0/collect-data/advanced-telegraf.md | 17 ++++++++--------- .../collect-data/scraper-metrics-endpoint.md | 15 +++++++-------- 2 files changed, 15 insertions(+), 17 deletions(-) diff --git a/content/v2.0/collect-data/advanced-telegraf.md b/content/v2.0/collect-data/advanced-telegraf.md index 8d0848ef3..812dbee95 100644 --- a/content/v2.0/collect-data/advanced-telegraf.md +++ b/content/v2.0/collect-data/advanced-telegraf.md @@ -22,23 +22,22 @@ menu: 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 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: + ([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: * 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. +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. +5. 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 +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. +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. You have configured Telegraf plugins that can collect data and add them to your InfluxDB buckets. diff --git a/content/v2.0/collect-data/scraper-metrics-endpoint.md b/content/v2.0/collect-data/scraper-metrics-endpoint.md index 0a2664242..1d7c9d457 100644 --- a/content/v2.0/collect-data/scraper-metrics-endpoint.md +++ b/content/v2.0/collect-data/scraper-metrics-endpoint.md @@ -21,14 +21,13 @@ 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 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. -5. Click **Create Scraper**. The **Data Loading** page appears with **Add Scraper Target** options to define a scraper. -6. From the **Bucket** listing, select the bucket for collecting the data. -7. Enter the **Target URL** to use for the Prometheus `/metrics` HTTP endpoint. The default URL value is `http://localhost:9999/metrics`. -8. Click **Finish**. Your new scraper appears in the scraper listing, displaying the values you specified for the **URL** and the **BUCKET**. + ([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. From c1d4da329c8d3a5714ec930cef3d2f0bb174b947 Mon Sep 17 00:00:00 2001 From: stevebang Date: Wed, 6 Feb 2019 14:35:09 -0800 Subject: [PATCH 16/19] Move weight and update to new numbering --- content/v2.0/collect-data/_index.md | 2 +- content/v2.0/collect-data/advanced-telegraf.md | 3 ++- content/v2.0/collect-data/scraper-metrics-endpoint.md | 2 +- content/v2.0/collect-data/scraper-quickstart.md | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/content/v2.0/collect-data/_index.md b/content/v2.0/collect-data/_index.md index 1edb765a9..e72630784 100644 --- a/content/v2.0/collect-data/_index.md +++ b/content/v2.0/collect-data/_index.md @@ -1,12 +1,12 @@ --- title: Collect data with InfluxDB 2.0 +weight: 2 description: > InfluxDB provides multiple ways to collect time series data including using Telegraf, using InfluxDB's built-in data scraper, and using line protocol. menu: v2_0: name: Collect data - weight: 2 --- The following guides will give you a taste of how you can use the InfluxDB user diff --git a/content/v2.0/collect-data/advanced-telegraf.md b/content/v2.0/collect-data/advanced-telegraf.md index 812dbee95..89beabd1a 100644 --- a/content/v2.0/collect-data/advanced-telegraf.md +++ b/content/v2.0/collect-data/advanced-telegraf.md @@ -1,5 +1,6 @@ --- title: Create a Telegraf configuration +weight: 103 seotitle: Create a Telegraf configuration description: > Use the InfluxDB UI to create Telegraf configurations for collecting metrics data. @@ -7,7 +8,7 @@ menu: v2_0: name : Create a Telegraf configuration parent: Collect data - weight: 2 + --- {{% note %}} diff --git a/content/v2.0/collect-data/scraper-metrics-endpoint.md b/content/v2.0/collect-data/scraper-metrics-endpoint.md index 1d7c9d457..a2f758271 100644 --- a/content/v2.0/collect-data/scraper-metrics-endpoint.md +++ b/content/v2.0/collect-data/scraper-metrics-endpoint.md @@ -1,5 +1,6 @@ --- title: Scrape data using the /metrics endpoint +weight: 102 seotitle: Scrape data using the /metrics endpoint description: > Use the InfluxDB UI to configure a scraper with a /metrics endpoint for collecting metrics from InfluxDB instances or third-party systems. @@ -7,7 +8,6 @@ menu: v2_0: name: Scrape data using the /metrics endpoint parent: Collect data - weight: 1 --- 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 diff --git a/content/v2.0/collect-data/scraper-quickstart.md b/content/v2.0/collect-data/scraper-quickstart.md index 3dbdb0fbc..fdcd4f9a2 100644 --- a/content/v2.0/collect-data/scraper-quickstart.md +++ b/content/v2.0/collect-data/scraper-quickstart.md @@ -1,5 +1,6 @@ --- title: Quick start to data collection +weight: 101 seotitle: Quick start to data collection description: > Use Quick Start to create a scraper to collect InfluxDB metrics into a bucket. @@ -7,7 +8,6 @@ menu: v2_0: name: Quick start to data collection parent: Collect data - weight: 1 --- >**Note:** The steps below are available on a page that appears after you complete the initial configuration described in [Set up InfluxDB](/v2.0/get-started/#setup-influxdb). After clicking one of the three options, the page is no longer available. From d6f6b406a534a7d6372dbe2bb8cc91b9311887af Mon Sep 17 00:00:00 2001 From: stevebang Date: Wed, 6 Feb 2019 15:48:03 -0800 Subject: [PATCH 17/19] Updates based on feedback --- .../v2.0/collect-data/advanced-telegraf.md | 18 +++++++++++----- .../collect-data/scraper-metrics-endpoint.md | 21 +++++++++---------- .../v2.0/collect-data/scraper-quickstart.md | 21 ++++++++++--------- 3 files changed, 34 insertions(+), 26 deletions(-) diff --git a/content/v2.0/collect-data/advanced-telegraf.md b/content/v2.0/collect-data/advanced-telegraf.md index 89beabd1a..8b0a66a99 100644 --- a/content/v2.0/collect-data/advanced-telegraf.md +++ b/content/v2.0/collect-data/advanced-telegraf.md @@ -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). diff --git a/content/v2.0/collect-data/scraper-metrics-endpoint.md b/content/v2.0/collect-data/scraper-metrics-endpoint.md index a2f758271..1346dcec7 100644 --- a/content/v2.0/collect-data/scraper-metrics-endpoint.md +++ b/content/v2.0/collect-data/scraper-metrics-endpoint.md @@ -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). diff --git a/content/v2.0/collect-data/scraper-quickstart.md b/content/v2.0/collect-data/scraper-quickstart.md index fdcd4f9a2..4cdfb4bc0 100644 --- a/content/v2.0/collect-data/scraper-quickstart.md +++ b/content/v2.0/collect-data/scraper-quickstart.md @@ -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). From a98f57ed1b6f2c564ccf1ea11585245da1a934ae Mon Sep 17 00:00:00 2001 From: stevebang Date: Wed, 6 Feb 2019 15:50:32 -0800 Subject: [PATCH 18/19] Fix two issues --- content/v2.0/collect-data/scraper-quickstart.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/content/v2.0/collect-data/scraper-quickstart.md b/content/v2.0/collect-data/scraper-quickstart.md index 4cdfb4bc0..3e1860c6a 100644 --- a/content/v2.0/collect-data/scraper-quickstart.md +++ b/content/v2.0/collect-data/scraper-quickstart.md @@ -10,9 +10,11 @@ menu: parent: Collect data --- ->**Note:** The steps below are available on a page that appears after you complete the initial configuration described in [Set up InfluxDB](/v2.0/get-started/#setup-influxdb). After clicking one of the three options, the page is no longer available. +{{% note %}} +The steps below are available on a page that appears after you complete the initial configuration described in [Set up InfluxDB](/v2.0/get-started/#setup-influxdb). After clicking one of the three options, the page is no longer available. > >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/). +{{% note %}} ## Use Quick Start to collect InfluxDB metrics @@ -40,7 +42,7 @@ To see a sample of the data being collected in Prometheus format, you can use on * In a terminal window, run the following cURL command: ``` -curl http://localhost:9999/metrics`. +curl http://localhost:9999/metrics ``` ## Next steps From d632b4257f0fd162ea75a0eb59d5dd269cdd876d Mon Sep 17 00:00:00 2001 From: stevebang Date: Wed, 6 Feb 2019 15:57:14 -0800 Subject: [PATCH 19/19] Fix block note --- content/v2.0/collect-data/scraper-quickstart.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/v2.0/collect-data/scraper-quickstart.md b/content/v2.0/collect-data/scraper-quickstart.md index 3e1860c6a..01e550015 100644 --- a/content/v2.0/collect-data/scraper-quickstart.md +++ b/content/v2.0/collect-data/scraper-quickstart.md @@ -12,9 +12,9 @@ menu: {{% note %}} The steps below are available on a page that appears after you complete the initial configuration described in [Set up InfluxDB](/v2.0/get-started/#setup-influxdb). After clicking one of the three options, the page is no longer available. -> ->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/). -{{% note %}} + +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/). +{{% /note %}} ## Use Quick Start to collect InfluxDB metrics