Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.71 KB

README.md

File metadata and controls

51 lines (33 loc) · 1.71 KB

aiotelegraf Build Status codecov Updates Code style: black

An asyncio-base client for sending metrics to Telegraf.

Implementation based on pytelegraf package.

Installation

$ pip install aiotelegraf

Usage

import asyncio
import aiotelegraf

loop = asyncio.get_event_loop()
r = loop.run_until_complete

client = aiotelegraf.Client(
    host='0.0.0.0',
    port=8089,
    tags={
        'my_global_tag_1': 'value_1',
        'my_global_tag_2': 'value_2',
    }
)
r(client.connect())

client.metric('my_metric_1', 'value_1', tags={
    'my_tag_1': 'value_1',
})
r(client.close())

Contributing

To work on the aiotelegraf codebase, you'll want to clone the project locally and install the required dependencies via poetry:

$ git clone [email protected]:Gr1N/aiotelegraf.git
$ poetry install

To run tests and linters use command below:

$ poetry run tox

If you want to run only tests or linters you can explicitly specify which test environment you want to run, e.g.:

$ poetry run tox -e py37-tests

License

aiotelegraf is licensed under the MIT license. See the license file for details.