Skip to main content

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.

Project details

Release history Release notifications | RSS feed

This version


Download files

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

Source Distribution

opencanary-correlator-0.1.tar.gz (13.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page