FreeSWITCH exporter for the Prometheus monitoring system.
Project description
This is an exporter that exposes information gathered from FreeSWITCH for use by the Prometheus monitoring system.
Installation
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
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:
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:
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file prometheus-freeswitch-exporter-1.0.1.tar.gz
.
File metadata
- Download URL: prometheus-freeswitch-exporter-1.0.1.tar.gz
- Upload date:
- Size: 9.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a499563ff13e31c29db5610f440baab77543ad2bd04eee09a66ed0917b8a2a7 |
|
MD5 | 9c7d6d0ef78ab8b2918db0cdd41741a6 |
|
BLAKE2b-256 | a6ed7a7790f37b978fcc4152260b701ab55f022bd6bacb418021c3fd84b15700 |
File details
Details for the file prometheus_freeswitch_exporter-1.0.1-py3-none-any.whl
.
File metadata
- Download URL: prometheus_freeswitch_exporter-1.0.1-py3-none-any.whl
- Upload date:
- Size: 13.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5fbdc3a89a6ca7aee842cbb5e76b74aac112eacb6ae838cf83504dd321fcac3 |
|
MD5 | a7961ed83319212336c50d4f27e1421d |
|
BLAKE2b-256 | b41787faaf708d9a460b6f311239a769d4a5115299f5896151ad0670891d8d1d |