Clean up InfluxDB Enterprise "Monitor" docs (#3217)
This fixes the organization of the monitoring docs and the current build errors. * Delete `overview.md` and move its content elsewhere * Moved InfluxQL commmands to new page, "Diagnostics" * Move note on Influx Aware to index page. * Remove content monitoring with `_internal`, since it's not recommended. * Add intro paragraph to index and fix weights * Delete doc with duplicate content Closes #3193.pull/3224/head
pierwill
GitHub
parent
2952b07c35
commit
fe36eb8470
|
|
@ -1,11 +0,0 @@
|
|||
---
|
||||
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 >}}
|
||||
|
|
@ -1,103 +0,0 @@
|
|||
---
|
||||
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).
|
||||
|
|
@ -1,99 +0,0 @@
|
|||
---
|
||||
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/).
|
||||
|
|
@ -1,70 +0,0 @@
|
|||
---
|
||||
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.
|
||||
|
|
@ -1,11 +1,30 @@
|
|||
---
|
||||
title: Monitor
|
||||
description:
|
||||
title: Monitor InfluxDB Enterprise
|
||||
description: Monitor InfluxDB Enterprise with InfluxDB Cloud or OSS.
|
||||
menu:
|
||||
enterprise_influxdb_1_9:
|
||||
name: Monitor
|
||||
weight: 12
|
||||
parent: Administration
|
||||
weight: 50
|
||||
---
|
||||
|
||||
Monitoring is the act of observing changes in data over time.
|
||||
There are multiple ways to monitor your InfluxDB Enterprise cluster.
|
||||
See the guides below to monitor a cluster using another InfluxDB instance.
|
||||
|
||||
Alternatively, to view your output data occasionally (_e.g._, for auditing or diagnostics),
|
||||
do one of the following:
|
||||
|
||||
- [Log and trace InfluxDB Enterprise operations](/enterprise_influxdb/v1.9/administration/monitor/logs/)
|
||||
- [Use InfluxQL for diagnostics](/enterprise_influxdb/v1.9/administration/monitor/diagnostics/)
|
||||
|
||||
{{% note %}}
|
||||
### 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).
|
||||
{{% /note %}}
|
||||
|
||||
{{< children >}}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
title: Use InfluxQL for diagnostics
|
||||
description: Use InfluxQL commands for diagnostics and statistics.
|
||||
menu:
|
||||
enterprise_influxdb_1_9:
|
||||
name: Diagnostics
|
||||
parent: Monitor
|
||||
weight: 104
|
||||
---
|
||||
|
||||
The commands below are useful when diagnosing issues with InfluxDB Enterprise clusters.
|
||||
Use the [`influx` CLI](/enterprise_influxdb/v1.9/tools/influx-cli/use-influx/) to run these commands.
|
||||
|
||||
### SHOW STATS
|
||||
|
||||
To see node statistics, run `SHOW STATS`.
|
||||
The statistics returned by `SHOW STATS` are stored in memory only,
|
||||
and are reset to zero when the node is restarted.
|
||||
|
||||
For details on this command, see [`SHOW STATS`](/enterprise_influxdb/v1.9/query_language/spec#show-stats).
|
||||
|
||||
### SHOW DIAGNOSTICS
|
||||
|
||||
To see node diagnostic information, run `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).
|
||||
|
|
@ -5,8 +5,8 @@ description: >
|
|||
menu:
|
||||
enterprise_influxdb_1_9:
|
||||
name: Log and trace
|
||||
weight: 90
|
||||
parent: Monitor
|
||||
weight: 103
|
||||
aliases:
|
||||
- /enterprise_influxdb/v1.9/administration/logs/
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,13 +1,15 @@
|
|||
---
|
||||
title: Monitor InfluxDB Enterprise using a template
|
||||
title: Monitor InfluxDB Enterprise with InfluxDB Cloud
|
||||
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
|
||||
parent: Monitor
|
||||
weight: 100
|
||||
aliases:
|
||||
- /enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-with-cloud/
|
||||
---
|
||||
|
||||
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.
|
||||
|
|
@ -1,13 +1,15 @@
|
|||
---
|
||||
title: Monitor InfluxDB Enterprise using OSS
|
||||
title: Monitor InfluxDB Enterprise with InfluxDB 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
|
||||
parent: Monitor
|
||||
weight: 101
|
||||
aliases:
|
||||
- /enterprise_influxdb/v1.9/administration/monitor-enterprise/monitor-with-oss/
|
||||
---
|
||||
|
||||
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.
|
||||
|
|
@ -174,4 +176,4 @@ Send a notification to PagerDuty or HTTP endpoints (other webhooks) by [upgradin
|
|||
[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**.
|
||||
2. Fill out the **About** and **Conditions** section then click **Create Notification Rule**.
|
||||
|
|
@ -1,168 +0,0 @@
|
|||
---
|
||||
title: Monitor InfluxDB servers
|
||||
description: Troubleshoot and monitor InfluxDB OSS.
|
||||
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 InfluxDB
|
||||
weight: 80
|
||||
parent: Monitor
|
||||
---
|
||||
|
||||
**On this page**
|
||||
|
||||
* [SHOW STATS](#show-stats)
|
||||
* [SHOW DIAGNOSTICS](#show-diagnostics)
|
||||
* [Internal monitoring](#internal-monitoring)
|
||||
* [Useful performance metrics commands](#useful-performance-metrics-commands)
|
||||
* [InfluxDB `/metrics` HTTP endpoint](#influxdb-metrics-http-endpoint)
|
||||
|
||||
|
||||
InfluxDB can display statistical and diagnostic information about each node.
|
||||
This information can be very useful for troubleshooting and performance monitoring.
|
||||
|
||||
## 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.
|
||||
|
||||
## Internal monitoring
|
||||
InfluxDB also 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.
|
||||
|
||||
## Useful performance metrics commands
|
||||
|
||||
Below are a collection of commands to find useful performance metrics about your InfluxDB instance.
|
||||
|
||||
To find the number of points per second being written to the instance. Must have the `monitor` service enabled:
|
||||
```bash
|
||||
$ influx -execute 'select derivative(pointReq, 1s) from "write" where time > now() - 5m' -database '_internal' -precision 'rfc3339'
|
||||
```
|
||||
|
||||
To find the number of writes separated by database since the beginnning of the log file:
|
||||
|
||||
```bash
|
||||
grep 'POST' /var/log/influxdb/influxd.log | awk '{ print $10 }' | sort | uniq -c
|
||||
```
|
||||
|
||||
Or, for systemd systems logging to journald:
|
||||
|
||||
```bash
|
||||
journalctl -u influxdb.service | awk '/POST/ { print $10 }' | sort | uniq -c
|
||||
```
|
||||
|
||||
### InfluxDB `/metrics` HTTP endpoint
|
||||
|
||||
> ***Note:*** There are no outstanding PRs for improvements to the `/metrics` endpoint, but we’ll add them to the CHANGELOG as they occur.
|
||||
|
||||
The InfluxDB `/metrics` endpoint is configured to produce the default Go metrics in Prometheus metrics format.
|
||||
|
||||
|
||||
#### Example using InfluxDB `/metrics' endpoint
|
||||
|
||||
Below is an example of the output generated using the `/metrics` endpoint. Note that HELP is available to explain the Go statistics.
|
||||
|
||||
```
|
||||
# HELP go_gc_duration_seconds A summary of the GC invocation durations.
|
||||
# TYPE go_gc_duration_seconds summary
|
||||
go_gc_duration_seconds{quantile="0"} 6.4134e-05
|
||||
go_gc_duration_seconds{quantile="0.25"} 8.8391e-05
|
||||
go_gc_duration_seconds{quantile="0.5"} 0.000131335
|
||||
go_gc_duration_seconds{quantile="0.75"} 0.000169204
|
||||
go_gc_duration_seconds{quantile="1"} 0.000544705
|
||||
go_gc_duration_seconds_sum 0.004619405
|
||||
go_gc_duration_seconds_count 27
|
||||
# HELP go_goroutines Number of goroutines that currently exist.
|
||||
# TYPE go_goroutines gauge
|
||||
go_goroutines 29
|
||||
# HELP go_info Information about the Go environment.
|
||||
# TYPE go_info gauge
|
||||
go_info{version="go1.10"} 1
|
||||
# HELP go_memstats_alloc_bytes Number of bytes allocated and still in use.
|
||||
# TYPE go_memstats_alloc_bytes gauge
|
||||
go_memstats_alloc_bytes 1.581062048e+09
|
||||
# HELP go_memstats_alloc_bytes_total Total number of bytes allocated, even if freed.
|
||||
# TYPE go_memstats_alloc_bytes_total counter
|
||||
go_memstats_alloc_bytes_total 2.808293616e+09
|
||||
# HELP go_memstats_buck_hash_sys_bytes Number of bytes used by the profiling bucket hash table.
|
||||
# TYPE go_memstats_buck_hash_sys_bytes gauge
|
||||
go_memstats_buck_hash_sys_bytes 1.494326e+06
|
||||
# HELP go_memstats_frees_total Total number of frees.
|
||||
# TYPE go_memstats_frees_total counter
|
||||
go_memstats_frees_total 1.1279913e+07
|
||||
# HELP go_memstats_gc_cpu_fraction The fraction of this program's available CPU time used by the GC since the program started.
|
||||
# TYPE go_memstats_gc_cpu_fraction gauge
|
||||
go_memstats_gc_cpu_fraction -0.00014404354379774563
|
||||
# HELP go_memstats_gc_sys_bytes Number of bytes used for garbage collection system metadata.
|
||||
# TYPE go_memstats_gc_sys_bytes gauge
|
||||
go_memstats_gc_sys_bytes 6.0936192e+07
|
||||
# HELP go_memstats_heap_alloc_bytes Number of heap bytes allocated and still in use.
|
||||
# TYPE go_memstats_heap_alloc_bytes gauge
|
||||
go_memstats_heap_alloc_bytes 1.581062048e+09
|
||||
# HELP go_memstats_heap_idle_bytes Number of heap bytes waiting to be used.
|
||||
# TYPE go_memstats_heap_idle_bytes gauge
|
||||
go_memstats_heap_idle_bytes 3.8551552e+07
|
||||
# HELP go_memstats_heap_inuse_bytes Number of heap bytes that are in use.
|
||||
# TYPE go_memstats_heap_inuse_bytes gauge
|
||||
go_memstats_heap_inuse_bytes 1.590673408e+09
|
||||
# HELP go_memstats_heap_objects Number of allocated objects.
|
||||
# TYPE go_memstats_heap_objects gauge
|
||||
go_memstats_heap_objects 1.6924595e+07
|
||||
# HELP go_memstats_heap_released_bytes Number of heap bytes released to OS.
|
||||
# TYPE go_memstats_heap_released_bytes gauge
|
||||
go_memstats_heap_released_bytes 0
|
||||
# HELP go_memstats_heap_sys_bytes Number of heap bytes obtained from system.
|
||||
# TYPE go_memstats_heap_sys_bytes gauge
|
||||
go_memstats_heap_sys_bytes 1.62922496e+09
|
||||
# HELP go_memstats_last_gc_time_seconds Number of seconds since 1970 of last garbage collection.
|
||||
# TYPE go_memstats_last_gc_time_seconds gauge
|
||||
go_memstats_last_gc_time_seconds 1.520291233297057e+09
|
||||
# HELP go_memstats_lookups_total Total number of pointer lookups.
|
||||
# TYPE go_memstats_lookups_total counter
|
||||
go_memstats_lookups_total 397
|
||||
# HELP go_memstats_mallocs_total Total number of mallocs.
|
||||
# TYPE go_memstats_mallocs_total counter
|
||||
go_memstats_mallocs_total 2.8204508e+07
|
||||
# HELP go_memstats_mcache_inuse_bytes Number of bytes in use by mcache structures.
|
||||
# TYPE go_memstats_mcache_inuse_bytes gauge
|
||||
go_memstats_mcache_inuse_bytes 13888
|
||||
# HELP go_memstats_mcache_sys_bytes Number of bytes used for mcache structures obtained from system.
|
||||
# TYPE go_memstats_mcache_sys_bytes gauge
|
||||
go_memstats_mcache_sys_bytes 16384
|
||||
# HELP go_memstats_mspan_inuse_bytes Number of bytes in use by mspan structures.
|
||||
# TYPE go_memstats_mspan_inuse_bytes gauge
|
||||
go_memstats_mspan_inuse_bytes 1.4781696e+07
|
||||
# HELP go_memstats_mspan_sys_bytes Number of bytes used for mspan structures obtained from system.
|
||||
# TYPE go_memstats_mspan_sys_bytes gauge
|
||||
go_memstats_mspan_sys_bytes 1.4893056e+07
|
||||
# HELP go_memstats_next_gc_bytes Number of heap bytes when next garbage collection will take place.
|
||||
# TYPE go_memstats_next_gc_bytes gauge
|
||||
go_memstats_next_gc_bytes 2.38107752e+09
|
||||
# HELP go_memstats_other_sys_bytes Number of bytes used for other system allocations.
|
||||
# TYPE go_memstats_other_sys_bytes gauge
|
||||
go_memstats_other_sys_bytes 4.366786e+06
|
||||
# HELP go_memstats_stack_inuse_bytes Number of bytes in use by the stack allocator.
|
||||
# TYPE go_memstats_stack_inuse_bytes gauge
|
||||
go_memstats_stack_inuse_bytes 983040
|
||||
# HELP go_memstats_stack_sys_bytes Number of bytes obtained from system for stack allocator.
|
||||
# TYPE go_memstats_stack_sys_bytes gauge
|
||||
go_memstats_stack_sys_bytes 983040
|
||||
# HELP go_memstats_sys_bytes Number of bytes obtained from system.
|
||||
# TYPE go_memstats_sys_bytes gauge
|
||||
go_memstats_sys_bytes 1.711914744e+09
|
||||
# HELP go_threads Number of OS threads created.
|
||||
# TYPE go_threads gauge
|
||||
go_threads 16
|
||||
```
|
||||
Loading…
Reference in New Issue