cubo-outlined

InfluxDB Operational Monitoring Template

Template built by

Included Resources:

  • 1 Bucket: cardinality, Forever
  • 1 Task: cardinality_by_bucket, 1h
  • 2 Labels: operational_monitoring
  • 2 Dashboard: Task Summary Dashboard, Cardinality Explorer

Quick Install

If you have your InfluxDB credentials configured in the CLI, you can install this template with:

https://raw.githubusercontent.com/influxdata/community-templates/master/influxdb2_operational_monitoring/influxdb2_cardinality_now.yml

Operational Monitoring - Task Summary Dashboard

Why monitor your InfluxDB for operational fitness?

Monitoring your InfluxDB instances will help you identify issues that could lead to degradation of the performance of your instance and even avoid potential failures. This InfluxDB template includes 2 templates, the Operational Monitoring Template and the Cardinality Now Template, that can help with monitoring tasks and cardinality.

Monitoring tasks

Monitoring your tasks allows you to verify that critical downsampling and data transformation tasks are succeeding so you can respond to task failures quickly.

Monitoring cardinality

  • Monitoring your cardinality allows you to ensure that you're not experiencing runaway cardinality.
  • Verify that your downsampling tasks and retention policies are successfully reducing your series cardinality.

This Cardinality Explorer dashboard is used by InfluxData to monitor the cardinality of InfluxData's own production monitoring InfluxDB instance. The cardinality bucket is populated by the cardinality_by_bucket task which summarizes schema data about your InfluxDB instance.

How to use the Operational Monitoring Template

Once your InfluxDB credentials have been properly configured in the CLI, you can install the Operational monitoring template using the Quick Install command. Once installed, the data for the dashboard will be populated.

Setup instructions for the Operational Monitoring Template

The data for the Task Summary Dashboard is populated by data collected from the default _tasks bucket. The Cardinality Explorer dashboard is populated by data collected from the cardinality bucket. The best way to set this up is to first follow the instructions for installing any template. That will create the label, bucket, and dashboards for you.

You must already have a task running in order to populate the Task Summary Dashboard with data. Get started with InfluxDB tasks to create a task and populate the dashboard.

Cardinality Now InfluxDB Template

Cardinality Now is a slimmed down version of the Operational Monitoring Template. This version allows you to monitor your current cardinality without adding additional buckets or tasks to your instance (i.e. without increasing the cardinality of your instance).

Included resources

  • 1 Labels: cardinality
  • 1 Dashboard: Cardinality Now

Quick Install

https://raw.githubusercontent.com/influxdata/community-templates/master/influxdb2_operational_monitoring/influxdb2_cardinality_now.yml

InfluxCLI

influx apply -u https://raw.githubusercontent.com/influxdata/community-templates/master/influxdb2_operational_monitoring/influxdb2_cardinality_now.yml

Related resources

Three Ways to Keep Cardinality Under Control When Using Telegraf

This article will show how we kept cardinality under control with a few tweaks in the Telegraf configuration.

Solving Runaway Series Cardinality When Using InfluxDB

Learn what causes high series cardinality in a time series database and how to locate and eliminate the culprits.

Red Flags of High Cardinality in Databases

Learn what cardinality is, how to find out if the cardinality is an issue in your database, and what to do if you do have high cardinality.

Scroll to Top