Skip to main content

Monasca statsd Python client

Project description

Team and repository tags
========================

[![Team and repository tags](https://governance.openstack.org/badges/monasca-statsd.svg)](https://governance.openstack.org/reference/tags/index.html)

<!-- Change things from this point on -->

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'})
```
Repository
-------------

The monasca-statsd code is located here:
[here](https://github.com/stackforge/monasca-statsd).

Feedback
--------

To suggest a feature, report a bug, or general discussion, head over
[here](https://bugs.launchpad.net/monasca).


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-1.7.0.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

monasca_statsd-1.7.0-py2.py3-none-any.whl (16.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for monasca-statsd-1.7.0.tar.gz
Algorithm Hash digest
SHA256 14e212945ddc0311e63498fdd0199d18b54c6192713c81f778d6cf7d9fb8c671
MD5 48924dac3959d64efa2126aa58b26389
BLAKE2b-256 842c3c34c2f37049ad410cf47e8319afb29e56f97f31905c81e4f32574348446

See more details on using hashes here.

File details

Details for the file monasca_statsd-1.7.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for monasca_statsd-1.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f92b0b479bfd45d98540b606ac65ad6c149c03b54d8b9080ca114f7f00f03db9
MD5 1f3713380e095eb8961bae71c431fd03
BLAKE2b-256 79809e92d8a4e643b52681cc8a51699315a9c55fcad1c2cd0dceb646c027cc61

See more details on using hashes here.

Supported by

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