diff --git a/README.md b/README.md index b1eca4ac98b0328723e0f5631a0dd1650fd6e3b6..7f9640fb6db09700f076f484dd4dc0cc14a0e286 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Picasoft metrics bot -This bot aims to collect some metrics from different services and push them to InfluxDB database. It uses Python3 and is designed to be easily extends. +This bot aims to collect some metrics from different services and push them to InfluxDB-compatible database. It uses Python3 and is designed to be easily extends. ## Usage @@ -14,11 +14,19 @@ This bot use a JSON file to get some different configuration variables it needs. Configuration for InfluxDB is under the `influxdb` key. It is a simple object with following subkeys : -- `url` : complete URL to connect to InfluxDB (eg. `https://my.influxinstance.tld`) +- `url` : complete URL to connect to InfluxDB (eg. `https://my.influxinstance.tld` ; HTTPS and HTTP supported) - `user` : A user with write access to InfluxDB - `password` : Password for the user - `database` : Database to use +If your port is not the default one (8086), you can add the `port` key. + +#### vmagent + +You can also use `vmagent` TSDB instead of InfluxDB. As it does not support the InfluxDB authentication protocol, just use `url`, `port` and `database` parameter. + +Here `database` is an arbitrary value which will be added at the end of the metrics' name. + ## Modules This bot is modular : each module provide an interface allow to collect metrics for a service. The main function use those modules and push all data to InfluxDB.