{"id":836,"date":"2024-06-25T09:39:08","date_gmt":"2024-06-25T09:39:08","guid":{"rendered":"https:\/\/blog.ngocha.biz\/?p=836"},"modified":"2024-06-25T09:39:08","modified_gmt":"2024-06-25T09:39:08","slug":"setup-prometheus-jmx-exporter","status":"publish","type":"post","link":"https:\/\/blog.ngocha.biz\/?p=836","title":{"rendered":"How to Setup Prometheus JMX Exporter on Linux [ Tutorial ]"},"content":{"rendered":"

In this blog, you will learn to install and configure Prometheus<\/strong><\/a> JMX Exporter<\/strong> on a Linux server.<\/p>\n

You will also learn to instrument a Java application using the JMX Exporter, export metrics to prometheus and query it using PromQL.<\/p>\n

Prerequisites<\/h2>\n

Here are the prerequisites for setting up a JMX exporter on a Virtual machine.<\/p>\n

We need two servers.<\/p>\n

    \n
  1. Server 01<\/strong>: Prometheus server up and running. If you dont have a Prometheus setup, follow the Prometheus setup on linux<\/a> blog.<\/li>\n
  2. Server 02<\/strong>: Server to run the Java application<\/a> and the JMX exporter.<\/li>\n<\/ol>\n

    How To Setup JMX Exporter on VM?<\/strong><\/h2>\n

    For this tutorial, I am using two Ubuntu based EC2 instances and the instance type is t2.medium.<\/p>\n

    I assume you already have the Java application (jar files), or if you want to test that, you can use this repository.<\/p>\n

    git clone https:\/\/github.com\/techiescamp\/java-spring-petclinic<\/code><\/pre>\n
    Follow the steps given below for the setup and configuration.<\/p>\n
    Step 1: Download the JMX Exporter Agent<\/h3>\n
    To download the JMX Exporter Java agent<\/strong>, use the following command.<\/p>\n
    wget https:\/\/repo1.maven.org\/maven2\/io\/prometheus\/jmx\/jmx_prometheus_javaagent\/0.19.0\/jmx_prometheus_javaagent-0.19.0.jar<\/code><\/pre>\n
    The next step is to create a configuration file for the JMX Exporter config.yaml<\/code>. This file will decide what has to be collected from the JMX MBean server.<\/p>\n
    Step 2: Create a Configuration File for the JMX Exporter<\/h3>\n
    There are a lot of metrics and information available on the MBean server, but we might only have a few metrics to monitor, we provide configuration to filter the necessary metrics from the server.<\/p>\n
    Create a configuration file config.yaml<\/strong><\/p>\n
    lowercaseOutputName: true\nlowercaseOutputLabelNames: true\n\nrules:\n  - pattern: 'java.lang:type=Memory'<\/code><\/pre>\n
    For testing purposes, I am using this configuration to filter the memory-related metrics. For all the supported metrics, please refer to the official documentation<\/a>.<\/p>\n
    Step 3: Expose Metrics through the HTTP Server<\/h3>\n
    To expose the Java application metrics, use the following command.<\/p>\n
    sudo java -javaagent:jmx_prometheus_javaagent-0.19.0.jar=9093:config.yaml -jar java-spring-petclinic\/target\/spring-petclinic-3.2.0-SNAPSHOT.jar<\/code><\/pre>\n
    The JMX Exporter will be used as a Java application’s runtime agent<\/strong> and I have given the port number 9093<\/code>, you can give a different one because there is no default port for the JMX Exporter.<\/p>\n
    To view the metrics from the localhost, use the following command.<\/p>\n
    curl localhost:9093<\/code><\/pre>\n
    If you want to see the metrics over the internet then you need the instance public IP and the Port number.<\/p>\n
    Open a browser and paste the Public IP<\/strong> and the port number <Public IP>:9093<\/strong>, and you will get this output.<\/p>\n
    \"prometheus<\/figure>\n
    Now we can check Prometheus<\/strong> and ensure that it is periodically scrapping the metrics from the JMX Exporter.<\/strong><\/p>\n
    Step 4: Add JMX Exporter Job in Prometheus<\/h3>\n
    We need to create a job in the Prometheus configuration file then only Prometheus can pull and store the metrics in the Time Series Database.<\/strong><\/p>\n
    If you haven’t installed Prometheus on the cluster, refer to this blog<\/a>.<\/p>\n
    Open the configuration file \/etc\/prometheus\/prometheus.yaml<\/code><\/p>\n
    sudo vim \/etc\/prometheus\/prometheus.yml<\/code><\/pre>\n
    Under the scrape_configs<\/code> add a new job<\/p>\n
    - job_name: \"jmx-exporter\"\n    static_configs:\n    - targets: [\"<Public_IP>:9093\"]<\/code><\/pre>\n
    Provide the Public IP<\/strong> address of the server where your JMX Exporter is and the Port number of the JMX Exporter 9093<\/code>.<\/p>\n
    Once the configuration is completed, restart the Prometheus service and view the status to ensure the configurations are properly applied.<\/p>\n
    sudo systemctl restart prometheus.service\nsudo systemctl status prometheus.service<\/code><\/pre>\n
    First, we will list the Prometheus targets.<\/p>\n
    \"Prometheus<\/figure>\n
    This ensures that the Prometheus can access the JMX Exporter endpoint<\/strong> and the state of the Exporter.<\/p>\n
    Let’s make a query from the Prometheus and see the results.<\/p>\n
    \"prometheus<\/figure>\n
    We can see the visual representation for our query result, using the Grafana.<\/strong><\/p>\n
    To install Grafana on your Virtual Machine, refer to this blog<\/a>.<\/p>\n
    \"grafana<\/figure>\n
    Conclusion<\/strong><\/h2>\n
    I have covered all the steps to instrument a Java application using Prometheus JMX exporter and run on a Linux server.<\/p>\n
    If you are using Kubernetes, you can try implement the JMX Exporter in the Kubernetes cluste<\/a>r to monitor the Java application running in Kubernetes Pod<\/a> .<\/p>\n
    If you face any issues or need clarification on the setup, please drop a comment below. I will help you out.<\/p>\n
    \n
    Ngu\u1ed3n:<\/strong> How to Setup Prometheus JMX Exporter on Linux [ Tutorial ] \u2014 DevOpsCube<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
    Source: https:\/\/devopscube.com\/setup-prometheus-jmx-exporter\/<\/p>\n","protected":false},"author":1,"featured_media":837,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-836","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-devops"],"_links":{"self":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts\/836","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=836"}],"version-history":[{"count":0,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts\/836\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/media\/837"}],"wp:attachment":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=836"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=836"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=836"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}