Convert README.md to ReStructuredTest format
Change-Id: I693ec76e2bd94573caa667cc49155de358a433f3 story: 2002163 task: 22597
This commit is contained in:
Denis Poisson
parent
3115cdca8f
commit
628efb6026
90
README.md
90
README.md
|
|
@ -1,90 +0,0 @@
|
|||
Team and repository tags
|
||||
========================
|
||||
|
||||
[](https://governance.openstack.org/tc/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'})
|
||||
```
|
||||
|
||||
Feedback
|
||||
--------
|
||||
|
||||
To suggest a feature, report a bug, or participate in the general discussion,
|
||||
head over to [StoryBoard](https://storyboard.openstack.org/#!/project/872).
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
See LICENSE file.
|
||||
Code was originally forked from Datadog's dogstatsd-python, hence the dual license.
|
||||
|
|
@ -0,0 +1,93 @@
|
|||
Team and repository tags
|
||||
========================
|
||||
|
||||
.. image:: https://governance.openstack.org/tc/badges/monasca-statsd.svg
|
||||
:target: https://governance.openstack.org/tc/reference/tags/index.html
|
||||
|
||||
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.
|
||||
|
||||
.. _Team and repository tags: https://governance.openstack.org/tc/reference/tags/index.html
|
||||
.. _StoryBoard: https://storyboard.openstack.org/#!/project/872
|
||||
Loading…
Reference in New Issue