Documentation

Install Kapacitor

This page documents an earlier version of Kapacitor. Kapacitor v1.6 is the latest stable version. View this page in the v1.6 documentation.

This page provides directions for installing, starting, and configuring Kapacitor.

Requirements

Installation of the InfluxDB package may require root or administrator privileges in order to complete successfully.

Networking

Kapacitor listens on TCP port 9092 for all API and write calls.

Kapacitor may also bind to randomized UDP ports for handling of InfluxDB data via subscriptions.

Installation

Kapacitor has two binaries:

  • kapacitor: a CLI program for calling the Kapacitor API.
  • kapacitord: the Kapacitor server daemon.

You can download the binaries directly from the downloads page.

Note: Windows support is experimental.

Starting the Kapacitor service

For packaged installations, please see the respective sections below for your operating system. For non-packaged installations (tarballs or from source), you will need to start the Kapacitor application manually by running:

./kapacitord -config <PATH TO CONFIGURATION>

macOS (using Homebrew)

To have launchd start Kapacitor at login:

ln -sfv /usr/local/opt/kapacitor/*.plist ~/Library/LaunchAgents

Then to load Kapacitor now:

launchctl load ~/Library/LaunchAgents/homebrew.mxcl.kapacitor.plist

Or, if you don’t want/need lanchctl, you can just run:

kapacitord -config /usr/local/etc/kapacitor.conf

Linux - SysV or Upstart systems

To start the Kapacitor service, run:

sudo service kapacitor start

Linux - systemd systems

To start the Kapacitor service, run:

sudo systemctl start kapacitor

Configuration

An example configuration file can be found here.

Kapacitor can also provide an example configuration for you using this command:

kapacitord config

To generate a new configuration file, run:

kapacitord config > kapacitor.generated.conf

Shared secret

If using Kapacitor v1.5.3 or newer and InfluxDB with authentication enabled, set the [http].shared-secret option in your Kapacitor configuration file to the shared secret of your InfluxDB instances.

# ...
[http]
  # ...
  shared-secret = "youramazingsharedsecret"

If not set, set to an empty string, or does not match InfluxDB’s shared-secret, the integration with InfluxDB will fail and Kapacitor will not start.

Time zone

To display alerts notifications using a preferred time zone, either change the time zone of the host on which Kapacitor is running or set the Kapacitor process’ TZ environment variable.

systemd

Add the environment variable using systemctl edit kapacitor:

[Service]
Environment="TZ=Asia/Shanghai"

docker

Set the environment variable using the -e flag when starting the container (-e TZ=Asia/Shanghai) or in your docker-compose.yml.


Was this page helpful?

Thank you for your feedback!


Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.

InfluxDB Cloud backed by InfluxDB IOx

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by IOx, this is the correct documentation.

If powered by TSM, see the TSM-based InfluxDB Cloud documentation.

InfluxDB Cloud backed by InfluxDB TSM

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine which enables nearly unlimited series cardinality and SQL query support. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by TSM, this is the correct documentation.

If powered by IOx, see the IOx-based InfluxDB Cloud documentation.

State of the InfluxDB Cloud (IOx) documentation

The new documentation for InfluxDB Cloud backed by InfluxDB IOx is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.