muffin-metrics 0.1.0

No project description provided

Muffin-Metrics – Send data to Graphite/StatsD from Muffin application.

Contents

• Requirements

• Installation

• Usage

  • Options

  • Usage

• Bug tracker

• Contributing

• Contributors

• License

Requirements

• python >= 3.3

Installation

Muffin-Metrics should be installed using pip:

pip install muffin-metrics

Usage

Add muffin_metrics to PLUGINS in your Muffin Application configuration.

Options

METRICS_BACKENDS – Graphite backends in format ([])

METRICS_BACKENDS = (
    ('udp': 'udp://address:port'),
    ('tcp': 'tcp://address:port'),
    ('statsd_udp': 'udp+statsd://address:port'),
    ('statsd_tcp': 'tcp+statsd://address:port'),
)
METRICS_DEFAULT = 'udp'

METRICS_DEFAULT – Default backend (None)

METRICS_FAIL_SILENTLY – Don’t raise connection’s exceptions (False)

METRICS_MAXUDPSIZE – Max size of UDP message (512)

METRICS_PREFIX – Prefix for metrics (muffin.)

Usage

@app.register('/my')
def my_view(request):
    # Context manager (group metrics to pipeline and send them as one message)
    with (yield from app.ps.metrics.client()) as metrics:
        metrics.send(42, path='answer.to.the.ultimate.question')
        # ...
        metrics.send(31, path='some.some')

    # Send data
    yield from app.ps.metrics.send(100, path='one.hungred', backend='mybackend')

    # Create client and send data
    metrics = yield from app.ps.metrics.client(backend='tcp')
    metrics.send('twenty.four', 24)
    metrics.disconnect()

    # Send data to statsd
    with (yield from app.ps.metrics.client(backend='statsd_tcp')) as client:
        client.incr('request.method.%s' % request.method)
        client.timing('response.time', timer.ms)
        client.incr('response.status.%s' % response.status)

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/muffin-metrics/issues

Contributing

Development of Muffin-Metrics happens at: https://github.com/klen/muffin-metrics

Contributors

• klen (Kirill Klenov)

License

Licensed under a MIT license.