Metadata-Version: 2.1
Name: ringserverstats
Version: 0.4.1
Summary: Export logs from ringserver as influxdb timeseries
Home-page: https://github.com/resif/ringserver_stats
Author: Jonathan Schaeffer
Author-email: jonathan.schaeffer@univ-grenoble-alpes.fr
Maintainer: Jonathan Schaeffer
Maintainer-email: jonathan.schaeffer@univ-grenoble-alpes.fr
License: GPL-3.0
Description: # ringserverstats
        
        Parse ringserver reports, compute statistics and store in influxdb.
        
        ![ringserver activity][https://github.com/resif/ringserver-stats/raw/master/images/2019-02-25_09-30.png]
        
        ![ringserver statistics by day][https://github.com/resif/ringserver-stats/raw/master/images/2019-02-25_09-30_1.png]
        
        ![ringserver statistics by month][https://github.com/resif/ringserver-stats/raw/master/images/2019-02-25_09-31.png]
        
        ## Installation
        
        ringserverstats is distributed on PyPI https://pypi.org as a universal wheel.
        
        ``` bash
            $ pip install ringserverstats
        ```
        
        ## Influxdb configuration
        
        This program will fill 2 measurements. You should configure a database for these, and configure a user with write priviledges.
        
        ### Prepare database
        
        First, create a database, a user, and retention policie.
        
        ``` sql
        create database ringserverdb
        create user ringserver with password 'ringserverer'
        grant write on ringserverdb to ringserver
        grant read on ringserverdb to ringserver
        create retention policy rp_ringserverevents on ringserver duration 1w replication 1
        create retention policy rp_ringserverstats on ringserver duration 520w replication 1
        ```
        
        ## Usage
        
        To work properly, this program needs the following environment variables set :
        
          * `INFLUXDB_HOST` : The host name or adress of influxdb server
          * `INFLUXDB_PORT` : The port number of influxdb server
          * `INFLUXDB_USER` : The influxdb user to authenticate to
          * `INFLUXDB_PASS` : The password to authenticate with
          * `INFLUXDB_DB`   : The database name containing the metric
          * `INFLUXDB_VERIFY_SSL` : Set to `yes` or `no` to verify SSL connection
          * `INFLUXDB_SSL`  : Should the connection go to https ?
        
        ``` bash
        $ ringserstats txlogs.log
        ```
        
        ## Explanations
        
        The TX logs from ringserver are metrics suitable for a timeserie database. The idea is to parse the logs, as in the exemple below, and to generate values to insert into an influxdb timeseries database.
        
        The file `grafana-dashboard.json` can be imported into grafana to visualize this timeserie.
        
        Used tags in influxdb :
        
        ``` sql
        show tag keys from ringserverevents
        show tag keys from ringserverstats
        ```
        
        The ringserverevents measure has several tags :
        
          * network, station, location, channel : which data was requested
          * geohash : location of the client in geohash format
          * hosthash : a hash of the client ip (usefull to correlate the clients requests)
          * city : an english city name
        
        Because storing events in the longterm is not very relevant, the `ringserverstats` measurement groups all events by day, by host and by network. The retention policies discribed above will manage the time your data get stored in influxdb.
        
        
        ## License
        
        `ringserverstats` is distributed under the terms of the GPL v3 or later. See LICENSE file.
        
        ## Build
        
        ``` shell
        python3 setup.py sdist bdist_wheel
        ```
        
        ## Test
        
        ``` shell
        tox
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
