Skip to main content

SNMP Trap Daemon.

Project description

TrapperKeeper
=============

Description
-----------

TrapperKeeper is a suite of tools for ingesting and displaying SNMP
traps. This is designed as a replacement for snmptrapd and to supplement
existing stateful monitoring solutions.

Normally traps are stateless in nature which makes it difficult to
monitor with a system like nagios which requires polling a source.
TrapperKeeper will store traps in an active state for a configured
amount of time before expiring. This makes it possible to poll the
service for active traps and alert off of those traps.

One example might be a humidity alert. If you cross over the humity
threshold and it clears immediately you might not want to be paged at
3am. But if it continues to send a trap every 5 minutes while it's over
that threshold the combination of (hostname, oid, severity) will remain
in an active state as long as that trap's expiration duration is longer
than 5 minutes. This allows something like nagios to alarm when a single
trap remains active for greater than some period of time.

Another benefit is allowing aggregation of pages. Previously we'd just
had an e-mail to a pager per trap but now we're only paged based on the
alert interval regardless of how many traps we receive. This also allows
us to schedule downtime for a device during scheduled maintenance to
avoid trap storms.

Installation
------------

New versions will be updated to PyPI pretty regularly so it should be as
easy as:

::

$ pip install trapperkeeper

Once you've created a configuration file with your database information
you can run the following to create the database schema.

``bash $ python -m trapperkeeper.cmds.sync_db -c /path/to/trapperkeeper.yaml``
## Tools

trapperkeeper
~~~~~~~~~~~~~

The trapperkeeper command receives SNMP traps and handles e-mailing and
writing to the database. An example configuration file with
documentation is available `here. <conf/trapperkeeper.yaml>`_

trapdoor
~~~~~~~~

trapdoor is a webserver that provides a view into the existing traps as
well as an API for viewing the state of traps. An example configuration
file with documentation is available `here. <conf/trapdoor.yaml>`_

.. figure:: https://raw.githubusercontent.com/dropbox/trapperkeeper/master/images/trapdoor.png
:align: center
:alt: Screenshot

Screenshot
API
^^^

/api/activetraps
''''''''''''''''

**Optional Parameters:** \* hostname \* oid \* severity

**Returns:** ``javascript [ (<hostname>, <oid>, <severity>) ]``

/api/varbinds/
''''''''''''''

**Returns:**
``javascript [ { "notification_id": <notification_id>, "name": <varbind_name>, "pretty_value": <pretty_value>, "oid": <oid>, "value": <value>, "value_type": <value_type> } ]``

TODO
----

- Runtime rules language for things like blackhole and e-mail subjects.
- Allow Custom E-mail templates for TrapperKeeper
- cdnjs prefix for local cdnjs mirrors
- User ACLs for resolution
- Logging resolving user

Known Issues
------------

- Doesn't currently support SNMPv3
- Doesn't currently support inform
- Doesn't support listening on IPv6
- Certain devices have been known to send negative TimeTicks. pyasn1
fails to handle this.

Project details


Release history Release notifications

History Node

0.6.1

History Node

0.6.0

History Node

0.5.0

History Node

0.4.3

History Node

0.4.2

History Node

0.4.1

History Node

0.3.7

History Node

0.3.6

This version
History Node

0.3.5

History Node

0.3.4

History Node

0.3.3

History Node

0.3.2

History Node

0.3.1

History Node

0.3.0

History Node

0.2.0

History Node

0.1.2

History Node

0.1.1

History Node

0.0.2

History Node

0.0.1

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
trapperkeeper-0.3.5.tar.gz (87.6 kB) Copy SHA256 hash SHA256 Source None May 13, 2014

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page