Git Product home page Git Product logo

txairbrake's Introduction

txairbrake: Airbrake error reporting for Twisted

Build Status

Airbrake provides a service that aggregates errors from applications. This project is specifically designed for asynchronous Python Twisted code to send exceptions to an airbrake server. Unlike traditional synchronous Python code, there can be no blocking in the error reporting in a Twisted project. This library connects to the remote server in a non-blocking fashion.

Installation

easy_install txairbrake

Usage

# import the observer
from txairbrake.observers import AirbrakeLogObserver

# Create observer.  Params are api key, environment, and use SSL.  The last two are optional.
ab = AirbrakeLogObserver("mykey", "production", True)

# start observing errors
ab.start()

Controlling how HTTP Requests are made.

txairbrake uses twisted.web.client.Agent for making HTTP requests. This gives you the user a great deal of control over how the HTTP requests are made, including if persistent connections should be used, and if requests should be made through a an HTTP proxy.

Persistent Connections

# import observer, reactor, and client classes.
from txairbrake.observers import AirbrakeLogObserver
from twisted.internet import reactor
from twisted.web.client import Agent, HTTPConnectionPool

# Create a persistent connection pool and a new Agent instance.
pool = HTTPConnectionPool(reactor, persistent=True)
agent = Agent(reactor, pool)

# Set up an observer to use the preconfigured Agent.
ab = AirbrakeLogObserver("mykey", "production", True, agent=agent)

# start observing errors.
ab.start()

HTTP Proxy

# import observer, reactor, and client classes.
from txairbrake.observers import AirbrakeLogObserver
from twisted.internet import reactor
from twisted.internet.endpoints import TCP4ClientEndpoint
from twisted.web.client import ProxyAgent

# Create a client endpoint pointed at a proxy on localhost.
proxy_endpoint = TCP4ClientEndpoint(reactor, "localhost", 8000)

# Create a proxy agent that will use the client endpoint.
agent = ProxyAgent(proxy_endpoint)

# Set up an observer to use the preconfigured ProxyAgent.
ab = AirbrakeLogObserver("mykey", "production", True, agent=agent)

# start observing errors.
ab.start()

Errbit

Airbrake costs money. If you don't want to spend money, consider using Errbit, which is free and can run for free on Heroku. If you do end up using an alternative server, the observer constructor takes a final parameter that is the hostname of your airbrake-compliant server.

txairbrake's People

Contributors

bmuller avatar dreid avatar stormbrew avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.