Source code for kingpin.actors.librato

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# See the License for the specific language governing permissions and
# limitations under the License.
# Copyright 2018, Inc


The Librato Actor allows you to post an Annotation to Librato. This is
specifically useful for marking when deployments occur on your graphs for
cause/effect analysis.

**Required Environment Variables**

  Librato API Token

  Librato email account (i.e. username)


import logging
import os
import urllib

from tornado import gen
from tornado import httpclient

from kingpin import utils
from kingpin.actors import base
from kingpin.actors import exceptions
from kingpin.constants import REQUIRED

log = logging.getLogger(__name__)

__author__ = 'Charles McLaughlin <>'

API_CONTENT_TYPE = 'application/x-www-form-urlencoded'
API_URL = ''
ANNOTATIONS_URL = API_URL + 'annotations/'
METRICS_URL = API_URL + 'metrics'  # Used to test auth

TOKEN = os.getenv('LIBRATO_TOKEN', None)
EMAIL = os.getenv('LIBRATO_EMAIL', None)

[docs]class Annotation(base.HTTPBaseActor): """Librato Annotation Actor Posts an Annotation to Librato. **Options** :title: The title of the annotation :description: The description of the annotation :name: Name of the metric to annotate **Examples** .. code-block:: json { "actor": "librato.Annotation", "desc": "Mark our deployment", "options": { "title": "Deploy", "description": "Version: 0001a", "name": "production_releases" } } **Dry Mode** Currently does not actually do anything, just logs dry mode. """ all_options = { 'title': (str, REQUIRED, "Annotation title"), 'description': (str, REQUIRED, "Annotation description"), 'name': (str, REQUIRED, "Name of the metric to annotate") } desc = "Sending Annotation to {name}" def __init__(self, *args, **kwargs): """Check for the needed environment variables.""" super(Annotation, self).__init__(*args, **kwargs) if not TOKEN: raise exceptions.InvalidCredentials( 'Missing the "LIBRATO_TOKEN" environment variable.') if not EMAIL: raise exceptions.InvalidCredentials( 'Missing the "LIBRATO_EMAIL" environment variable.') @gen.coroutine @utils.retry(excs=(httpclient.HTTPError), retries=3) def _fetch_wrapper(self, *args, **kwargs): """Wrap the superclass _fetch method to catch known Librato errors.""" try: res = yield self._fetch(*args, **kwargs) except httpclient.HTTPError as e: if e.code == 400: # "HTTPError: HTTP 400: Bad Request" raise exceptions.BadRequest( 'Check your JSON inputs.') if e.code == 401: # "The authentication you provided is invalid." raise exceptions.InvalidCredentials( 'Librato authentication failed.') raise raise gen.Return(res) @gen.coroutine def _execute(self): """Executes an actor and yields the results when its finished. raises: gen.Return() """ if self._dry:'Testing Librato auth, skipping annotation') msg = ("Would have annotated metric " "'%s' with title:'%s', description:'%s'") % (self.option('name'), self.option('title'), self.option('description'))) yield self._fetch_wrapper( METRICS_URL, auth_username=EMAIL, auth_password=TOKEN) else: "Annotating metric '%s' with title:'%s', description:'%s'" % ( self.option('name'), self.option('title'), self.option('description'))) url = ANNOTATIONS_URL + self.option('name') args = urllib.urlencode( {'title': self.option('title'), 'description': self.option('description')}) yield self._fetch_wrapper(url, post=args, auth_username=EMAIL, auth_password=TOKEN) raise gen.Return()