Tech

How to Connect Prometheus with Vodia PBX

Published on:

July 24, 2024

Integrating Prometheus with Vodia PBX enables effective monitoring of your phone system’s performance. Start by creating an API account on Vodia PBX to grant access to Prometheus, followed by the installation of Prometheus on DigitalOcean. Update the prometheus.yml file to include your PBX as a target by configuring the DNS, username, and password. Explore the Vodia API for available system stats, such as CPU usage and memory. Finally, create custom stat panels in Prometheus to visualize and track these key performance metrics in real time.

Prometheus is an open-source monitoring and alerting toolkit that is part of the Cloud Native Computing Foundation. By integrating it with Vodia PBX, you can effectively monitor and manage your phone system's performance. Here’s how to get started:

Step 1: Create an API Account on Vodia PBX

To allow Prometheus to access Vodia PBX data, you need to create an API account. Follow these steps:

  1. Log in to Vodia PBX as an Administrator:
    • Navigate to the system level where you can manage user accounts.
  2. Create a New User Account for API Access:
    • Go to the Administrator section.
    • Create a new account with the following details:
      • Account: Choose a user name.
      • API Access: Enable API access.
      • Type: Set the account type to Regular.
      • Password: Set a strong, secret password.
  3. Save the Configuration:
    • Save the user account configuration.
    • Keep the username and password handy, as you will need them for Prometheus to access Vodia PBX data.
API credentils

Installing Prometheus on Digital Ocean: https://marketplace.digitalocean.com/apps/prometheus

Once your server is set up, you can access the Prometheus user interface by going to http://your_server_ip:9090/

Setting up the .yml file

By default, Prometheus is set up to monitor itself and Node Exporter. To monitor more systems, you need to update the configuration file located at: /etc/prometheus/prometheus.yml

Download Prometheus.yml

3 things need to be changed in the Prometheus .yml file config file

  • targets: ['123.vodia.com'] Here is where you will set the target - in this case it will be your PBX DNS name
  • username: 'prometheus'
  • password: 'prometheus'

Note: Do not remove the ' ' and [ ] in the config file leave it as is and change the value

Once you have edited the config file, you can modify the prometheus.yml using nano or any edit you desire by copy-pasting the config or simply creating a new .yml file and renaming the old file.

Restart the service by sudo systemctl restart prometheus

How to use Vodia API

To learn more about Vodia API, please visit us here https://api.vodia.com/#f3d2b273-75f7-4876-be45-d34858664fed

Check the Prometheus and click on System Stats - this will show all of the available APIs for Prometheus, and you will see an Example Response. Click on "view more" and it should look like this:

I have bolded all of the stats you can use as an examples, there's no need to copy the whole thing

# pbxctrl 69.3.2.beta

# HELP system_cpu_srv_max Peak usage of the CPU
# TYPE system_cpu_srv_max gauge
system_cpu_srv_max 0 1719852690061

# HELP system_cpu_srv_avg Average Load
# TYPE system_cpu_srv_avg gauge
system_cpu_srv_avg 0 1719852690061

# HELP system_cpu_ctrl_max Peak usage of the CPU
# TYPE system_cpu_ctrl_max gauge
system_cpu_ctrl_max 25 1719852690061

# HELP system_cpu_ctrl_avg Peak usage of the CPU
# TYPE system_cpu_ctrl_avg gauge
system_cpu_ctrl_avg 2 1719852690061

# HELP system_memory_all Total
# TYPE system_memory_all gauge
system_memory_all 172928 1719852690061

Creating a stat panel on Prometheus

Click "add panel" and enter the Vodia API cmd - in this case system_cpu_srv_max, then press execute: you can create many panels to monitor the PBX.

stat
Api
w
api
tcp

Latest Articles

View All

Vodia PBX and Microsoft Teams - A Phone System for Schools

Vodia PBX, integrated with Microsoft Teams, provides schools with a robust communication solution that enhances safety, efficiency, and collaboration. By combining VoIP technology with Teams, schools can seamlessly streamline communication across devices, manage emergency notifications, and optimize daily operations. A case study of Bright Future High School illustrates how this integration supports a variety of needs, from classroom phones and school bells to overhead paging systems. Vodia’s easy-to-use solution ensures that schools stay connected and responsive while simplifying their communication infrastructure for a more efficient educational environment.

February 27, 2025

Vodia Announces Integration with Cliniko

Vodia Networks is excited to announce its integration with Cliniko, a leading practice management software for healthcare providers. This integration enables seamless call handling by automatically displaying patient records from Cliniko when calls come in, allowing staff to quickly access the relevant details. The integration enhances patient interactions, streamlines workflows, and supports healthcare organizations in providing better care while maintaining HIPAA compliance and data security. Vodia’s feature-rich PBX ensures improved operational efficiency and reduced telephony costs for healthcare providers.

February 24, 2025

Vodia Visits IT Expo 2025

Vodia was excited to attend IT Expo 2025 in Ft. Lauderdale, where Sales Engineer Eric Altman connected with industry leaders such as Tommy Lee from Fanvil, Gary Harbeck from Dinstar, Spencer Lee from Telin, Sebastian Balan from Fidelity, Todd Weikle from Soar Communications, Steve Scott from Borderless.com, and Mitch Kahl from BCM One. The discussions highlighted the role of AI in business communications, Vodia’s Microsoft Teams-certified PBX, and our integration with Realtime AI via APIs. This event followed a strategic planning session with key partners to outline Vodia’s goals for 2025. We look forward to connecting with you at future events!

February 19, 2025