Skip to main content

Monasca statsd Python client

Project description

Team and repository tags

https://governance.openstack.org/tc/badges/monasca-statsd.svg

A Monasca-Statsd Python Client.

Quick Start Guide

First install the library with pip or easy_install:

# Install in system python ...
sudo pip install monasca-statsd

# .. or into a virtual env
pip install monasca-statsd

Then start instrumenting your code:

# Import the module.
import monascastatsd as mstatsd

# Create the connection
conn = mstatsd.Connection(host='localhost', port=8125)

# Create the client with optional dimensions
client = mstatsd.Client(connection=conn, dimensions={'env': 'test'})

NOTE: You can also create a client without specifying the connection and it will create the client
with the default connection information for the monasca-agent statsd processor daemon
which uses host='localhost' and port=8125.

client = mstatsd.Client(dimensions={'env': 'test'})

# Increment and decrement a counter.
counter = client.get_counter(name='page.views')

counter.increment()
counter += 3

counter.decrement()
counter -= 3

# Record a gauge 50% of the time.
gauge = client.get_gauge('gauge', dimensions={'env': 'test'})

gauge.send('metric', 123.4, sample_rate=0.5)

# Sample a histogram.
histogram = client.get_histogram('histogram', dimensions={'test': 'True'})

histogram.send('metric', 123.4, dimensions={'color': 'red'})

# Time a function call.
timer = client.get_timer()

@timer.timed('page.render')
def render_page():
    # Render things ...
    pass

# Time a block of code.
timer = client.get_timer()

with timer.time('t'):
    # Do stuff
    time.sleep(2)

# Add dimensions to any metric.
histogram = client.get_histogram('my_hist')
histogram.send('query.time', 10, dimensions = {'version': '1.0', 'environment': 'dev'})

Feedback

To suggest a feature, report a bug, or participate in the general discussion, head over to StoryBoard.

License

See LICENSE file. Code was originally forked from Datadog’s dogstatsd-python, hence the dual license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

monasca-statsd-2.1.0.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

monasca_statsd-2.1.0-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file monasca-statsd-2.1.0.tar.gz.

File metadata

  • Download URL: monasca-statsd-2.1.0.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.5.2

File hashes

Hashes for monasca-statsd-2.1.0.tar.gz
Algorithm Hash digest
SHA256 4d0efbbae0b7eb7ec082a92eeeb61498c03dd98e2f093127e5d04ceb832aee77
MD5 6ceb94789f9a13dd8c72c760a3b6973c
BLAKE2b-256 854404699cac841070198f6de4f03288beeb61c0e4e72459833cfbb8494edf0e

See more details on using hashes here.

Provenance

File details

Details for the file monasca_statsd-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: monasca_statsd-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 17.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.5.2

File hashes

Hashes for monasca_statsd-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 03ce2f7090e30e1f27cd74b057e2612e9e25b570dd03c0f13a43f4e2757b10d5
MD5 cf500d024818ad4e8eafe10f6758c747
BLAKE2b-256 9eaf5c4091b4390ab95b3eba8c9549dfcc2b5c1ea684fa99abbb31c69e606a0b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page