Link Search Menu Expand Document

Kapacitor Integration Guide

Logo Company Estimated Time Functionality Vendor Docs
InfluxData, Inc. InfluxData, Inc. 5 minutes One-Way view

Kapacitor Integration

Kapacitor is an open source data processing framework that makes it easy to create alerts, run ETL jobs and detect anomalies. It can process both stream and batch data from InfluxDB. It lets you plug in your own custom logic or user-defined functions to process alerts with dynamic thresholds, match metrics for patterns, compute statistical anomalies, and perform specific actions based on these alerts like dynamic load rebalancing.

How Kapacitor users benefit from PagerTree

Kapacitor triggers alerts when alert rules are triggered. PagerTree acts as the dispatcher for these alerts, determining the right people to notify based on on-call schedules. PagerTree notifies them via email, sms, voice, and/or push notifications until the alert is acknowledged.

Functionality of Integration

The Kapacitor integration is one-way, meaning:

  • When an alert is not OK (level !== 'OK') in Kapacitor, an alert is created in PagerTree automatically.
  • When an alert is OK (level === 'OK') in Kapacitor, the alert is resolved in PagerTree automatically.

Tutorial Overview

In this integration tutorial we will show you how to send alerts from Kapacitor into PagerTree. The estimated time for this integration is 5 minutes. We assume that you already have a PagerTree and Kapacitor setup. We also assume you are familiar with the TICK stack since we will be using several of these components to setup the Kapacitor integration.

In PagerTree

  1. From the integrations page, click the New Integration” button Click Create Integration Button
  2. Click the logo of the Type of integration you want to create
  3. In the “Create Integration” form, fill out the following:
    1. Name of the Integration.
    2. Select an appropriate Urgency for when this integration is triggered
    3. Select the Team this alert will be assigned to
    4. Any additional options requested by the integration
  4. Click Create
  5. Copy the Endpoint URL Copy Endpoint URL

In Kapacitor

  1. From your Chronograph dashboard, in the left hand menu, select Alerting -> Manage Tasks. Alerting Manage Tasks
  2. Click the Write TICKscript button. Write TICKscript button
  3. In the TICKscript editor:
    1. Select a database. Select a database
    2. Title your TICKscript (e.g. “high_cpu”).
    3. Copy and paste the following code, replacing the pagertree_url value with the PagerTree Endpoint URL you copied earlier.
    1. Click the Save New TICKscript button Click Save New TICKscript

This tick script, uses InfluxDB’s sample Telegraph collector that merely collects CPU usage on your local machine. You’ll need to apply the alert to your own tickscripts to alert on metrics you wish to monitor. The important pieces to this script are:

You have successfully completed the Kapacitor Integration. Now when Kapacitor creates an alert, PagerTree will create an alert and route it to the correct team member that is on-call. If you have any questions please contact [email protected]

Additional Resources

  • cpu_alert.tick - Sample TICKscript to alert PagerTree using HTTP POST

© 2016-2022 PagerTree LLC. All rights reserved.