Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

opencanary correlator

Project Description

Thinkst Applied Research


OpenCanary Correlator collects events from OpenCanary daemons and coalesces them. It sends alerts via email and sms


  • Redis
  • Python 2.7
  • Mandrill API keys for email
  • Twillio API keys for sms

On Ubuntu install the following:

`$ sudo apt-get install redis-server libffi-dev python-dev`


  • Create a virtualenv

` $ virtualenv env $ source env/bin/activate `

  • Install via pip, or

` $ pip install opencanary-correlator `

  • Install from source

` $ git clone $ cd opencanary-correlator $ python install `


  • Start Redis
  • Locate the installed template config file, by running the correlator without any arguments

` $ opencanary-correlator Warning: no config file specified. Using the template config (which does not have any alerting configured): /path/to/template/opencanary_correlator.conf $ cp /path/to/template/opencanary_correlator.conf ./ `

  • Edit the config file to add API keys, email address and/or phone numbers for alerts
  • Run the correlator with saved config file

` opencanary-correlator --config=./opencanary_correlator.conf `

  • Configure instances of opencanaryd to send events to the correlator.

Release History

This version
History Node


Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, Size & Hash SHA256 Hash Help File Type Python Version Upload Date
(13.1 kB) Copy SHA256 Hash SHA256
Source None Aug 19, 2015

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers DreamHost DreamHost Log Hosting