Merge pull request #1161 from influxdata/monitor-guides

add monitor with templates
2020-08-18 09:36:28 -07:00 · 2020-08-18 09:36:28 -07:00 · b7b63d6657
parent 6aeaf9618c a690fbf38c
commit b7b63d6657
5 changed files with 144 additions and 5 deletions
--- a/content/v2.0/monitor-alert/_index.md
+++ b/content/v2.0/monitor-alert/_index.md
@ -3,7 +3,7 @@ title: Monitor data and send alerts
 seotitle: Monitor data and send alerts
 description: >
  Monitor your time series data and send alerts by creating checks, notification
-  rules, and notification endpoints.
+  rules, and notification endpoints. Or use community templates to monitor supported environments.
 menu:
  v2_0:
    name: Monitor & alert
@ -12,9 +12,9 @@ v2.0/tags: [monitor, alert, checks, notification, endpoints]
 ---

 Monitor your time series data and send alerts by creating checks, notification
-rules, and notification endpoints.
+rules, and notification endpoints. Or use [community templates to monitor](/v2.0/monitor-alert/templates/) supported environments.

-## The monitoring workflow
+## Overview

 1.  A [check](/v2.0/reference/glossary/#check) in InfluxDB queries data and assigns a status with a `_level` based on specific conditions.
 2.  InfluxDB stores the output of a check in the `statuses` measurement in the `_monitoring` system bucket.
@ -23,7 +23,8 @@ rules, and notification endpoints.
    to a [notification endpoint](/v2.0/reference/glossary/#notification-endpoint).
 4.  InfluxDB stores notifications in the `notifications` measurement in the `_monitoring` system bucket.

-## Monitor your data
+## Create an alert
+
 To get started, do the following:

 1.  [Create checks](/v2.0/monitor-alert/checks/create/) to monitor data and assign a status.
@ -32,7 +33,6 @@ To get started, do the following:
 3.  [Create notification rules](/v2.0/monitor-alert/notification-rules/create) to check
    statuses and send notifications to your notifications endpoints.

-
 ## Manage your monitoring and alerting pipeline

 {{< children >}}
--- a/content/v2.0/monitor-alert/templates/_index.md
+++ b/content/v2.0/monitor-alert/templates/_index.md
@ -0,0 +1,14 @@
+---
+title: Monitor with templates
+description: >
+  Use community templates to monitor data in many supported environments. Monitor infrastructure, networking, IoT, software, security, TICK stack, and more.
+menu:
+  v2_0:
+    parent: Monitor & alert
+weight: 104
+v2.0/tags: [monitor, templates]
+---
+
+Use one of our community templates to quickly set up InfluxDB (with a bucket and dashboard) to collect, analyze, and monitor data in supported environments.
+
+{{< children >}}
--- a/content/v2.0/monitor-alert/templates/infrastructure/_index.md
+++ b/content/v2.0/monitor-alert/templates/infrastructure/_index.md
@ -0,0 +1,14 @@
+---
+title: Monitor infrastructure
+description: >
+  Use one of our community templates to quickly set up InfluxDB (with a bucket and dashboard) to collect, analyze, and monitor your infrastructure.
+menu:
+  v2_0:
+    parent: Monitor with templates
+weight: 104
+v2.0/tags: [monitor, templates, infrastructure]
+---
+
+Use one of our community templates to quickly set up InfluxDB (with a bucket and dashboard) to collect, analyze, and monitor your infrastructure.
+
+{{< children >}}
--- a/content/v2.0/monitor-alert/templates/infrastructure/aws.md
+++ b/content/v2.0/monitor-alert/templates/infrastructure/aws.md
@ -0,0 +1,57 @@
+---
+title: Monitor Amazon Web Services (AWS)
+description: >
+  Use the AWS CloudWatch Monitoring template to monitor data from Amazon Web Services (AWS), Amazon Elastic Compute Cloud (EC2), and Amazon Elastic Load Balancing (ELB) with the AWS CloudWatch Service.
+menu:
+  v2_0:
+    parent: Monitor infrastructure
+    name: AWS CloudWatch
+weight: 201
+---
+
+Use the [AWS CloudWatch Monitoring template](https://github.com/influxdata/community-templates/tree/master/aws_cloudwatch) to monitor data from [Amazon Web Services (AWS)](https://aws.amazon.com/), [Amazon Elastic Compute Cloud (EC2)](https://aws.amazon.com/ec2/), and [Amazon Elastic Load Balancing (ELB)](https://aws.amazon.com/elasticloadbalancing/) with the [AWS CloudWatch Service](https://aws.amazon.com/cloudwatch/).
+
+The AWS CloudWatch Monitoring template includes the following:
+
+- two [dashboards](/v2.0/reference/glossary/#dashboard):
+  - **AWS CloudWatch NLB (Network Load Balancers) Monitoring**: Displays data from the `cloudwatch_aws_network_elb measurement`
+  - **AWS CloudWatch Instance Monitoring**: Displays data from the `cloudwatch_aws_ec2` measurement
+- two [buckets](/v2.0/reference/glossary/#bucket): `kubernetes` and `cloudwatch`
+- two labels: `inputs.cloudwatch`, `AWS`
+- one variable: `v.bucket`
+- one [Telegraf configuration](/v2.0/write-data/no-code/use-telegraf/auto-config/view-telegraf-config/): [AWS CloudWatch input plugin](/v2.0/reference/telegraf-plugins/#cloudwatch)
+
+## Apply the template
+
+1. Use the [`influx` CLI](/v2.0/reference/cli/influx/) to run the following command:
+
+    ```sh
+    influx apply -f https://raw.githubusercontent.com/influxdata/community-templates/master/aws_cloudwatch/aws_cloudwatch.yml
+    ```
+    For more information, see [influx apply](/v2.0/reference/cli/influx/apply/).
+2. [Install Telegraf](/telegraf/latest/introduction/installation/) on a server with network access to both the CloudWatch API and [InfluxDB v2 API](/v2.0/reference/api/).
+3. In your Telegraf configuration file (`telegraf.conf`), find the following example `influxdb_v2` output plugins, and then **replace** the `urls` to specify the servers to monitor:
+
+   ```sh
+    ## k8s
+    [[outputs.influxdb_v2]]
+     urls = ["http://influxdb.monitoring:9999"]
+     organization = "InfluxData"
+     bucket = "kubernetes"
+     token = "secret-token"
+ 
+    ## cloudv2 sample
+    [[outputs.influxdb_v2]]
+     urls = ["$INFLUX_HOST"]
+     token = "$INFLUX_TOKEN"
+     organization = "$INFLUX_ORG"
+     bucket = “cloudwatch"
+   ```
+4. [Start Telegraf](/v2.0/write-data/no-code/use-telegraf/auto-config/#start-telegraf).
+
+## View the incoming data
+
+1. In the InfluxDB user interface (UI), select **Boards** (**Dashboards**).
+
+    {{< nav-icon "dashboards" >}}
+2. Open your AWS dashboards, and then set the `v.bucket` variable to specify the bucket to query data from (`kubernetes` or `cloudwatch`).
--- a/content/v2.0/monitor-alert/templates/infrastructure/docker.md
+++ b/content/v2.0/monitor-alert/templates/infrastructure/docker.md
@ -0,0 +1,54 @@
+---
+title: Monitor Docker
+description: >
+  Use the [Docker Monitoring template](https://https://github.com/influxdata/community-templates/tree/master/docker) to monitor your Docker containers.
+menu:
+  v2_0:
+    parent: Monitor infrastructure
+    name: Docker
+weight: 202
+---
+
+Use the [Docker Monitoring template](https://github.com/influxdata/community-templates/tree/master/docker) to monitor your Docker containers. First, [apply the template](#apply-the-template), and then [view incoming data](#view-incoming-data).
+This template uses the [Docker input plugin](/v2.0/reference/telegraf-plugins/#docker) to collect metrics stored in InfluxDB and display these metrics in a dashboard.
+
+The Docker Monitoring template includes the following:
+
+- one [dashboard](/v2.0/reference/glossary/#dashboard): **Docker**
+- one [bucket](/v2.0/reference/glossary/#bucket): `docker, 7d retention`
+- labels: Docker input plugin labels
+- one [Telegraf configuration](/v2.0/write-data/no-code/use-telegraf/auto-config/view-telegraf-config/): Docker input plugin
+- one variable: `bucket`
+- four [checks](/v2.0/reference/glossary/#check): `Container cpu`, `mem`, `disk`, `non-zero exit`
+- one [notification endpoint](v2.0/reference/glossary/#notification-endpoint): `Http Post`
+- one [notification rule](/v2.0/reference/glossary/#notification-rule): `Crit Alert`
+
+For more information about how checks, notification endpoints, and notifications rules work together, see [monitor data and send alerts](/v2.0/monitor-alert/).
+
+## Apply the template
+
+1. Use the [`influx` CLI](/v2.0/reference/cli/influx/) to run the following command:
+
+    ```sh
+    influx apply -f hhttps://raw.githubusercontent.com/influxdata/community-templates/master/docker/docker.yml
+    ```
+    For more information, see [influx apply](/v2.0/reference/cli/influx/apply/).
+
+    > **Note:** Ensure your `influx` CLI is configured with your account credentials and that configuration is active. For more information, see [influx config](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/).
+
+2. [Install Telegraf](/telegraf/latest/introduction/installation/) on a server with network access to both the Docker containers and [InfluxDB v2 API](/v2.0/reference/api/).
+3. In your [Telegraf configuration file (`telegraf.conf`)](/v2.0/write-data/no-code/use-telegraf/auto-config/view-telegraf-config/), do the following:
+    - Depending on how you run Docker, you may need to customize the [Docker input plugin](/v2.0/reference/telegraf-plugins/#docker) configuration, for example, you may need to specify the `endpoint` value.
+    - Set the following environment variables:
+      - INFLUX_TOKEN: Token must have permissions to read Telegraf configurations and write data to the `telegraf` bucket. See how to [view tokens](/v2.0/security/tokens/view-tokens/).
+      - INFLUX_ORG: Name of your organization. See how to [view your organization](/v2.0/organizations/view-orgs/).
+      - INFLUX_HOST: Your InfluxDB host URL, for example, localhost, a remote instance, or InfluxDB Cloud.
+
+4. [Start Telegraf](/v2.0/write-data/no-code/use-telegraf/auto-config/#start-telegraf).
+
+## View incoming data
+
+1. In the InfluxDB user interface (UI), select **Boards** (**Dashboards**).
+
+    {{< nav-icon "dashboards" >}}
+2. Open the **Docker** dashboard to start monitoring.