Skip to content

Latest commit

 

History

History
121 lines (88 loc) · 3.65 KB

api.rst

File metadata and controls

121 lines (88 loc) · 3.65 KB
Raw

Sprockets InfluxDB API

To use the InfluxDB client, you need to install it into the runtime environment. To do so, you use the ~sprockets_influxdb.install method. Then metrics can be added by creating instances of the ~sprockets_influxdb.Measurement class and then adding them to the write buffer by calling ~sprockets_influxdb.add_measurement. In the following example, a measurement is added to the example InfluxDB database with the measurement name of measurement-name. When the IOLoop is started, the stop method is invoked which calls ~sprockets_influxdb.shutdown. ~sprockets_influxdb.shutdown ensures that all of the buffered metrics are written before the IOLoop is stopped.

Measurements will be sent in batches to InfluxDB when there are INFLUXDB_TRIGGER_SIZE measurements in the buffer or after INFLUXDB_INTERVAL milliseconds have passed since the last measurement was added, which ever occurs first.

The timeout timer for submitting a buffer of < INFLUXDB_TRIGGER_SIZE measurements is only started when there isn't an active timer, there is not a batch currently being written, and a measurement is added to the buffer.

import logging

import sprockets_influxdb as influxdb
from tornado import ioloop

logging.basicConfig(level=logging.INFO)

io_loop = ioloop.IOLoop.current()
influxdb.install(io_loop=io_loop)

measurement = influxdb.Measurement('example', 'measurement-name')
measurement.set_tag('foo', 'bar')
measurement.set_field('baz', 1.05)

influxdb.add_measurement(measurement)

def stop():
    influxdb.shutdown()
    io_loop.stop()

io_loop.add_callback(stop)
io_loop.start()

If you are writing a Tornado web application, you can automatically instrument all of your Request Handlers by adding the ~sprockets_influxdb.InfluxDBMixin:

import logging
import os

import sprockets_influxdb as influxdb
from tornado import ioloop, web


class RequestHandler(influxdb.InfluxDBMixin,
                     web.RequestHandler):

    def get(self, *args, **kwargs):
        self.write({'hello': 'world'})


if __name__ == '__main__':
    logging.basicConfig(level=logging.INFO)

    os.environ['ENVIRONMENT'] = 'development'
    os.environ['SERVICE'] = 'example'

    io_loop = ioloop.IOLoop.current()

    application = web.Application([
        (r"/", RequestHandler),
    ], **{influxdb.REQUEST_DATABASE: 'example'})
    application.listen(8888)
    influxdb.install(io_loop=io_loop)
    try:
        io_loop.start()
    except KeyboardInterrupt:
        logging.info('Stopping')
        influxdb.shutdown()
        io_loop.stop()
        logging.info('Stopped')

Core Methods

sprockets_influxdb.install

sprockets_influxdb.add_measurement

sprockets_influxdb.shutdown

Measurement Class

sprockets_influxdb.Measurement

Configuration Methods

sprockets_influxdb.set_auth_credentials

sprockets_influxdb.set_base_url

sprockets_influxdb.set_io_loop

sprockets_influxdb.set_max_batch_size

sprockets_influxdb.set_max_buffer_size

sprockets_influxdb.set_clients

sprockets_influxdb.set_timeout

sprockets_influxdb.set_trigger_size

Request Handler Mixin

sprockets_influxdb.InfluxDBMixin

Other

sprockets_influxdb.flush