Metadata-Version: 2.1
Name: p3exporter
Version: 1.0.0
Summary: Python Programmable Prometheus exporter
Home-page: https://codeaffen.org/projects/p3exporter
Author: Christian Meißner
Author-email: cme@codeaffen.org
License: GPLv3
Description: # Python programmable Prometheus exporter
        
        [![PyPI version](https://badge.fury.io/py/p3exporter.svg)](https://badge.fury.io/py/p3exporter)
        [![Codacy Badge](https://app.codacy.com/project/badge/Grade/0c608f1a8a18412ba2031853b8963be7)](https://www.codacy.com/gh/codeaffen/p3exporter/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=codeaffen/p3exporter&amp;utm_campaign=Badge_Grade)
        [![Documentation Status](https://readthedocs.org/projects/p3exporter/badge/?version=develop)](https://p3exporter.readthedocs.io/en/latest/?badge=latest)
        
        This repo should help any DevOps to quickstart its Prometheus exporter development base on Python. It is a POC which shows how different packages and libraries can be put together to create your own exporter for Prometheus.
        
        The project is based on Flask as web framework and Prometheus [python-client](https://github.com/prometheus/client_python). We also provide a simple Dockerfile to enable you to build a Docker container image for your exporter as well as let it run as a simple program.
        
        ## install and run locally
        
        To install the `p3exporter` package you simply run the following command inside the project directory:
        
        ```text
        $ pip install -e .
        Obtaining file:///home/nero/Development/p3exporter
        ...
        Installing collected packages: p3exporter
          Running setup.py develop for p3exporter
        Successfully installed p3exporter
        ```
        
        From now you can run it with:
        
        ```text
        $ p3exporter
        INFO:root:Start exporter, listen on 5876
        ```
        
        ### available command line options
        
        Do determine the available command line options you can call the online help:
        
        ```text
        $ p3exporter --help
        usage: p3exporter [-h] [-c CONFIG] [-p PORT]
        
        Python programmable Prometheus exporter.
        
        optional arguments:
          -h, --help            show this help message and exit
          -c CONFIG, --config CONFIG
                                path to configuration file.
          -p PORT, --port PORT  exporter exposed port
        ```
        
        ## build image and run in docker
        
        To let the exporter run in docker you have to do the following:
        
        ```text
        $ docker build -t codeaffen/p3exporter .
        Sending build context to Docker daemon  181.8kB
        ...
        Successfully built a6bdf60489f5
        Successfully tagged codeaffen/p3exporter:latest
        ```
        
        Now you can start the container. Don't forget to expose the port to your network.
        
        ```text
        $ docker run -d -p 5876:5876 --name p3e codeaffen/p3exporter
        03e287d50cce595cec6ee66d75a663a094ba7688c761303e7e1e9ad39bde695c
        ```
        
        ## access exporter
        
        If your exporter run either as local program or as docker container you can access it with your webbrowser.
        
        ![metrics in browser](https://github.com/codeaffen/p3exporter/raw/develop/static/images/metrics.png)
        
Keywords: monitoring prometheus exporter example
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: System :: Monitoring
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
