Page Comparison

...

The following must be completed before setting up Prometheus:

• Download and install the version of Prometheus compatible with your bare metal setup. You can download Prometheus from Download | Prometheus.

...

...

• Configuring JMX Exporter for Platform

Downloading Prometheus

1. Once you have downloaded the Prometheus, extract the .zip file.

2. Create a yaml file named prometheus_mz.yaml as follows.

   Code Block

   # my global config global: scrape_interval: 15s # Set the scrape interval to every 15 seconds. Default is every 1 minute. evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute. # scrape_timeout is set to the global default (10s). # 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: 'prometheus' # # metrics_path defaults to '/metrics' # # scheme defaults to 'http'. # static_configs: # - targets: ['localhost:9090'] - job_name: 'mz' static_configs: - targets: ['localhost:8888'] # port defined in the topo STR config labels: pico: 'platform' - targets: ['localhost:9090'] # port defined in the topo STR config labels: pico: 'ec1'

Configuring JMX exporter for Platform

You can enable the JMX exporter for your Platform . If you want to allow Prometheus to scrape metrics. To enable Prometheus to scrape the metrics from your Platform, you should need to configure the JMX exporter, as it exposes and exports exporter. This exporter will expose and export all the metrics in from your Platform for the , allowing Prometheus server to pick upcollect them.

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

...

the specified port.

To configure the JMX exporter,

1. Create a yaml file named jmxExport.yml as follows.
   For more information on the yaml file, refer to jmx_exporter/docs at main · prometheus/jmx_exporter (github.com).

   Code Block
   startDelaySeconds: 0 ssl: false lowercaseOutputName: false lowercaseOutputLabelNames: false

2. Add the following jvmargs to the platform topo configuration:

   Code Block
   mzsh topo set topo://container:main1/pico:platform/obj:config.jvmargs.args \ '["-javaagent:common/lib/jmx_prometheus_javaagent.jar=8888:<path>/jmxExporter.yaml"]'

3. Restart the Platform.

<jdkarg value="-javaagent:common/lib/jmx_prometheus_javaagent-0.15.0.jar=9190:/mz/prometheus/prometheus-jmx-exporter.xml"/>

Starting a Prometheus

To start the Prometheus, use the following command:

./prometheus --config.file=prometheus_mz.yml --web.listen-address=:10090

On Private Cloud and AWS

This is a step-by-step installation instruction, using helm to install Prometheus with or without persistence. As this is just one example provided to install Prometheus, you can definitely install the Prometheus server and adapter in however way you want to.

Additionally, should you choose to use the metrics data to configure auto scaling for EC Deployments, you need to install a Prometheus adapter along with your Prometheus server.

If you have not installed the Prometheus server, proceed with the steps from prerequisites until the very end.

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 /wiki/spaces/DRXXE/pages/6210290.

Prerequisite

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 , 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.

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

kubectl port-forward platform-0 30103:8888

...

mediationzone / values.yaml:
    jmx:
	  export:
        enabled: true
	    port: 8888

Installing Prometheus without Persistence

The following steps show how to install the Prometheus server without the use of persistence. Be aware that your metrics data will not be retained should your deployment be brought down. We do not recommend deploying Prometheus without persistence into a production environment.

1. Add the helm repo for Prometheus.

   Code Block
   helm repo add prometheus-community https://prometheus-community.github.io/helm-charts

2. Install Prometheus using the helm install command. For this example, we opted to install the Prometheus server in its own namespace called prometheus.  Enter the value of the port you want the Prometheus server node port to be configured with

   Code Block
   helm install -n <namespace> prometheus prometheus-community/prometheus \ --set server.persistentVolume.enabled=false \ --set server.service.type=NodePort \ --set server.service.nodePort=<port> \ --set alertmanager.persistentVolume.enabled=false

   Info
   title Example: helm install Prometheus
   Code Block helm install -n prometheus prometheus prometheus-community/prometheus \ --set server.persistentVolume.enabled=false \ --set server.service.type=NodePort \ --set server.service.nodePort=31010 \ --set alertmanager.persistentVolume.enabled=false

Installing Prometheus with Persistence

The following steps show how to install the Prometheus server with the use of persistence volumes on your Kubernetes cluster.

1. Create a yaml file and describe the Persistent Volume and Persistent Volume Claim for your Prometheus server. The example used here creates the persistent volume on an NFS file server that is mounted onto the cluster. The value set in nfs.path is the directory on the NFS file server that stores the metrics data.

   Info
   title Example: Persistence for Prometheus
   Code Block apiVersion: v1 kind: PersistentVolume metadata: name: prometheus spec: accessModes: - ReadWriteMany capacity: storage: 10Gi nfs: path: /export/snap/metrics/prometheus server: 192.154.14.120 persistentVolumeReclaimPolicy: Retain storageClassName: prometheus-persistent --- apiVersion: v1 kind: PersistentVolumeClaim metadata: name: prometheus-persistent spec: accessModes: - ReadWriteMany resources: requests: storage: 10Gi storageClassName: prometheus-persistent

