Installation

This page provides the requirements for installing, starting, and configuring Chronograf. For the fastest way to get up and running with Chronograf, see the Getting Started guide.

Content

Requirements

Installation of the Chronograf package may require root or administrator privileges to complete successfully.

TICK

Chronograf is the UI for the other components of the TICK stack: Telegraf, InfluxDB/InfluxEnterprise Clustering, and Kapacitor. You do not need to install every component of the TICK stack to use Chronograf. The following sections give a brief description of the other TICK stack components, how they fit within Chronograf, and if they are necessary for your setup.

Telegraf (required)

Telegraf is InfluxData’s plugin-driven server agent for collecting & reporting metrics. Telegraf collects data and writes data to the InfluxDB instance or InfluxEnterprise cluster that’s connected to Chronograf. Chronograf is designed to work with Telegraf data and offers pre-created dashboards for several Telegraf input plugins.

Chronograf requires at least one Telegraf instance that collects data and writes the data to an InfluxDB instance or InfluxEnterprise cluster. At a minimum, the Telegraf instance must have enabled the system statistics input plugin; that input plugin provides the system-level data necessary for the Chronograf interface.

Installation Resources:

InfluxDB/InfluxEnterprise cluster (required)

InfluxDB is InfluxData’s open source time-series database built from the ground up to handle high write and query loads. InfluxEnterprise is InfluxData’s closed source time-series database with clustering. InfluxDB instances and InfluxEnterprise clusters store the time-series data that populate the Chronograf interface.

Chronograf requires at least one InfluxDB instance or one InfluxEnterprise cluster to serve as its data storage component. A single Chronograf instance can support several InfluxDB instances or InfluxEnterprise clusters.

Installation Resources:

Kapacitor (optional)

Kapacitor is InfluxData’s processing framework for creating alerts, running ETL jobs, and detecting anomalies in your data. Kapacitor is responsible for creating and sending alerts in Chronograf.

Chronograf requires at least one Kapacitor instance if you plan on using Chronograf for creating, sending, and managing alerts. Kapacitor instances are scoped to the InfluxDB instance or InfluxEnterprise cluster that connects to Chronograf. An InfluxDB instance or InfluxEnterprise cluster can support more than one Kapacitor instance.

You do not need a Kapacitor instance if you plan on only using Chronograf’s host list, data explorer, dashboard, and admin pages.

Installation Resources:

Networking

Chronograf runs on localhost port 8888 by default. Those settings are configurable.

Builds

The latest Chronograf builds are available on InfluxData’s Downloads page. See Chronograf’s README on GitHub for instructions on building from source.

Configuration and Security

See the Configuration document for a description of the available configuration options. See Security Best Practices for TLS and OAUTH 2.0 setup instructions.

This documentation is open source. See a typo? Please, open an issue.


Need help getting up and running? Get Support