Java服務端服務監(jiān)控:Prometheus與Spring Boot Actuator的集成方式

更新時間：2024年12月12日 11:01:25 作者：微賺淘客系統開發(fā)者@聚娃科技

本文介紹了如何將Prometheus與SpringBootActuator集成,實現對Java服務端應用的監(jiān)控,通過集成,可以利用Prometheus的強大監(jiān)控能力,及時發(fā)現和解決性能問題

Prometheus與Spring Boot Actuator的集成

在現代Java服務端開發(fā)中，服務監(jiān)控是確保系統穩(wěn)定性和性能的關鍵。

Prometheus是一個開源的系統監(jiān)控和警報工具，而Spring Boot Actuator提供了生產級別的監(jiān)控功能。

將兩者集成可以為Java應用提供強大的監(jiān)控能力。

本文將介紹如何將Prometheus與Spring Boot Actuator集成，以及如何配置和使用它們進行服務監(jiān)控。

1. 添加依賴

首先，需要在Spring Boot項目中添加Prometheus和Actuator的依賴。

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <dependency>
        <groupId>io.prometheus</groupId>
        <artifactId>prometheus-client-spring-boot</artifactId>
        <version>0.10.0</version>
    </dependency>
</dependencies>

2. 配置Prometheus

在Spring Boot應用中配置Prometheus，以暴露監(jiān)控指標。

import cn.juwatech.config.PrometheusConfig;
import org.springframework.context.annotation.Configuration;
import io.prometheus.client.exporter.common.TextFormat;
import io.prometheus.client.hotspot.DefaultExports;
import io.prometheus.client.spring.boot.PrometheusMetricsExportAutoConfiguration;

@Configuration
public class PrometheusConfiguration extends PrometheusMetricsExportAutoConfiguration.MetricsExportConfiguration {

    @Override
    public void configureMetricsExport(io.prometheus.client.exporter.MetricsServlet metricsServlet) {
        super.configureMetricsExport(metricsServlet);
        metricsServlet.setServletPath("/metrics");
    }

    @Override
    public void configureDefaultExports() {
        super.configureDefaultExports();
        DefaultExports.initialize();
    }
}

3. 集成Spring Boot Actuator

Spring Boot Actuator提供了多種監(jiān)控端點，可以與Prometheus集成以暴露這些端點。

import org.springframework.boot.actuate.autoconfigure.metrics.export.prometheus.PrometheusMetricsExportAutoConfiguration;
import org.springframework.context.annotation.Configuration;
import org.springframework.boot.actuate.autoconfigure.web.server.WebManagementContextResolver;
import org.springframework.boot.actuate.endpoint.web.WebEndpointFilter;

@Configuration
@WebManagementContextResolver
public class ActuatorConfiguration extends PrometheusMetricsExportAutoConfiguration {

    @Override
    public void configureWebEndpointFilters(WebEndpointFilter[] filters) {
        super.configureWebEndpointFilters(filters);
    }
}

4. 定義自定義指標

除了內置的監(jiān)控指標，我們還可以定義自定義指標來滿足特定的監(jiān)控需求。

import io.prometheus.client.Counter;
import io.prometheus.client.Gauge;
import org.springframework.stereotype.Component;

@Component
public class CustomMetrics {

    private static final Counter requestsCounter = Counter.build()
            .name("my_requests_total")
            .help("Total requests.")
            .register();

    private static final Gauge responseSizeGauge = Gauge.build()
            .name("my_response_size_bytes")
            .help("Response size in bytes.")
            .register();

    public void recordRequest(int responseSize) {
        requestsCounter.inc();
        responseSizeGauge.set(responseSize);
    }
}

5. 使用自定義指標

在應用中使用自定義指標來記錄監(jiān)控數據。

import cn.juwatech.service.MyService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    private final CustomMetrics customMetrics;
    private final MyService myService;

    public MyController(CustomMetrics customMetrics, MyService myService) {
        this.customMetrics = customMetrics;
        this.myService = myService;
    }

    @GetMapping("/my-service")
    public String myServiceEndpoint() {
        String response = myService.performAction();
        int responseSize = response.getBytes().length;
        customMetrics.recordRequest(responseSize);
        return response;
    }
}

6. 配置Prometheus服務器

配置Prometheus服務器以抓取Spring Boot應用暴露的監(jiān)控指標。

global:
  scrape_interval: 15s

scrape_configs:
  - job_name: 'spring-boot-application'
    scrape_interval: 5s
    static_configs:
      - targets: ['localhost:8080']

7. 可視化與告警

使用Prometheus的可視化工具，如Grafana，來展示監(jiān)控數據，并設置告警規(guī)則。

import cn.juwatech.monitor.PrometheusAlertManager;

public class MonitoringAndAlerting {
    public static void main(String[] args) {
        PrometheusAlertManager alertManager = new PrometheusAlertManager();
        alertManager.setAlertRule("my_requests_total > 100");
        alertManager.startMonitoring();
    }
}