Python Statsd library for sending statsd messages via the Monasca Agent
Go to file
Michael James Hoppal 256eb97e03 Add in HPE Copyrights
Change-Id: I85db3a2e4e3550cbed90a9cd1875b3ebbdbe699f
2016-01-27 12:57:08 -07:00
docs Adding python client for statsd messages 2014-09-23 07:55:58 -06:00
monascastatsd Add in HPE Copyrights 2016-01-27 12:57:08 -07:00
statsd-generator Add HP Copyright 2015-08-19 10:41:08 -06:00
tests Add HP Copyright 2015-08-19 10:41:08 -06:00
.gitignore Adding python client for statsd messages 2014-09-23 07:55:58 -06:00
.gitreview Update .gitreview for new namespace 2015-10-17 22:31:04 +00:00
LICENSE Adding python client for statsd messages 2014-09-23 07:55:58 -06:00
README.md Refactored statsd code to be modular 2014-11-18 15:23:30 -07:00
Rakefile Adding python client for statsd messages 2014-09-23 07:55:58 -06:00
mkdocs.yml Added a config file for documentation generation using Markdown and readthedocs.org. 2015-02-24 00:16:20 +00:00
requirements.txt Adding python client for statsd messages 2014-09-23 07:55:58 -06:00
setup.cfg Adding python client for statsd messages 2014-09-23 07:55:58 -06:00
setup.py Add in HPE Copyrights 2016-01-27 12:57:08 -07:00
test-requirements.txt Adding python client for statsd messages 2014-09-23 07:55:58 -06:00
tox.ini Delete python bytecode before every test run 2015-12-02 13:35:33 +09:00

README.md

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.

Feedback

To suggest a feature, report a bug, or general discussion, head over here.

License

Copyright (c) 2014 Hewlett-Packard Development Company, L.P.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.