libra/doc/statsd/drivers.rst
Andrew Hutchings 27cde75e86 Add some documentation for statsd
Change-Id: Ie93681bec4c12bfda5c3c31d34e3cb02176e252d
2013-04-19 15:51:25 +01:00

1.6 KiB

Statsd Drivers

Introduction

Statsd has a small driver API to be used for alerting. Multiple drivers can be loaded at the same time to alert in multiple places.

Design

The base class called AlertDriver is used to create new drivers. These will be supplied self.logger to use for logging and self.args which contains the arguments supplied to statsd. Drivers using this need to supply two functions:

param message

A message with details of the failure

param device_id

The ID of the device that has failed

param message

A message with details of the recovered load balancer

param device_id

The ID of the device that has been recovered

This is the dictionary that maps values for the --driver <libra_statsd.py --driver> option to a class implementing the driver :py~AlertDriver API for the statsd server. After implementing a new driver class, you simply add a new entry to this dictionary to make it a selectable option.

Dummy Driver

This driver is used for simple testing/debugging. It echos the message details into statsd's log file.

Datadog Driver

The Datadog driver uses the Datadog API to send alerts into the Datadog event stream. Alerts are sent as 'ERROR' and repairs as 'SUCCESS'.

HP REST Driver

This sends messages to the HP REST API server to mark nodes as ERROR/ONLINE.