ELM Advanced Monitoring using Prometheus and Grafana

This document offers to help client in monitoring ELM using third party tools such as Prometheus and Grafana. Prometheus is a free software application used for event monitoring and alerting. It records metrics in a time series database built using an HTTP pull model, with flexible queries and real-time alerting. Whereas Grafana helps to collect, correlate, and visualize data with beautiful dashboards.

Configuring JMX Exporter with ELM

Download link: https://github.com/prometheus/jmx_exporter
Configuring JMX Exporter with ELM:

• Create a folder called jmx_exporter under the path: /opt/IBM/JazzTeamServer/server/liberty/wlp/usr/shared/resources
• Place the “jmx_prometheus_javaagent-0.20.0.jar” to the jmx_exporter folder
• Create a config file with the name “jmx-config.yml”
• Add the below stack to the config.yml file

rules:
- pattern: "com.*"

• Save the file
• Go to the jvm.option (path:/opt/IBM/JazzTeamServer/server/liberty/servers/clm)
• Add the below parameter to the jvm.options file.

-javaagent:/opt/IBM/JazzTeamServer/server/liberty/wlp/usr/shared/resources/jmx_exporter/jmx_prometheus_javaagent-0.20.0.jar=9081:/opt/IBM/JazzTeamServer/server/liberty/wlp/usr/shared/resources/jmx_exporter/jmx-config.yml

• Save the file.
• Restart the ELM server.
• Start the server with “-clean” arguments.
• Access the Matrics with the URL: http://hostname:9081/metrics

Installing Prometheus

• Follow the below shared link to download and install a Prometheus.
• Download: https://prometheus.io/download/
• Install: https://prometheus.io/docs/introduction/first_steps/

Configuring ELM with Prometheus

• Edit the prometheus.yml file(For Reference Path: /var/snap/prometheus/current)
• Add the below stack to the .yml file which will scrap the published matrics

- job_name: '/metrics'
   static_configs:
      - targets: ['hostname:9081']

• Save the file and restart the Prometheus
• Once restarted, access the prometheus URL: http: http://hostname:9090/
• Select the status option and go to Targets
• In the Targets check the endpoint whether it is added or not, if it is added check the status it’s up or running.

Installing Grafana

Configuring Prometheus with Grafana

• Navigate to Grafana’s bin directory ex: <Grafana-Installation-Path>/bin
• Run grafana-server.exe
• Access Grafana through http://hostname:3000
  • Default port is 3000
  • Port can be changed using default.ini file located in Grafana conf directory
  • Default user-id and password is “admin”
• Click on Data sources on the left hand menu.
• Click on Add new data source > Search and select Prometheus
• Provide Prometheus URL and rest of other parameters can remain as default
• Click Save & Test

Related topics: Deployment web home, Deployment web home

External links:

• IBM

Additional contributors: TWikiUser, TWikiUser