2. After creating the yaml file, run this command:

   Code Block
   kubectl apply -f <persistent volume yaml> -n <namespace>

3. Add the helm repo for Prometheus.

   Code Block
   helm repo add prometheus-community https://prometheus-community.github.io/helm-charts

4. Install Prometheus using the helm install command. For this example, we opted to install the Prometheus server in its own namespace called prometheus.  Enter the value of the port you want the Prometheus server node port to be configured with and set the name of the Persistent Volume Claim that you have created in the steps before.

   Code Block
   helm install -n <namespace> prometheus prometheus-community/prometheus \ --set server.persistentVolume.enabled=true \ --set server.persistentVolume.accessModes=ReadWriteMany \ --set server.persistentVolume.existingClaim="prometheus-persistent" \ --set server.service.type=NodePort \ --set server.service.nodePort=<port> \ --set alertmanager.persistentVolume.enabled=false

   Info
   title Example: helm install Prometheus - with persistence
   Code Block helm install -n prometheus prometheus prometheus-community/prometheus \ --set server.persistentVolume.enabled=true \ --set server.persistentVolume.accessModes=ReadWriteMany \ --set server.persistentVolume.existingClaim="prometheus-persistent" \ --set server.service.type=NodePort \ --set server.service.nodePort=31010 \ --set alertmanager.persistentVolume.enabled=false

Verify the Prometheus Installation

This step will have you check that your Prometheus is deployed correctly.

1. After installing the Prometheus server, you will be given an export command to use to acquire the URL and the Port for the Prometheus server. The command can look something like this:

   Code Block
   export NODE_PORT=$(kubectl get --namespace <namespace> -o jsonpath="{.spec.ports[0].nodePort}" services prometheus-server) export NODE_IP=$(kubectl get nodes --namespace <namespace> -o jsonpath="{.items[0].status.addresses[0].address}")

   Info
   title Example: Exporting the value for Prometheus Node IP and Node Port
   Code Block $ export NODE_PORT=$(kubectl get --namespace prometheus -o jsonpath="{.spec.ports[0].nodePort}" services prometheus-server) $ export NODE_IP=$(kubectl get nodes --namespace prometheus -o jsonpath="{.items[0].status.addresses[0].address}")

2. To generate the URL from the result of the two export commands above, use this echo command. Then copy the result to your browser.

   Code Block
   echo http://$NODE_IP:$NODE_PORT

   Info
   title Example: Url for Prometheus GUI
   Code Block http://192.168.52.26:31010

Install Prometheus Adapter

The Prometheus adapter functions as a gatekeeper, where it retrieves the metrics from a Prometheus server and then publishes these metrics to Kubernetes metrics API. The adapter uses a configuration file to set the rules that determine what metrics the adapter will publish. You can also configure your own custom metrics using the configuration file. For examples of how to configure your own custom metrics, refer to For 9.0.3 Creating Custom Metrics on Prometheus Adapter[hide]10.6[/hide].

Refer to https://github.com/kubernetes-sigs/prometheus-adapter for more information about the Prometheus adapter and how to configure the rules for the configuration file.

For simplicity, there is a sample configuration file called prom-adapter-values.yaml. This file is configured with the rule to make all com.digitalroute related metrics available in Kubernetes. To find the url and port, you can use the export NODE_PORT command as shown on the verify the Prometheus installation steps above.

prom-adapter-values.yaml

prometheus:
  url: http://192.168.52.26
  port: 31010
logLevel: 6
rules:
  custom:
  - seriesQuery: '{__name__=~"^com_digitalroute.*"}'
    resources:
      overrides:
        kubernetes_namespace:
          resource: namespace
        kubernetes_pod_name:
          resource: pod
    name:
      matches: ^(.*)
      as: ""
    metricsQuery: sum(<<.Series>>{<<.LabelMatchers>>}) by (<<.GroupBy>>)

Installation of the Prometheus adapter uses the same helm repository that you have added when installing the Prometheus server. Use this helm install command for the Prometheus adapter with the prom-adapter-values.yaml configuration file.

helm install -n <namespace> prometheus-adapter prometheus-community/prometheus-adapter -f <Prometheus adapter configuration file>

...

helm install -n mznamespace prometheus-adapter prometheus-community/prometheus-adapter -f prom-adapter-values.yaml