Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If you have already installed the Prometheus server, you can skip ahead to the steps for installing the Prometheus adapter here.

For more information about EC Deployments, refer to Execution Context Deployments (ECDs) (3.0).

...

You will need to install Helm3 first before installing Prometheus following the examples listed below. If you already have helm installed from when you installed Usage Engine, then you can skip this step.

Configuring JMX exporter for Platform

You can enable the JMX exporter for your Platform. If you want Prometheus to scrape the metrics from Platform, you should configure the JMX exporter, as it exposes and exports all the metrics in your Platform for the Prometheus server to pick up.

The value field in the values.yaml file for your Platform is platform.export.jmx.enabled. Setting this value to true enables the Prometheus server to scrape the JMX metrics from the Platform. Additionally, you can configure a port for your JMX exporter using platform.export.jmx.port and assigning it any port number allows the JMX exporter to expose the metrics on that particular port.

...

titleNote!

You need to expose the JMX port on your Platform if you have applied the changes to the values.yaml on an already installed Platform. You can use this command to forward the port.

Code Block
kubectl port-forward <pod name> <arbitrary port>:<jmx port defined in debug.jmx.port>

...

titleExample
Code Block
kubectl port-forward platform-0 30103:8888

...

titleExample: values.yaml file with JMX exporter enabled for Platform

This is an example of a values.yaml file where the JMX exporter is enabled for Platform on port 8888.

Code Block
usage-engine-private-edition / values.yaml:
    jmx:
	  export:
        enabled: true
	    port: 8888

Installing Prometheus without Persistence

...