Petals Documentation > Petals ESB > Petals ESB 5.5.0 > Page Comparison - Monitoring Petals ESB with Prometheus (v.2 vs v.3)

Monitoring Petals ESB with Prometheus

Version 2 by Pierre Souquet
on Sep 27, 2018 13:51.
<< Changes from 1 to 2
compared with
Version 3 by Pierre Souquet
on Sep 27, 2018 14:32.
Changes from 3 to 4 >>
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (29)

View Page History
h1. Prometheus
h1. Connecting to Petals JMX


h2. Connecting to Petals JMX

Petals exposes its metrics on [JMX|https://en.wikipedia.org/wiki/Java_Management_Extensions], but Prometheus itself cannot natively gather metrics through JMX. So we need to expose those metrics on HTTP, which Prometheus can access.&nbsp; &nbsp;
Luckily Prometheus maintains&nbsp;[jmx_exporter|https://github.com/prometheus/jmx_exporter]&nbsp;which exposes metrics on HTTP. It can either act as a java agent injected into the [JVM|https://en.wikipedia.org/wiki/Java_virtual_machine]&nbsp;during Petals ESB startup or an independent server connecting to Petals ESB by [RMI|https://en.wikipedia.org/wiki/Java_remote_method_invocation].

h3. Official packages jmx_exporter :
h2. Installing jmx_exporter :


...

* Copy *jmx_prometheus_javaagent-XXX.jar* in _petals-esb-directory/lib_ folder
* Create a yaml config file in _petals-esb-directory/conf_ folder, here it is named *prometheus-jmx.yaml*

* Create a yaml config file in _petals-esb-directory/conf_ folder, here it is named *prometheus-jmx.yaml*. The file can be empty for now, but this default config will display everything available : :{code}

{code}
startDelaySeconds: 0
rules:
-pattern: ".*"
{code}
* Add the following line to *petals-esb.sh*, just before the “_exec_” command at the very end of the script. _8585_ is the port number on which HTTP metrics will be exposed (once gathered by the jmx_exporter), set is as you see fit.
* Add the following line to *petals-esb.sh*, just before the “_exec_” command at the very end of the script. If necessary, change the version number to match the jar file you downloaded.&nbsp;_8585_ is the port number on which HTTP metrics will be exposed (once gathered by the jmx_exporter), set is as you see fit.{code}JAVA_OPTS="$JAVA_OPTS -javaagent:${PETALS_LIB_DIR}/jmx_prometheus_javaagent-0.3.1.jar=8585:${PETALS_CONF_DIR}/prometheus-jmx.yaml"{code}

{code}JAVA_OPTS="$JAVA_OPTS -javaagent:${PETALS_LIB_DIR}/jmx_prometheus_javaagent-0.3.1.jar=8585:${PETALS_CONF_DIR}/prometheus-jmx.yaml"{code}

* Run _petals-esb.sh_
* JVM metrics are available at [*http://localhost:8585/metrics*|http://localhost:8484/metrics*]
* Metrics are available at *[http://localhost:8585/metrics|http://localhost:8484/metrics*]*


{color:#492562}{*}Install Prometheus{*}{color}
h2. Install Prometheus

* Install : [https://prometheus.io/docs/prometheus/latest/getting_started/|https://prometheus.io/docs/prometheus/latest/getting_started/]

use this *prometheus.yml* config:

{code}
# my global config
* Configure Prometheus, here is a sample&nbsp;*prometheus.yml* config:{code}
global:
scrape_interval: 5s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
evaluation_interval: 5s # Evaluate rules every 15 seconds. The default is every 1 minute.
scrape_interval: 5s
evaluation_interval: 5s

# A scrape configuration containing exactly one endpoint to scrape:
# Here it's Prometheus itself.
scrape_configs:
# The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
- job_name: 'petals monitoring'

# Override the global default and scrape targets from this job every 5 seconds.
scrape_interval: 5s

# metrics_path defaults to '/metrics'
# scheme defaults to 'http'.
static_configs:
- targets: ['localhost:8484'] ['localhost:8585']
labels:
groups: 'petals'
{code}
* Start Prometheus : {code}./prometheus --config.file=prometheus.yml{code}


h2. Configure Configuring jmx agent

Jmx agent can be configured in its yaml config file.

Note that :
* Only numeric values are supported by pPrometheus (though string can me interpreted as regexp to extract numeric values)
* Custom and complex objects may not be exported by the exporter, having ‘\- pattern “.*”’ as only rule will return every metric available (useful for testing).&nbsp;
* Container MBeans are all typed as Map, so are ignored by the jmx agent. To have
* Rules order is important: Eventually, a single MBean is processed by a single rule\! To decide which rule is applied: MBeans will be parsed by each rule (in order) until a pattern matches, then this rule is applied to the MBean. In other words, all rules are tested against each MBean the first one to match is kept for the MBean. So very specific rules should be put first, and generic/default rules last.

Rule samples :
...