{"id":16994629,"url":"https://github.com/znerol/prometheus-freeswitch-exporter","last_synced_at":"2025-04-12T05:25:04.834Z","repository":{"id":53089872,"uuid":"257623754","full_name":"znerol/prometheus-freeswitch-exporter","owner":"znerol","description":"Exposes information gathered from FreeSWITCH for use by the Prometheus monitoring system","archived":false,"fork":false,"pushed_at":"2022-09-20T19:27:06.000Z","size":29,"stargazers_count":13,"open_issues_count":1,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-04T16:49:43.935Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/znerol.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-21T14:34:57.000Z","updated_at":"2024-11-26T01:20:21.000Z","dependencies_parsed_at":"2022-09-12T12:23:01.183Z","dependency_job_id":null,"html_url":"https://github.com/znerol/prometheus-freeswitch-exporter","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/znerol%2Fprometheus-freeswitch-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/znerol%2Fprometheus-freeswitch-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/znerol%2Fprometheus-freeswitch-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/znerol%2Fprometheus-freeswitch-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/znerol","download_url":"https://codeload.github.com/znerol/prometheus-freeswitch-exporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239889001,"owners_count":19713702,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-14T03:46:06.116Z","updated_at":"2025-02-20T21:31:30.575Z","avatar_url":"https://github.com/znerol.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Prometheus FreeSWITCH Exporter\n==============================\n\n|Build Status| |Package Version|\n\nThis is an exporter that exposes information gathered from FreeSWITCH for use\nby the Prometheus monitoring system.\n\nInstallation\n------------\n\n.. code:: shell\n\n    pip install prometheus-freeswitch-exporter\n\nUsage\n-----\n\n::\n\n    usage: freeswitch_exporter [-h] [config] [port]\n\n    positional arguments:\n      config      Path to configuration file (esl.yml)\n      port        Port on which the exporter is listening (9724)\n      address     Address to which the exporter will bind\n\n    optional arguments:\n      -h, --help  show this help message and exit\n\nUse `::` for the `address` argument in order to bind to both IPv6 and IPv4\nsockets on dual stacked machines.\n\nVisit http://localhost:9724/esl?target=1.2.3.4 where 1.2.3.4 is the IP of\nFreeSWITCH to get metrics from. Specify the ``module`` request parameter, to\nchoose which module to use from the config file.\n\nThe ``target`` request parameter defaults to ``localhost``. Hence if\n``freeswitch_exporter`` is deployed directly on the FreeSWITCH host, ``target``\ncan be omitted.\n\nSee the wiki_  for more examples and docs.\n\nAuthentication\n--------------\n\nExample ``esl.yml``\n\n.. code:: yaml\n\n    default:\n        port: 8021  # default port, can be omitted\n        password: ClueCon\n\nFreeSWITCH Configuration\n------------------------\n\nFor security reasons it is essential to change the default passwort in\nFreeSWITCH `autoload_configs/event_socket.conf.xml`.\n\nPrometheus Configuration\n------------------------\n\nThe FreeSWITCH exporter can be deployed either directly on a FreeSWITCH node or\nonto a separate machine.\n\nExample config for FreeSWITCH exporter running on FreeSWITCH node:\n\n.. code:: yaml\n\n    scrape_configs:\n      - job_name: 'freeswitch'\n        static_configs:\n          - targets:\n            - 192.168.1.2:9724  # FreeSWITCH node with FreeSWITCH exporter.\n            - 192.168.1.3:9724  # FreeSWITCH node with FreeSWITCH exporter.\n        metrics_path: /esl\n        params:\n          module: [default]\n\nExample config for FreeSWITCH exporter running on Prometheus host:\n\n.. code:: yaml\n\n    scrape_configs:\n      - job_name: 'freeswitch'\n        static_configs:\n          - targets:\n            - 192.168.1.2  # FreeSWITCH node.\n            - 192.168.1.3  # FreeSWITCH node.\n        metrics_path: /esl\n        params:\n          module: [default]\n        relabel_configs:\n          - source_labels: [__address__]\n            target_label: __param_target\n          - source_labels: [__param_target]\n            target_label: instance\n          - target_label: __address__\n            replacement: 127.0.0.1:9724  # FreeSWITCH exporter.\n\nGrafana Dashboards\n------------------\n\nNone yet.\n\n.. |Build Status| image:: https://github.com/znerol/prometheus-freeswitch-exporter/actions/workflows/ci.yml/badge.svg\n   :target: https://github.com/znerol/prometheus-freeswitch-exporter/actions/workflows/ci.yml\n.. |Package Version| image:: https://img.shields.io/pypi/v/prometheus-freeswitch-exporter.svg\n   :target: https://pypi.python.org/pypi/prometheus-freeswitch-exporter\n.. _wiki: https://github.com/znerol/prometheus-freeswitch-exporter/wiki\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fznerol%2Fprometheus-freeswitch-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fznerol%2Fprometheus-freeswitch-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fznerol%2Fprometheus-freeswitch-exporter/lists"}