Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/znerol/prometheus-freeswitch-exporter
Exposes information gathered from FreeSWITCH for use by the Prometheus monitoring system
https://github.com/znerol/prometheus-freeswitch-exporter
Last synced: 2 months ago
JSON representation
Exposes information gathered from FreeSWITCH for use by the Prometheus monitoring system
- Host: GitHub
- URL: https://github.com/znerol/prometheus-freeswitch-exporter
- Owner: znerol
- License: apache-2.0
- Created: 2020-04-21T14:34:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-20T19:27:06.000Z (over 2 years ago)
- Last Synced: 2024-08-08T20:15:31.369Z (5 months ago)
- Language: Python
- Size: 28.3 KB
- Stars: 13
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
README
Prometheus FreeSWITCH Exporter
==============================
|Build Status| |Package Version|
This is an exporter that exposes information gathered from FreeSWITCH for use
by the Prometheus monitoring system.
Installation
------------
.. code:: shell
pip install prometheus-freeswitch-exporter
Usage
-----
::
usage: freeswitch_exporter [-h] [config] [port]
positional arguments:
config Path to configuration file (esl.yml)
port Port on which the exporter is listening (9724)
address Address to which the exporter will bind
optional arguments:
-h, --help show this help message and exit
Use `::` for the `address` argument in order to bind to both IPv6 and IPv4
sockets on dual stacked machines.
Visit http://localhost:9724/esl?target=1.2.3.4 where 1.2.3.4 is the IP of
FreeSWITCH to get metrics from. Specify the ``module`` request parameter, to
choose which module to use from the config file.
The ``target`` request parameter defaults to ``localhost``. Hence if
``freeswitch_exporter`` is deployed directly on the FreeSWITCH host, ``target``
can be omitted.
See the wiki_ for more examples and docs.
Authentication
--------------
Example ``esl.yml``
.. code:: yaml
default:
port: 8021 # default port, can be omitted
password: ClueCon
FreeSWITCH Configuration
------------------------
For security reasons it is essential to change the default passwort in
FreeSWITCH `autoload_configs/event_socket.conf.xml`.
Prometheus Configuration
------------------------
The FreeSWITCH exporter can be deployed either directly on a FreeSWITCH node or
onto a separate machine.
Example config for FreeSWITCH exporter running on FreeSWITCH node:
.. code:: yaml
scrape_configs:
- job_name: 'freeswitch'
static_configs:
- targets:
- 192.168.1.2:9724 # FreeSWITCH node with FreeSWITCH exporter.
- 192.168.1.3:9724 # FreeSWITCH node with FreeSWITCH exporter.
metrics_path: /esl
params:
module: [default]
Example config for FreeSWITCH exporter running on Prometheus host:
.. code:: yaml
scrape_configs:
- job_name: 'freeswitch'
static_configs:
- targets:
- 192.168.1.2 # FreeSWITCH node.
- 192.168.1.3 # FreeSWITCH node.
metrics_path: /esl
params:
module: [default]
relabel_configs:
- source_labels: [__address__]
target_label: __param_target
- source_labels: [__param_target]
target_label: instance
- target_label: __address__
replacement: 127.0.0.1:9724 # FreeSWITCH exporter.
Grafana Dashboards
------------------
None yet.
.. |Build Status| image:: https://github.com/znerol/prometheus-freeswitch-exporter/actions/workflows/ci.yml/badge.svg
:target: https://github.com/znerol/prometheus-freeswitch-exporter/actions/workflows/ci.yml
.. |Package Version| image:: https://img.shields.io/pypi/v/prometheus-freeswitch-exporter.svg
:target: https://pypi.python.org/pypi/prometheus-freeswitch-exporter
.. _wiki: https://github.com/znerol/prometheus-freeswitch-exporter/wiki