Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrichar1/exporter_proxy
A small pure-python Reverse HTTP proxy for Prometheus exporters with TLS support.
https://github.com/mrichar1/exporter_proxy
exporters node-exporter prometheus proxy reverse-proxy ssl tls tls-proxy
Last synced: about 1 month ago
JSON representation
A small pure-python Reverse HTTP proxy for Prometheus exporters with TLS support.
- Host: GitHub
- URL: https://github.com/mrichar1/exporter_proxy
- Owner: mrichar1
- License: agpl-3.0
- Created: 2020-10-26T10:38:16.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-28T10:42:54.000Z (about 3 years ago)
- Last Synced: 2024-08-02T16:01:50.715Z (3 months ago)
- Topics: exporters, node-exporter, prometheus, proxy, reverse-proxy, ssl, tls, tls-proxy
- Language: Python
- Homepage:
- Size: 31.3 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# exporter_proxy
A small pure-python Reverse HTTP proxy for [Prometheus](https://prometheus.io) exporters with TLS support.
# Installation
`exporter_proxy` can be downloaded and run as a standalone script. `setup.py` is provided for simplifying package builds.
Since it is pure-python, `exporter_proxy` should run on any OS with Python built with SSL support. It has been tested on Linux and Windows.
# Use
```
exporter_proxy --help
usage: exporter_proxy [-h] [-c CONFIG]
Command-line options
optional arguments:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
Path to config file. (Defaults to: /etc/prometheus/exporter_proxy.ini)
```
# Configuration
The configuration is held in an `ini-file`. The section title must be `[exporter_proxy]`. See `config.ini` as an example.
The following configuration options are available:
* _proxy_address_ - The address to bind the proxy listener to.
* _proxy_port_ - The port to bind the proxy listener to.
* _server_url_ - The URL (optionally including port) of the server to proxy.
* _ssl_cert_ - Path to file containing the public certificate or chain for the proxy server (optional - if set enables SSL).
* _ssl_key_ - Path to file containing the certificate key for the proxy server. (optional, if key is in the certfile).
* _ssl_verify_ - Should client certificate verification be performed. (optional).
* _ssl_clients_ - A space-separated list of allowed clients. Matches entries in the client certificate `subjectAltName` field (optional - requires `ssl_verify` to be set).
## Prometheus
The documentation on configuring Prometheus to scrape using TLS is here: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#tls_config
TLS is configured separately for each scrape job:
```
scrape_configs:
- job_name: node
scheme: https
tls_config:
cert_file: /etc/prometheus/exporter_proxy.crt
key_file: /etc/prometheus/exporter_proxy.key
file_sd_configs:
- files:
- /etc/prometheus/targets.d/node_targets.json
```
# Multiple Exporters
`[email protected]` is an example `systemd` 'instance' service that will start an instance of `exporter_proxy` by loading a config file based on the instance name.
For example `systemctl start exporter_proxy@node` would run using the config in `/etc/prometheus/exporter_proxy/node.ini`