Application Real-Time Monitoring Service:Monitor a Java application with Micrometer

How it works

Micrometer is a metrics instrumentation library for JVM-based applications. When combined with Spring Boot Actuator, it exposes application and JVM metrics at an HTTP endpoint in Prometheus text format. After you deploy your application on Alibaba Cloud, the ARMS Integration Center scrapes this endpoint and stores the data in Managed Service for Prometheus.

Prerequisites

Before you begin, make sure that you have:

• A Java application built with Spring Boot 2.x

• The application deployed (or ready to deploy) on Container Service for Kubernetes (ACK) or Elastic Compute Service (ECS)

Step 1: Add dependencies and expose the Prometheus endpoint

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
    <version>x.y.z</version>
</dependency>

<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
    <version>x.y.z</version>
</dependency>

management.server.port=8080
management.endpoints.web.exposure.include=xxx, prometheus

management:
  server:
    port: 8080
  endpoints:
    web:
      exposure:
        include: xxx, prometheus

<dependency>
    <groupId>io.github.mweirauch</groupId>
    <artifactId>micrometer-jvm-extras</artifactId>
    <version>0.2.2</version>
</dependency>

@Bean
public MeterBinder processMemoryMetrics() {
    return new ProcessMemoryMetrics();
}

@Bean
public MeterBinder processThreadMetrics() {
    return new ProcessThreadMetrics();
}

Step 2: Verify metrics locally

After you add the dependencies and configure the properties, start your application and verify that the Prometheus endpoint returns metrics.

Run the following command:

curl http://localhost:8080/actuator/prometheus

Replace 8080 with the port configured in management.server.port. A successful response contains metrics in Prometheus text format:

# HELP jvm_memory_used_bytes The amount of used memory
# TYPE jvm_memory_used_bytes gauge
jvm_memory_used_bytes{area="heap",id="G1 Eden Space",} 2.5165824E7
...

If the endpoint returns a 404 error, verify that:

• The spring-boot-starter-actuator dependency is on your classpath.

• The management.endpoints.web.exposure.include property includes prometheus.

• The port in your request matches management.server.port.

Step 3: Deploy and connect to Managed Service for Prometheus

Deploy your application to an ACK cluster or an ECS instance, then configure the Micrometer integration in the ARMS console.

1. Log on to the ARMS console.

2. In the left-side navigation pane, click Integration Center.

3. Search for the Micrometer component.

   

4. On the Start Integration tab of the Micrometer panel, configure the following parameters and click OK.

   Parameter	Description
   Select the environment type	The environment where your application runs. Valid values: Kubernetes Environment, ECS(VPC).
   Select a Kubernetes cluster	The ACK cluster where your application runs. This parameter appears only when you select Kubernetes Environment.
   Labels	Labels of the pod where Micrometer is deployed. Use meaningful labels to identify your application.
   Service Port	The port of the application. The default port number is automatically filled in.
   Metrics Collection Path	The endpoint that exposes the metrics. The default endpoint is automatically filled in.
   Use HTTPS to Collect Data	Turn on this switch to scrape metrics over HTTPS instead of HTTP.
   Metric Scrape interval (unit/second)	How often metrics are collected, in seconds. Default: 30.

Step 4: View dashboards

1. Log on to the ARMS console.

2. In the left-side navigation pane, click Integration Management.

3. On the Integrated Environments tab, click the name of your environment.

   

4. On the Component Management tab, in the Addon Type section, click MicroMeter, then click Dashboards.

   

5. Click a dashboard name to open it.

   

Step 5: Configure alerting

1. On the Component Management tab, in the Addon Type section, click MicroMeter, then click Alert Rule to view default alert rules.

2. Create custom alert rules based on your requirements. For details, see .

Related topics