From f7403d938fba006f7f89e2a4bba3ca7fc8fe9bf9 Mon Sep 17 00:00:00 2001 From: stevebang Date: Sun, 27 Jan 2019 23:23:05 -0800 Subject: [PATCH] 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/).