Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Create a new monitoring enterprise doc (#3078) 

* WIP edits for new monitoring enterprise doc.

* Split up monitoring and created new folder.

* attempting to fix mistakes.

* Duplicated the "monitor enterprise" page to cloud.

* Small edit.

* wip edits.

* testing the issue.

* Changing information so that it fits enterprise.

* small edit.

* Small edits to the monitoring enterprise docs.

* Added the step for insights and aware.

* Added username and password.

* misc edits.

* Creating influx enterprise doc and monitor w/ oss.

* Created new docs and drafted the overview doc.

* Update content/enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-enterprise.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Update content/enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-enterprise.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Update content/enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-with-cloud.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Update content/enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-with-cloud.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Update content/enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-with-cloud.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Update content/enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-with-cloud.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Update content/enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-with-cloud.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Update content/enterprise_influxdb/v1.9/administration/monitor-enterprise/overview.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Changed Cloud to OSS.

* WIP edit.

* WIP edits.

* Added info to larger monitor enterprise doc.

* Added more procedural info to logs.

* WIP edits.

* Misc edits, adding intro to log and trace

* WIP edits.

* Minor edits and insights and aware edits.

* Reworded InfluxDB aware/insights

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
pull/3189/head
mluu12 2021-09-28 23:10:48 -07:00 committed by GitHub
parent 27d79b05c9
commit 1b5de3f3b3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 827 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
content/enterprise_influxdb/v1.9/administration/monitor-enterprise/_index.md Normal file
View File

@ -0,0 +1,11 @@
---
title: Monitor InfluxDB Enterprise
description: Monitor InfluxDB Enterprise using templates, Cloud, or with QL.
menu:
enterprise_influxdb_1_9:
name: Monitor InfluxDB
parent: Administration
weight: 50
---
{{< children >}}

103
content/enterprise_influxdb/v1.9/administration/monitor-enterprise/logs.md Normal file
View File

@ -0,0 +1,103 @@
---
title: Log and trace InfluxDB Enterprise operations
description: >
Learn about logging locations, redirecting HTTP request logging, structured logging, and tracing.
menu:
enterprise_influxdb_1_9:
name: Log and trace
weight: 90
parent: Administration
---
Write log information to other locations, use different service managers, and use different log output formats.
InfluxDB writes log output, by default, to `stderr`.
Depending on your use case, you may opt to write this log information to another location.
User different service managers to override this default.
* [Write log output to log file](#write-log-output-to-log-file)
* [Write log output to flat file](#write-log-output-to-flat-file)
* [Redirect HTTP request logging](#redirect-http-access-logging)
* [Use structured logging](#use-structured-logging)
* [Use tracing](#use-tracing)
## Write log output to log file
To write log output to `stderr`, redirect `stderr` to a file:
```
influxdb-meta 2>$HOME/my_log_file # Meta nodes
influxd 2>$HOME/my_log_file # Data nodes
```
## Manage log output to flat files
You can use logrotate to rotate the log files generated by InfluxDB on systems where logs are written to flat files.
To use logrotate, create a configuration file that specify which logfiles to rotate. Learn more about logrotate and configuration files [here](http://manpages.ubuntu.com/manpages/cosmic/en/man8/logrotate.8.html).
### View logs with systemd
InfluxDB on systemd uses the system configured default for logging (usually `journald`).
To access the logs directed to the systemd journal, use this command:
```
sudo journalctl -u <node-type>.service
```
To view meta node logs, run `sudo journalctl -u influxdb-meta.service`.
To view data node logs, run `sudo journalctl -u influxdb.service`.
For more information about configuring `journald`, see [the systemd journald documentation]
## Redirect HTTP access logging
By default, when HTTP request logging is enabled, the HTTP logs are included with internal InfluxDB logging. To redirect the HTTP request log entries to a separate file so that the log files are easier to read, monitor, and debug, do the following:
1. Locate the `[http]` section of your InfluxDB configuration file.
2. Set the `access-log-path` option to specify the path where HTTP log entries should be written.
**Notes:**
* If `influxd` is unable to access the specified path, it will log an error and fall back to writing the request log to `stderr`.
* The `[httpd]` prefix is stripped when HTTP request logging is redirected to a separate file, allowing access log parsing tools (like [lnav](https://lnav.org)) to render the files without additional modification.
* To rotate the HTTP request log file, use the `copytruncate` method of `logrotate` or similar to leave the original file in place.
See [Redirecting HTTP request logging](/enterprise_influxdb/v1.8/administration/logs/#redirecting-http-access-logging) in the InfluxDB OSS documentation to learn more.
## Use structured logging
Structured logging enables machine-readable and more developer-friendly log output formats.
Use the `logfmt` and `json` structured log formats in InfluxDB Enterprise for easy filtering and searching with external tools and to simply integration of InfluxDB logs with Splunk, Papertrail, Elasticsearch, and other third party tools.
Use the following InfluxDB logging configuration options as needed:
* `format`: `auto` (default) | `logfmt` | `json`
* `level`: `error` | `warn` | `info` (default) | `debug`
* `suppress-logo`: `false` (default) | `true`
For details on these logging configuration options and their corresponding environment variables, see [Logging options](/influxdb/v1.8/administration/config#logging-settings).
## Use tracing
To trace InfluxDB operations to find errors and discover performance bottlenecks, use the following keys:
#### Tracing identifier key
The `trace_id` key specifies a unique identifier for a specific instance of a trace. Use this key to filter and correlate all related log entries for an operation.
All operation traces include consistent starting and ending log entries, with the same message (`msg`) describing the operation (e.g., "TSM compaction"), but adding the appropriate `op_event` context (either `start` or `end`).
For an example, see [Finding all trace log entries for an InfluxDB operation](/influxdb/v1.8/administration/logs/#finding-all-trace-log-entries-for-an-influxdb-operation).
**Example:** `trace_id=06R0P94G000`
#### Log identifier context key
Identify _every_ log entry with the log identifier key (`log_id`) for a single execution of an `influxd` process.
Although the log file can be split by a single execution, use the consistent `log_id` to search for log aggregation services.
For more information about tracing InfluxDB operations, see [here](/influxdb/v1.8/administration/logs/#tracing).

99
content/enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-enterprise.md Normal file
View File

@ -0,0 +1,99 @@
---
title: Monitor InfluxDB Enterprise
description: Troubleshoot and monitor InfluxDB Enterprise.
aliases:
- /enterprise_influxdb/v1.9/administration/statistics/
- /enterprise_influxdb/v1.9/troubleshooting/statistics/
- /enterprise_influxdb/v1.9/administration/server-monitoring/
menu:
enterprise_influxdb_1_9:
name: Monitor Enterprise
weight: 80
parent: Monitor InfluxDB
---
Monitoring is the act of proactively observing changes in data over time (for example: monitoring for an issue in advance). Alternatively, you can also monitor your data at a specific point in time (for example: when an issue happens).
There are multiple ways to monitor InfluxDB Enterprise.
If you want to monitor an InfluxDB Enterprise cluster over time, do one or more of the following:
* [Monitor InfluxDB Enterprise with Cloud](#monitor-influxdb-enterprise-with-cloud)
* [Monitor InfluxDB Enterprise with OSS](#monitor-influxdb-enterprise-with-oss)
* [Monitor InfluxDB Enterprise with internal monitoring](#monitor-influxdb-enterprise-with-internal-monitoring)
* [Monitor with InfluxDB Aware or Influx Insights](#monitor-with-influxdb-aware-or-influx-insights)
Alternitively, if you want to view your output data occasionally, do one of the following:
* [SHOW STATS](#show-stats)
* [SHOW DIAGNOSTICS](#show-diagnostics)
* [Log and trace InfluxDB Enterprise operations](#log-and-trace-influxdb-enterprise-operations)
### Monitor InfluxDB Enterprise with Cloud
To monitor InfluxDB Enterprise with Cloud, see [here](/enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-with-cloud/).
### Monitor InfluxDB Enterprise with OSS
To monitor InfluxDB Enterprise with OSS, see [here](/enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-with-oss/).
### Monitor InfluxDB Enterprise with internal monitoring
InfluxDB Enterprise data nodes can monitor by themselves. Learn more about [monitoring internally through dashboards](/platform/monitoring/influxdata-platform/monitoring-dashboards/).
{{% note %}}
Monitoring InfluxDB Enterprise through `_internal` is an option, but not recommended since no system should monitor itself.
{{% /note %}}
1. Make sure your Chronograf is installed and connected to an InfluxDB Enterprise cluster.
2. Do one of the following:
- [Use prebuilt monitoring dashboards](#use-prebuilt-monitoring-dashboards)
- [Import monitoring dashboards](#import-monitoring-dashboards)
#### Use prebuilt monitoring dashboards
Chronograf provides prebuilt monitoring dashboards. To use the prebuilt dashboards, do the following:
1. Open Chronograf and click **Host List** in the left-side navigation bar.
2. Click the monitoring dashboard link in the **Apps** column. The newly imported dashboard will appear in your list of dashboards.
#### Import monitoring dashboards
To use the InfluxDB Enterprise Monitor dashboard to monitor InfluxDB Enterprise in Chronograf, do the following:
1. Download the InfluxDB Enterprise Monitor dashboard.
<a class="btn download" href="/downloads/influxdb-enterprise-monitor-dashboard.json" download target="\_blank">Download InfluxDB Enterprise Monitor dashboard</a>
2. Import the dashboard to Chronograf.
{{% note %}}
A user must have an Admin or Editor role to import a dashboard.
{{% /note %}}
1. Click **Import Dashboard** in the Dashboards page in Chronograf.
2. Drag, or drop, or select the JSON export file to import.
3. Click **Upload Dashboard**. The newly imported dashboard will appear in your list of dashboards.
### Monitor with InfluxDB Aware or Influx Insights
To self-monitor InfluxDB Enterprise clusters, use InfluxDB Aware. In InfluxDB Aware, Telegraf runs on InfluxDB Enterprise nodes and sends information to a free Cloud account where you can see your metrics.
To have the support team monitor your InfluxDB Enterprise clusters, use Influx Insights. InfluxDB Telegraf runs on InfluxDB Enterprise nodes and sends information to the InfluxData Support team who monitors and alerts customers as needed.
To monitor with InfluxDB Aware or Influx Insights, do the following:
Contact [the InfluxData Support team](support@influxdata.com).
### SHOW STATS
For details on this query, see [`SHOW STATS`](/enterprise_influxdb/v1.9/query_language/spec#show-stats) in the InfluxQL specification.
Execute the query `SHOW STATS` in your terminal to see node statistics.
### SHOW DIAGNOSTICS
For details on this query, see [`SHOW DIAGNOSTICS`](/enterprise_influxdb/v1.9/query_language/spec#show-diagnostics) in the InfluxQL specification.
Excecute the query `SHOW DIAGNOSTICS` in your terminal to see node diagnostic information.
### Log and trace InfluxDB Enterprise operations
To log and trace InfluxDB Enterprise operations, see [here](/enterprise_influxdb/v1.9/administration/monitor/logs/).

183
content/enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-with-cloud.md Normal file
View File

@ -0,0 +1,183 @@
---
title: Monitor InfluxDB Enterprise using a template
description: >
Monitor your InfluxDB Enterprise instance using InfluxDB Cloud and
a pre-built InfluxDB template.
menu:
enterprise_influxdb_1_9:
parent: Monitor InfluxDB
name: Monitor with Cloud
weight: 102
---
Use [InfluxDB Cloud](/influxdb/cloud/), the [InfluxDB Enterprise 1.x Template](https://github.com/influxdata/community-templates/tree/master/influxdb-enterprise-1x), and Telegraf to monitor one or more InfluxDB Enterprise instances.
Do the following:
1. [Review requirements](#review-requirements)
2. [Install the InfluxDB Enterprise Monitoring template](#install-the-influxdb-enterprise-monitoring-template)
3. [Set up InfluxDB Enterprise for monitoring](#set-up-influxdb-enterprise-for-monitoring)
4. [Set up Telegraf](#set-up-telegraf)
5. [View the Monitoring dashboard](#view-the-monitoring-dashboard)
6. (Optional) [Alert when metrics stop reporting](#alert-when-metrics-stop-reporting)
7. (Optional) [Create a notification endpoint and rule](#create-a-notification-endpoint-and-rule)
8. (Optional) [Monitor with InfluxDB Insights and Aware](#monitor-with-influxdb-insights-and-aware)
## Review requirements
Before you begin, make sure you have access to the following:
- An InfluxDB Cloud account. ([Sign up for free here](https://cloud2.influxdata.com/signup)).
- Command line access to a machine [running InfluxDB Enterprise 1.x](/enterprise_influxdb/v1.9/introduction/install-and-deploy/) and permissions to install Telegraf on this machine.
- Internet connectivity from the machine running InfluxDB Enterprise 1.x and Telegraf to InfluxDB Cloud.
- Sufficient resource availability to install the template. (InfluxDB Cloud Free Plan accounts include [resource limits](/influxdb/cloud/account-management/pricing-plans/#resource-limits/influxdb/cloud/account-management/pricing-plans/#resource-limits).)
## Install the InfluxDB Enterprise Monitoring template
The InfluxDB Enterprise Monitoring template includes a Telegraf configuration that sends InfluxDB Enterprise metrics to an InfluxDB endpoint, and a dashboard that visualizes the metrics.
1. [Log into your InfluxDB Cloud account](https://cloud2.influxdata.com/), go to **Settings > Templates**, and enter the following template URL:
```
https://raw.githubusercontent.com/influxdata/community-templates/master/influxdb-enterprise-1x/enterprise.yml
```
2. Click **Lookup Template**, and then click **Install Template**. InfluxDB Cloud imports the template, which includes the following resources:
- Telegraf Configuration `monitoring-enterprise-1x`
- Dashboard `InfluxDB 1.x Enterprise`
- Label `enterprise`
- Variables `influxdb_host` and `bucket`
## Set up InfluxDB Enterprise for monitoring
By default, InfluxDB Enterprise 1.x has a `/metrics` endpoint available, which exports Prometheus-style system metrics.
1. Make sure the `/metrics` endpoint is [enabled](/{{< latest "influxdb" >}}/reference/config-options/#metrics-disabled). If you've changed the default settings to disable the `/metrics` endpoint, [re-enable these settings](/{{< latest "influxdb" >}}/reference/config-options/#metrics-disabled).
2. Navigate to the `/metrics` endpoint of your InfluxDB Enterprise instance to view the InfluxDB Enterprise system metrics in your browser:
```
http://localhost:8086/metrics
```
Or use `curl` to fetch metrics:
```sh
curl http://localhost:8086/metrics
# HELP boltdb_reads_total Total number of boltdb reads
# TYPE boltdb_reads_total counter
boltdb_reads_total 41
# HELP boltdb_writes_total Total number of boltdb writes
# TYPE boltdb_writes_total counter
boltdb_writes_total 28
# HELP go_gc_duration_seconds A summary of the pause duration of garbage collection cycles.
...
```
3. Add your **InfluxDB Cloud** account information (URL and organization) to your Telegraf configuration by doing the following:
1. Go to **Load Data > Telegraf** [in your InfluxDB Cloud account](https://cloud2.influxdata.com/), and click **InfluxDB Output Plugin** at the top-right corner.
2. Copy the `urls`, `token`, `organization`, and `bucket` and close the window.
3. Click **monitoring-enterprise-1.x**.
4. Replace `urls`, `token`, `organization`, and `bucket` under `outputs.influxdb_v2` with your InfluxDB Cloud account information. Alternatively, store this information in your environment variables and include the environment variables in your configuration.
{{% note %}}
To ensure the InfluxDB Enterprise monitoring dashboard can display the recorded metrics, set the destination bucket name to `enterprise_metrics` in your `telegraf.conf`.
{{% /note %}}
5. Add the [Prometheus input plugin](https://github.com/influxdata/telegraf/blob/release-1.19/plugins/inputs/prometheus/README.md) to your `telegraf.conf`. Specify your your InfluxDB Enterprise URL(s) in the `urls` parameter. For example:
{{< keep-url >}}
```toml
[[inputs.prometheus]]
urls = ["http://localhost:8086/metrics"]
username = "$INFLUX_USER"
password = "$INFLUX_PASSWORD"
```
If you're using unique URLs or have authentication set up for your `/metrics` endpoint, configure those options here and save the updated configuration.
For more information about customizing Telegraf, see [Configure Telegraf](/{{< latest "telegraf" >}}/administration/configuration/#global-tags).
4. Click **Save Changes**.
## Set up Telegraf
Set up Telegraf to scrape metrics from InfluxDB Enterprise to send to your InfluxDB Cloud account.
On each InfluxDB Enterprise instance you want to monitor, do the following:
1. Go to **Load Data > Telegraf** [in your InfluxDB Cloud account](https://cloud2.influxdata.com/).
2. Click **Setup Instructions** under **monitoring-enterprise-1.x**.
3. Complete the Telegraf Setup instructions. If you are using environment variables, set them up now.
{{% note %}}
For your API token, generate a new token or use an existing All Access token. If you run Telegraf as a service, edit your init script to set the environment variable and ensure that it's available to the service.
{{% /note %}}
Telegraf runs quietly in the background (no immediate output appears), and Telegraf begins pushing metrics to your InfluxDB Cloud account.
## View the Monitoring dashboard
To see your data in real time, view the Monitoring dashboard.
1. Select **Boards** (**Dashboards**) in your **InfluxDB Cloud** account.
{{< nav-icon "dashboards" >}}
2. Click **InfluxDB Enterprise Metrics**. Metrics appear in your dashboard.
3. Customize your monitoring dashboard as needed. For example, send an alert in the following cases:
- Users create a new task or bucket
- You're testing machine limits
- [Metrics stop reporting](#alert-when-metrics-stop-reporting)
## Alert when metrics stop reporting
The Monitoring template includes a [deadman check](/influxdb/cloud/monitor-alert/checks/create/#deadman-check) to verify metrics are reported at regular intervals.
To alert when data stops flowing from InfluxDB OSS instances to your InfluxDB Cloud account, do the following:
1. [Customize the deadman check](#customize-the-deadman-check) to identify the fields you want to monitor.
2. [Create a notification endpoint and rule](#create-a-notification-endpoint-and-rule) to receive notifications when your deadman check is triggered.
### Customize the deadman check
1. To view the deadman check, click **Alerts** in the navigation bar of your **InfluxDB Cloud** account.
{{< nav-icon "alerts" >}}
2. Choose a InfluxDB OSS field or create a new OSS field for your deadman alert:
1. Click **{{< icon "plus" >}} Create** and select **Deadman Check** in the dropown menu.
2. Define your query with at least one field.
3. Click **Submit** and **Configure Check**.
When metrics stop reporting, you'll receive an alert.
3. Start under **Schedule Every**, set the amount of time to check for data.
4. Set the amount of time to wait before switching to a critical alert.
5. Save the Check and click on **View History** of the Check under the gear icon to verify it is running.
## Create a notification endpoint and rule
To receive a notification message when your deadman check is triggered, create a [notification endpoint](#create-a-notification-endpoint) and [rule](#create-a-notification-rule).
### Create a notification endpoint
InfluxDB Cloud supports different endpoints: Slack, PagerDuty, and HTTP. Slack is free for all users, while PagerDuty and HTTP are exclusive to the Usage-Based Plan.
#### Send a notification to Slack
1. Create a [Slack Webhooks](https://api.slack.com/messaging/webhooks).
2. Go to **Alerts > Notification Endpoint** and click **{{< icon "plus" >}} Create**, and enter a name and description for your Slack endpoint.
3. Enter your Slack Webhook under **Incoming Webhook URL** and click **Create Notification Endpoint**.
#### Send a notification to PagerDuty or HTTP
Send a notification to PagerDuty or HTTP endpoints (other webhooks) by [upgrading your InfluxDB Cloud account](/influxdb/cloud/account-management/billing/#upgrade-to-usage-based-plan).
### Create a notification rule
[Create a notification rule](/influxdb/cloud/monitor-alert/notification-rules/create/) to set rules for when to send a deadman alert message to your notification endpoint.
1. Go to **Alerts > Notification Rules** and click **{{< icon "plus" >}} Create**.
2. Fill out the **About** and **Conditions** section then click **Create Notification Rule**.
## Monitor with InfluxDB Insights and Aware
For InfluxDB Enterprise customers, Insights and Aware are free services that can monitor your data. InfluxDB Insights sends your data to a private Cloud account and will be monitored with the help of the support team. InfluxDB Aware is a similar service, but you monitor your data yourself.
To apply for this service, please contact the [support team](support@influxdata.com).

177
content/enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-with-oss.md Normal file
View File

@ -0,0 +1,177 @@
---
title: Monitor InfluxDB Enterprise using OSS
description: >
Monitor your InfluxDB Enterprise instance using InfluxDB OSS and
a pre-built InfluxDB template.
menu:
enterprise_influxdb_1_9:
parent: Monitor InfluxDB
name: Monitor with OSS
weight: 102
---
Use [InfluxDB OSS](/influxdb/v2.0/), the [InfluxDB Enterprise 1.x Template](https://github.com/influxdata/community-templates/tree/master/influxdb-enterprise-1x), and Telegraf to monitor one or more InfluxDB Enterprise instances.
Do the following:
1. [Review requirements](#review-requirements)
2. [Install the InfluxDB Enterprise Monitoring template](#install-the-influxdb-enterprise-monitoring-template)
3. [Set up InfluxDB Enterprise for monitoring](#set-up-influxdb-enterprise-for-monitoring)
4. [Set up Telegraf](#set-up-telegraf)
5. [View the Monitoring dashboard](#view-the-monitoring-dashboard)
6. (Optional) [Alert when metrics stop reporting](#alert-when-metrics-stop-reporting)
7. (Optional) [Create a notification endpoint and rule](#create-a-notification-endpoint-and-rule)
8. (Optional) [Monitor with InfluxDB Insights and Aware](#monitor-with-influxdb-insights-and-aware)
## Review requirements
Before you begin, make sure you have access to the following:
- A self-hosted OSS 2.x instance. ([get started for free here](/influxdb/v2.0/get-started/))
- Command line access to a machine [running InfluxDB Enterprise 1.x](/enterprise_influxdb/v1.9/introduction/install-and-deploy/) and permissions to install Telegraf on this machine.
- Internet connectivity from the machine running InfluxDB Enterprise 1.x and Telegraf to InfluxDB OSS.
- Sufficient resource availability to install the template.
## Install the InfluxDB Enterprise Monitoring template
The InfluxDB Enterprise Monitoring template includes a Telegraf configuration that sends InfluxDB Enterprise metrics to an InfluxDB endpoint and a dashboard that visualizes the metrics.
1. [Log into your InfluxDB OSS UI](http://localhost:8086/signin), go to **Settings > Templates**, and enter the following template URL:
```
https://raw.githubusercontent.com/influxdata/community-templates/master/influxdb-enterprise-1x/enterprise.yml
```
2. Click **Lookup Template**, and then click **Install Template**. InfluxDB OSS imports the template, which includes the following resources:
- Telegraf Configuration `monitoring-enterprise-1x`
- Dashboard `InfluxDB 1.x Enterprise`
- Label `enterprise`
- Variables `influxdb_host` and `bucket`
## Set up InfluxDB Enterprise for monitoring
By default, InfluxDB Enterprise 1.x has a `/metrics` endpoint available, which exports Prometheus-style system metrics.
1. Make sure the `/metrics` endpoint is [enabled](/{{< latest "influxdb" >}}/reference/config-options/#metrics-disabled). If you've changed the default settings to disable the `/metrics` endpoint, [re-enable these settings](/{{< latest "influxdb" >}}/reference/config-options/#metrics-disabled).
2. Navigate to the `/metrics` endpoint of your InfluxDB Enterprise instance to view the InfluxDB Enterprise system metrics in your browser:
```
http://localhost:8086/metrics
```
Or use `curl` to fetch metrics:
```sh
curl http://localhost:8086/metrics
# HELP boltdb_reads_total Total number of boltdb reads
# TYPE boltdb_reads_total counter
boltdb_reads_total 41
# HELP boltdb_writes_total Total number of boltdb writes
# TYPE boltdb_writes_total counter
boltdb_writes_total 28
# HELP go_gc_duration_seconds A summary of the pause duration of garbage collection cycles.
...
```
3. Add your **InfluxDB OSS** account information (URL and organization) to your Telegraf configuration by doing the following:
1. Go to **Load Data > Telegraf** [in your InfluxDB OSS account](http://localhost:8086/), and click **InfluxDB Output Plugin** at the top-right corner.
2. Copy the `urls`, `token`, `organization`, and `bucket` and close the window.
3. Click **monitoring-enterprise-1.x**.
4. Replace `urls`, `token`, `organization`, and `bucket` under `outputs.influxdb_v2` with your InfluxDB OSS account information. Alternatively, store this information in your environment variables and include the environment variables in your configuration.
{{% note %}}
To ensure the InfluxDB Enterprise monitoring dashboard can display the recorded metrics, set the destination bucket name to `enterprise_metrics` in your `telegraf.conf`.
{{% /note %}}
5. Add the [Prometheus input plugin](https://github.com/influxdata/telegraf/blob/release-1.19/plugins/inputs/prometheus/README.md) to your `telegraf.conf`. Specify your your InfluxDB Enterprise URL(s) in the `urls` parameter. For example:
{{< keep-url >}}
```toml
[[inputs.prometheus]]
urls = ["http://localhost:8086/metrics"]
username = "$INFLUX_USER"
password = "$INFLUX_PASSWORD"
```
If you're using unique URLs or have security set up for your `/metrics` endpoint, configure those options here and save the updated configuration.
For more information about customizing Telegraf, see [Configure Telegraf](/{{< latest "telegraf" >}}/administration/configuration/#global-tags).
4. Click **Save Changes**.
## Set up Telegraf
Set up Telegraf to scrape metrics from InfluxDB Enterprise to send to your InfluxDB OSS account.
On each InfluxDB Enterprise instance you want to monitor, do the following:
1. Go to **Load Data > Telegraf** [in your InfluxDB OSS account](http://localhost:8086/signin).
2. Click **Setup Instructions** under **monitoring-enterprise-1.x**.
3. Complete the Telegraf Setup instructions. If you are using environment variables, set them up now.
{{% note %}}
For your API token, generate a new token or use an existing All Access token. If you run Telegraf as a service, edit your init script to set the environment variable and ensure its available to the service.
{{% /note %}}
Telegraf runs quietly in the background (no immediate output appears), and Telegraf begins pushing metrics to your InfluxDB OSS account.
## View the Monitoring dashboard
To see your data in real time, view the Monitoring dashboard.
1. Select **Boards** (**Dashboards**) in your **InfluxDB OSS** account.
{{< nav-icon "dashboards" >}}
2. Click **InfluxDB Enterprise Metrics**. Metrics appear in your dashboard.
3. Customize your monitoring dashboard as needed. For example, send an alert in the following cases:
- Users create a new task or bucket
- You're testing machine limits
- [Metrics stop reporting](#alert-when-metrics-stop-reporting)
## Alert when metrics stop reporting
The Monitoring template includes a [deadman check](/influxdb/v2.0/monitor-alert/checks/create/#deadman-check) to verify metrics are reported at regular intervals.
To alert when data stops flowing from InfluxDB OSS instances to your InfluxDB OSS account, do the following:
1. [Customize the deadman check](#customize-the-deadman-check) to identify the fields you want to monitor.
2. [Create a notification endpoint and rule](#create-a-notification-endpoint-and-rule) to receive notifications when your deadman check is triggered.
### Customize the deadman check
1. To view the deadman check, click **Alerts** in the navigation bar of your **InfluxDB OSS** account.
{{< nav-icon "alerts" >}}
2. Choose a InfluxDB OSS field or create a new OSS field for your deadman alert:
1. Click **{{< icon "plus" >}} Create** and select **Deadman Check** in the dropown menu.
2. Define your query with at least one field.
3. Click **Submit** and **Configure Check**.
When metrics stop reporting, you'll receive an alert.
3. Start under **Schedule Every**, set the amount of time to check for data.
4. Set the amount of time to wait before switching to a critical alert.
5. Save the Check and click on **View History** of the Check under the gear icon to verify it is running.
## Create a notification endpoint and rule
To receive a notification message when your deadman check is triggered, create a [notification endpoint](#create-a-notification-endpoint) and [rule](#create-a-notification-rule).
### Create a notification endpoint
InfluxData supports different endpoints: Slack, PagerDuty, and HTTP. Slack is free for all users, while PagerDuty and HTTP are exclusive to the Usage-Based Plan.
#### Send a notification to Slack
1. Create a [Slack Webhooks](https://api.slack.com/messaging/webhooks).
2. Go to **Alerts > Notification Endpoint** and click **{{< icon "plus" >}} Create**, and enter a name and description for your Slack endpoint.
3. Enter your Slack Webhook under **Incoming Webhook URL** and click **Create Notification Endpoint**.
#### Send a notification to PagerDuty or HTTP
Send a notification to PagerDuty or HTTP endpoints (other webhooks) by [upgrading your InfluxDB OSS account](/influxdb/v2.0/reference/cli/influxd/upgrade/).
### Create a notification rule
[Create a notification rule](/influxdb/v2.0/monitor-alert/notification-rules/create/) to set rules for when to send a deadman alert message to your notification endpoint.
1. Go to **Alerts > Notification Rules** and click **{{< icon "plus" >}} Create**.
2. Fill out the **About** and **Conditions** section then click **Create Notification Rule**.

70
content/enterprise_influxdb/v1.9/administration/monitor-enterprise/overview.md Normal file
View File

@ -0,0 +1,70 @@
---
title: Overview
description: Learn about the different ways to monitor InfluxDB Enterprise.
menu:
enterprise_influxdb_1_9:
name: Overview
weight: 70
parent: Monitor InfluxDB
---
## Monitoring and viewing internal metrics
InfluxDB offers options for both monitoring and for viewing your data at one time.
Monitoring is the act of proactively observing changes in data over time. However, you can choose to not monitor your data, but to view it occasionally and/or at the time when an issue occurs. There are multiple ways to monitor or look at InfluxDB Enterprise.
If you want to monitor an Enterprise cluster on your own, do one of the following:
* [Monitor Enterprise with Cloud](#monitor-enterprise-with-cloud)
* [Monitor Enterprise with OSS](#monitor-enterprise-with-oss)
* [Monitor Enterprise with internal monitoring](#monitor-enterprise-with-internal-monitoring)
* [Monitor with InfluxDB Aware and Influx Insights](#monitor-with-influxdb-aware-and-influx-insights)
If you want to view your data occasionally at a point in time do one of the following:
* [SHOW STATS](#show-stats)
* [SHOW DIAGNOSTICS](#show-diagnostics)
* [Log and trace InfluxDB Enterprise operations](#log-and-trace-influxdb-enterprise-operations)
### Monitor Enterprise with Cloud
[InfluxDB Cloud](/influxdb/cloud/) uses the [InfluxDB Enterprise 1.x Template](https://github.com/influxdata/community-templates/tree/master/influxdb-enterprise-1x), and Telegraf to monitor one or more InfluxDB Enterprise instances.
### Monitor Enterprise with OSS
[InfluxDB OSS](/influxdb/v2.0/) uses [InfluxDB Enterprise 1.x Template](https://github.com/influxdata/community-templates/tree/master/influxdb-enterprise-1x), and Telegraf to monitor one or more InfluxDB Enterprise instances.
### Monitor Enterprise with internal monitoring
InfluxDB writes statistical and diagnostic information to database named `_internal`, which records metrics on the internal runtime and service performance.
The `_internal` database can be queried and manipulated like any other InfluxDB database.
Check out the [monitor service README](https://github.com/influxdata/influxdb/blob/1.8/monitor/README.md) and the [internal monitoring blog post](https://www.influxdata.com/blog/how-to-use-the-show-stats-command-and-the-_internal-database-to-monitor-influxdb/) for more detail.
### Monitor with InfluxDB Aware and Influx Insights
InfluxDB Aware and Influx Insights is a free Enterprise service that sends your data to a free Cloud account. Aware assists you in monitoring your data by yourself. Insights assists you in monitoring your data with the help of the support team.
To apply for this service, please contact the [support team](support@influxdata.com).
### SHOW STATS
To see node statistics, execute the command `SHOW STATS`.
For details on this command, see [`SHOW STATS`](/enterprise_influxdb/v1.9/query_language/spec#show-stats) in the InfluxQL specification.
The statistics returned by `SHOW STATS` are stored in memory only, and are reset to zero when the node is restarted.
### SHOW DIAGNOSTICS
To see node diagnostic information, execute the command `SHOW DIAGNOSTICS`.
This returns information such as build information, uptime, hostname, server configuration, memory usage, and Go runtime diagnostics.
For details on this command, see [`SHOW DIAGNOSTICS`](/enterprise_influxdb/v1.9/query_language/spec#show-diagnostics) in the InfluxQL specification.
### Log and trace InfluxDB Enterprise operations
Write log information to other locations, use different service managers, and use different log output formats.
InfluxDB writes log output, by default, to `stderr`.
Depending on your use case, you may opt to write this log information to another location.
Use different service managers to override this default.

184
content/influxdb/cloud/influxdb-templates/monitor-enterprise.md Normal file
View File

@ -0,0 +1,184 @@
---
title: Monitor InfluxDB Enterprise using a template
description: >
Monitor your InfluxDB Enterprise instance using InfluxDB Cloud and
a pre-built InfluxDB template.
menu:
influxdb_cloud:
parent: Monitor with templates
name: Monitor InfluxDB Enterprise
weight: 102
influxdb/v2.0/tags: [templates, monitor]
---
Use [InfluxDB Cloud](/influxdb/cloud/), the [InfluxDB Enterprise 1.x Template](https://github.com/influxdata/community-templates/tree/master/influxdb-enterprise-1x), and Telegraf to monitor one or more InfluxDB Enterprise instances.
Do the following:
1. [Review requirements](#review-requirements)
2. [Install the InfluxDB Enterprise Monitoring template](#install-the-influxdb-enterprise-monitoring-template)
3. [Set up InfluxDB Enterprise for monitoring](#set-up-influxdb-enterprise-for-monitoring)
4. [Set up Telegraf](#set-up-telegraf)
5. [View the Monitoring dashboard](#view-the-monitoring-dashboard)
6. (Optional) [Alert when metrics stop reporting](#alert-when-metrics-stop-reporting)
7. (Optional) [Create a notification endpoint and rule](#create-a-notification-endpoint-and-rule)
8. (Optional) [Monitor with InfluxDB Insights and Aware](#monitor-with-influxdb-insights-and-aware)
## Review requirements
Before you begin, make sure you have access to the following:
- InfluxDB Cloud account ([sign up for free here](https://cloud2.influxdata.com/signup))
- Command line access to a machine [running InfluxDB Enterprise 1.x](/enterprise_influxdb/v1.9/introduction/install-and-deploy/) and permissions to install Telegraf on this machine
- Internet connectivity from the machine running InfluxDB Enterprise 1.x and Telegraf to InfluxDB Cloud
- Sufficient resource availability to install the template. InfluxDB Cloud Free Plan accounts include [resource limits](/influxdb/cloud/account-management/pricing-plans/#resource-limits/influxdb/cloud/account-management/pricing-plans/#resource-limits)
## Install the InfluxDB Enterprise Monitoring template
The InfluxDB Enterprise Monitoring template includes a Telegraf configuration that sends InfluxDB Enterprise metrics to an InfluxDB endpoint and a dashboard that visualizes the metrics.
1. [Log into your InfluxDB Cloud account](https://cloud2.influxdata.com/), go to **Settings > Templates**, and enter the following template URL:
```
https://raw.githubusercontent.com/influxdata/community-templates/master/influxdb-enterprise-1x/enterprise.yml
```
2. Click **Lookup Template**, and then click **Install Template**. InfluxDB Cloud imports the template, which includes the following resources:
- Telegraf Configuration `monitoring-enterprise-1x`
- Dashboard `InfluxDB 1.x Enterprise`
- Label `enterprise`
- Variables `influxdb_host` and `bucket`
## Set up InfluxDB Enterprise for monitoring
By default, InfluxDB Enterprise 1.x has a `/metrics` endpoint available, which exports Prometheus-style system metrics.
1. Make sure the `/metrics` endpoint is [enabled](/{{< latest "influxdb" >}}/reference/config-options/#metrics-disabled). If you've changed the default settings to disable the `/metrics` endpoint, [re-enable these settings](/{{< latest "influxdb" >}}/reference/config-options/#metrics-disabled).
2. Navigate to the `/metrics` endpoint of your InfluxDB Enterprise instance to view the InfluxDB Enterprise system metrics in your browser:
```
http://localhost:8086/metrics
```
Or use `curl` to fetch metrics:
```sh
curl http://localhost:8086/metrics
# HELP boltdb_reads_total Total number of boltdb reads
# TYPE boltdb_reads_total counter
boltdb_reads_total 41
# HELP boltdb_writes_total Total number of boltdb writes
# TYPE boltdb_writes_total counter
boltdb_writes_total 28
# HELP go_gc_duration_seconds A summary of the pause duration of garbage collection cycles.
...
```
3. Add your **InfluxDB Cloud** account information (URL and organization) to your Telegraf configuration by doing the following:
1. Go to **Load Data > Telegraf** [in your InfluxDB Cloud account](https://cloud2.influxdata.com/), and click **InfluxDB Output Plugin** at the top-right corner.
2. Copy the `urls`, `token`, `organization`, and `bucket` and close the window.
3. Click **monitoring-enterprise-1.x**.
4. Replace `urls`, `token`, `organization`, and `bucket` under `outputs.influxdb_v2` with your InfluxDB Cloud account information. Alternatively, store this information in your environment variables and include the environment variables in your configuration.
{{% note %}}
To ensure the InfluxDB Enterprise monitoring dashboard can display the recorded metrics, set the destination bucket name to `enterprise_metrics` in your `telegraf.conf`.
{{% /note %}}
5. Add the [Prometheus input plugin](https://github.com/influxdata/telegraf/blob/release-1.19/plugins/inputs/prometheus/README.md) to your `telegraf.conf`. Specify your your InfluxDB Enterprise URL(s) in the `urls` parameter. For example:
{{< keep-url >}}
```toml
[[inputs.prometheus]]
urls = ["http://localhost:8086/metrics"]
username = "$INFLUX_USER"
password = "$INFLUX_PASSWORD"
```
If you're using unique URLs or have security set up for your `/metrics` endpoint, configure those options here and save the updated configuration.
For more information about customizing Telegraf, see [Configure Telegraf](/{{< latest "telegraf" >}}/administration/configuration/#global-tags).
4. Click **Save Changes**.
## Set up Telegraf
Set up Telegraf to scrape metrics from InfluxDB Enterprise to send to your InfluxDB Cloud account.
On each InfluxDB Enterprise instance you want to monitor, do the following:
1. Go to **Load Data > Telegraf** [in your InfluxDB Cloud account](https://cloud2.influxdata.com/).
2. Click **Setup Instructions** under **monitoring-enterprise-1.x**.
3. Complete the Telegraf Setup instructions. If you are using environment variables, set them up now.
{{% note %}}
For your API token, generate a new token or use an existing All Access token. If you run Telegraf as a service, edit your init script to set the environment variable and ensure its available to the service.
{{% /note %}}
Telegraf runs quietly in the background (no immediate output appears), and Telegraf begins pushing metrics to your InfluxDB Cloud account.
## View the Monitoring dashboard
To see your data in real time, view the Monitoring dashboard.
1. Select **Boards** (**Dashboards**) in your **InfluxDB Cloud** account.
{{< nav-icon "dashboards" >}}
2. Click **InfluxDB Enterprise Metrics**. Metrics appear in your dashboard.
3. Customize your monitoring dashboard as needed. For example, send an alert in the following cases:
- Users create a new task or bucket
- You're testing machine limits
- [Metrics stop reporting](#alert-when-metrics-stop-reporting)
## Alert when metrics stop reporting
The Monitoring template includes a [deadman check](/influxdb/cloud/monitor-alert/checks/create/#deadman-check) to verify metrics are reported at regular intervals.
To alert when data stops flowing from InfluxDB OSS instances to your InfluxDB Cloud account, do the following:
1. [Customize the deadman check](#customize-the-deadman-check) to identify the fields you want to monitor.
2. [Create a notification endpoint and rule](#create-a-notification-endpoint-and-rule) to receive notifications when your deadman check is triggered.
### Customize the deadman check
1. To view the deadman check, click **Alerts** in the navigation bar of your **InfluxDB Cloud** account.
{{< nav-icon "alerts" >}}
2. Choose a InfluxDB OSS field or create a new OSS field for your deadman alert:
1. Click **{{< icon "plus" >}} Create** and select **Deadman Check** in the dropown menu.
2. Define your query with at least one field.
3. Click **Submit** and **Configure Check**.
When metrics stop reporting, you'll receive an alert.
3. Start under **Schedule Every**, set the amount of time to check for data.
4. Set the amount of time to wait before switching to a critical alert.
5. Save the Check and click on **View History** of the Check under the gear icon to verify it is running.
## Create a notification endpoint and rule
To receive a notification message when your deadman check is triggered, create a [notification endpoint](#create-a-notification-endpoint) and [rule](#create-a-notification-rule).
### Create a notification endpoint
InfluxData supports different endpoints: Slack, PagerDuty, and HTTP. Slack is free for all users, while PagerDuty and HTTP are exclusive to the Usage-Based Plan.
#### Send a notification to Slack
1. Create a [Slack Webhooks](https://api.slack.com/messaging/webhooks).
2. Go to **Alerts > Notification Endpoint** and click **{{< icon "plus" >}} Create**, and enter a name and description for your Slack endpoint.
3. Enter your Slack Webhook under **Incoming Webhook URL** and click **Create Notification Endpoint**.
#### Send a notification to PagerDuty or HTTP
Send a notification to PagerDuty or HTTP endpoints (other webhooks) by [upgrading your InfluxDB Cloud account](/influxdb/cloud/account-management/billing/#upgrade-to-usage-based-plan).
### Create a notification rule
[Create a notification rule](/influxdb/cloud/monitor-alert/notification-rules/create/) to set rules for when to send a deadman alert message to your notification endpoint.
1. Go to **Alerts > Notification Rules** and click **{{< icon "plus" >}} Create**.
2. Fill out the **About** and **Conditions** section then click **Create Notification Rule**.
## Monitor with InfluxDB Insights and Aware
For InfluxDB Enterprise customers, Insights and Aware are free services that can monitor your data. InfluxDB Insights sends your data to a private Cloud account and will be monitored with the help of the support team. InfluxDB Aware is a similar service, but you monitor your data yourself.
To apply for this service, please contact the [support team](support@influxdata.com).