Metadata-Version: 2.0
Name: telegraf-pgbouncer
Version: 0.1.0
Summary: pgBouncer Stats Collector for Telegraf
Home-page: https://github.com/gmr/telegraf-pgbouncer
Author: Gavin M. Roy
Author-email: gavinmroy@gmail.com
License: BSD
Keywords: static website generation
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: BSD License
Classifier: Topic :: System :: Monitoring
Requires-Dist: psycopg2-binary

telegraph-pgbouncer
===================
Poll `pgBouncer <http://pgbouncer.github.io>`_ for stats to submit to
`Telegraf <https://github.com/influxdata/telegraf>`_ using the
`Exec Input Plugin <https://github.com/influxdata/telegraf/tree/master/plugins/inputs/exec>`_.

|Version| |License|

Usage
-----
The application is meant to be used via the Exec Input Plugin

Example Telegraf Configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block::

   [[inputs.exec]]
     ## Commands array
     commands = [
       "telegraf-pgbouncer -h localhost -p 6432 -U monitor all"
     ]
     timeout = "5s"
     data_format = "json"

CLI Usage
^^^^^^^^^

.. code-block::

   $ telegraf-pgbouncer --help
   usage: pgBouncer Stats Collector for Telegraf

   positional arguments:
     COMMAND               The SHOW command to run for extracting stats. Choices:
                           all, lists, databases, mem, pools, stats

   optional arguments:
     -h HOST, --host HOST  database server host or socket directory (default: localhost)
     -p PORT, --port PORT  database server port number (default: 5432)
     -U USERNAME, --username USERNAME
                           The PostgreSQL username to operate as (default: pgbouncer)
     -W, --password        Force password prompt (should happen automatically)
                           (default: False)
     -v, --version         output version information, then exit
     -?, --help            show this help, then exit

Authentication
^^^^^^^^^^^^^^
Specify the password in a `.pgpass <https://www.postgresql.org/docs/current/static/libpq-pgpass.html>`_ file
for the application to connect properly without specifying a password.

.. |Version| image:: https://img.shields.io/pypi/v/telegraf-pgbouncer.svg?
   :target: https://pypi.org/project/telegraf-pgbouncer

.. |License| image:: https://img.shields.io/pypi/l/telegraf-pgbouncer.svg?
   :target: https://pypi.org/project/telegraf-pgbouncer


