Remote measuring abstraction for software applications.

telemetry serves as a simple facade or abstraction for various telemetry frameworks (e.g. pagerduty, slack, graphite) allowing the end user to plug in the desired telemetry framework at deployment time. Think slf4j but for events and numbers. This library borrows from their example (and copy.)

As your projects grow, their telemetry requirements will change. The purpose of this library is to simplify implementation, provide easy configuration, encourage testing, and avoid vendor lock.

This library concerns itself with metric, traces, and logging. Implementation will very on each service.

Setting up a new service should be as easy as adding your API Keys.

• pagerduty - get your PAGERDUTY_KEY from https://{yourorg}.pagerduty.com/api_keys
• slack - only needs a SLACK_ROOM_ID from your Slack Webhook App
• statsd - also useful for graphite and datadog
• datadog - requires dd statsd server running, tags and other options supported.

Telemeters preference to being configurable, but don't require more than credentials to get working. For instance, slack can be implemented with the following:

See EXCEPTIONS.md.

from telemetry import PagerDutyTelemeter

meter = PagerDutyTelemeter()

@meter.catch("your_failure_name")
def some_function():
    raise Exception("This is a test exception")

# STATSD_HOST=localhost
from telemetry import StatsdTelemeter

meter = StatsdTelemeter()  # config in environment, or as arg
meter.incr("telemetry.metric.example")

import logging
from telemetry import SlackTelemeter

logging.basicConfig(level=logging.INFO)
logging.getLogger().addHandler(SlackTelemeter())
logging.info("hello room!")

or

from telemetry import SlackTelemeter
meter = SlackTelemeter()
meter.message("your message!")

Clients are written using core python libraries, so telemetry is light weight.

You can instantiate Telemeters by using environment variables.

If you'd like to completely remove reference of telemetry from your app, you can use the python wrapper.

python -m telemetry your.module

# or if you installed scripts

telemetry your.module