cubo-profile

InfluxDB Cloud Usage Dashboard

Template built by

Flux Standard library used:

Included Resources:

  • 1 Dashboard: Usage Dashboard
  • 1 Task: Cardinality Limit Alert (usage dashboard)
  • 1 Label: usage_dashboard

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/usage_dashboard/usage_dashboard.yml

Usage Dashboard

InfluxDB Cloud offers a transparent usage-based pricing model that only charges users on the work performed. This gives users the freedom from having to engage in capacity planning to allocate or size a server as a prerequisite for running workloads. Backed by a platform that elastically scales as your workloads increase or contract, usage-based pricing saves you from overpaying for over-provisioned managed services costs or facing outages or service degradations due to underprovisioning.

Why use the Usage Dashboard with your InfluxDB Cloud instance

The InfluxDB Cloud Usage Dashboard Template gives you detailed and customizable insight into your organization's data usage and any rate limit events that may occur on your InfluxDB Cloud instance.

This InfluxDB template uses the experimental/usage Flux API package to help InfluxDB Cloud users monitor their organization's data usage, and to alert users when rate-limited events occur. Please note that this template is only compatible with InfluxDB Cloud.

How to use the Usage Dashboard Template

Once your InfluxDB credentials have been properly configured in the CLI, you can install the Usage Dashboard template using the Quick Install command. Alternatively, you can install the template in the InfluxDB Cloud UI by going to Settings -> Templates and enter this URL:

https://github.com/influxdata/community-templates/master/usage_dashboard/usage_dashboard.yml

Once installed, the data for the dashboard will be populated by the included Flux Experimental usage package configuration.

Customizations

Task

The Task has been designed to be easily customizable to your needs. By default, the task monitors the event_type_limited_cardinality value returned by the usage.from() API call, and sends a Slack alert whenever this value passes the threshold value (the default value has been set to 1). You can customize this by:

  • Changing the threshold value to be alerted at higher values
  • Specifying a particular Slack Channel to receive the notification by setting the slackChannel = "#{channel}"
  • Setting alerts for monitoring Write or Query events by modifying event_type_limited_cardinality to either event_type_limited_write or event_type_limited_query
Dashboard

You can customize the Dashboard to fit your organization's specific needs. Some customization ideas include:

  • Set custom threshold values on your usage metric values
  • Experiment with different Graph types to visualize the data
  • Match your Limit Events threshold values to whatever you set in your alerts
Usage API

The Dashboard and Task take advantage of the Flux experimental/usage package, which you can use to customize the template content or build your own! For more information on this Flux package, check out our documentation: https://docs.influxdata.com/influxdb/cloud/reference/flux/stdlib/experimental/usage/

Key Usage Dashboard metrics to monitor

Some of the most important Usage metrics that you should proactively monitor include:

  • Data In
  • Query Count
  • Storage
  • Data Out
  • Rate Limits

Related Resources

Downsample Your Data in InfluxDB

This InfluxDB Template provides a set of tasks that allow you to downsample your data for common Telegraf input plugins.

Open Source InfluxDB 2.0 Monitoring Template

Monitor your Open Source instance to keep your solution highly available.

Monitoring InfluxDB Enterprise

Tim Hall, InfluxData VP of Products, outlines why and how you can monitor InfluxDB Enterprise with InfluxDB.

Scroll to Top