Bagaimana untuk menyesuaikan penunjuk pemantauan dalam Spring Boot

1 Cipta projek

pom.xml dan perkenalkan kebergantungan yang berkaitan

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.olive</groupId>
	<artifactId>prometheus-meter-demo</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.3.7.RELEASE</version>
		<relativePath />
	</parent>
	<properties>
		<java.version>1.8</java.version>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<spring-boot.version>2.3.7.RELEASE</spring-boot.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-aop</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-actuator</artifactId>
		</dependency>
		<!-- Micrometer Prometheus registry  -->
		<dependency>
			<groupId>io.micrometer</groupId>
			<artifactId>micrometer-registry-prometheus</artifactId>
		</dependency>
	</dependencies>
	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-dependencies</artifactId>
				<version>${spring-boot.version}</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>
</project>

2 Satu

Secara langsung menggunakan kelas pakej

teras untuk mentakrif dan mendaftar penunjuk

package com.olive.monitor;
 
import javax.annotation.PostConstruct;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
 
import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.DistributionSummary;
import io.micrometer.core.instrument.MeterRegistry;
 
@Component
public class NativeMetricsMontior {
 
	/**
	 * 支付次数
	 */
	private Counter payCount;
 
	/**
	 * 支付金额统计
	 */
	private DistributionSummary payAmountSum;
 
	@Autowired
	private MeterRegistry registry;
 
	@PostConstruct
	private void init() {
		payCount = registry.counter("pay_request_count", "payCount", "pay-count");
		payAmountSum = registry.summary("pay_amount_sum", "payAmountSum", "pay-amount-sum");
	}
 
	public Counter getPayCount() {
		return payCount;
	}
 
	public DistributionSummary getPayAmountSum() {
		return payAmountSum;
	}
 
}

micrometer Kaedah Dua

Dengan memperkenalkan pakej

, yang menggabungkan prometheus, untuk mikrometer Berkapsul

<dependency>
			<groupId>io.micrometer</groupId>
			<artifactId>micrometer-registry-prometheus</artifactId>
		</dependency>

micrometer-registry-prometheus Juga mentakrifkan dua metrik

package com.olive.monitor;
 
import javax.annotation.PostConstruct;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
 
import io.prometheus.client.CollectorRegistry;
import io.prometheus.client.Counter;
 
@Component
public class PrometheusMetricsMonitor {
 
	/**
	 * 订单发起次数
	 */
	private Counter orderCount;
 
	/**
	 * 金额统计
	 */
	private Counter orderAmountSum;
	
	@Autowired
	private CollectorRegistry registry;
	@PostConstruct
	private void init() {
		orderCount = Counter.build().name("order_request_count")
				.help("order request count.")
				.labelNames("orderCount")
				.register();
		orderAmountSum = Counter.build().name("order_amount_sum")
				.help("order amount sum.")
				.labelNames("orderAmountSum")
				.register();
		registry.register(orderCount);
		registry.register(orderAmountSum);
	}
 
	public Counter getOrderCount() {
		return orderCount;
	}
 
	public Counter getOrderAmountSum() {
		return orderAmountSum;
	}
 
}

prometheus 4 Metrik yang biasa digunakan

Pembilang

Pembilang yang meningkat secara berterusan dan tidak berkurangan, anda boleh menggunakan Untuk jenis rekod yang hanya meningkat tetapi tidak berkurangan, seperti: bilangan pelawat tapak web, masa berjalan sistem, dsb.

Untuk penunjuk jenis Kaunter, terdapat hanya satu kaedah inc(), yang digunakan untuk kaunter + 1.

Secara umumnya, kami menggunakan penunjuk metrik jenis Kaunter dalam beberapa cara_ jumlah berakhir, seperti sebagai http_requests_total.

Tolok

Papan pemuka yang boleh meningkat atau menurun, dan carta lengkung

Untuk indeks jenis ini yang boleh meningkat atau menurun, ia digunakan untuk mencerminkan permohonan Status semasa.

Contohnya, apabila memantau hos, saiz memori percuma semasa hos, saiz memori yang tersedia, dsb.

Untuk objek penunjuk Tolok, ia mengandungi dua kaedah utama inc() dan dec(), yang digunakan untuk menambah dan mengurangkan kiraan.

Histogram

digunakan terutamanya untuk mengira taburan data Ini ialah jenis data metrik khas, yang mewakili anggaran peratusan nilai anggaran Ia mengira semua data penunjuk diskret dalam Bilangan kali dalam setiap julat nilai. Contohnya: Kami ingin mengira taburan data bagi respons permintaan http kurang daripada 0.005 saat, kurang daripada 0.01 saat dan kurang daripada 0.025 saat dalam tempoh masa. Kemudian gunakan Histogram untuk mengumpul masa setiap permintaan http dan tetapkan baldi pada masa yang sama.

Ringkasan

Ringkasan dan Histogram adalah sangat serupa. Kedua-duanya boleh mengira bilangan atau saiz acara dan pengedarannya fungsi yang boleh mengira taburan sampel statistik Perbezaannya ialah Histogram boleh mengira kuantil pada pelayan melalui fungsi histogram_quantile. Kuantil Sumamry ditakrifkan secara langsung pada pelanggan. Oleh itu, untuk pengiraan kuantil, Summary mempunyai prestasi yang lebih baik apabila membuat pertanyaan melalui PromQL, manakala Histogram menggunakan lebih banyak sumber, tetapi berbanding dengan pelanggan, Histogram menggunakan lebih sedikit sumber. Anda boleh menggunakan mana-mana satu, dan anda boleh melaraskannya secara bebas mengikut adegan sebenar.

3. Uji

takrifkan dua pengawal untuk menggunakan

dan

NativeMetricsMontior

package com.olive.controller;
 
import java.util.Random;
 
import javax.annotation.Resource;
 
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
 
import com.olive.monitor.NativeMetricsMontior;
 
@RestController
public class PayController {
 
	@Resource
	private NativeMetricsMontior monitor;
 
	@RequestMapping("/pay")
	public String pay(@RequestParam("amount") Double amount) throws Exception {
		// 统计支付次数
		monitor.getPayCount().increment();
 
		Random random = new Random();
		//int amount = random.nextInt(100);
		if(amount==null) {
			amount = 0.0;
		}
		// 统计支付总金额
		monitor.getPayAmountSum().record(amount);
		return "支付成功, 支付金额: " + amount;
	}
 
}
package com.olive.controller;
 
import java.util.Random;
 
import javax.annotation.Resource;
 
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
 
import com.olive.monitor.PrometheusMetricsMonitor;
 
@RestController
public class OrderController {
 
	@Resource
	private PrometheusMetricsMonitor monitor;
 
	@RequestMapping("/order")
	public String order(@RequestParam("amount") Double amount) throws Exception {
		// 订单总数
		monitor.getOrderCount()
			.labels("orderCount")
			.inc();
 
		Random random = new Random();
		//int amount = random.nextInt(100);
		if(amount==null) {
			amount = 0.0;
		}
		// 统计订单总金额
		monitor.getOrderAmountSum()
			.labels("orderAmountSum")
			.inc(amount);
		return "下单成功, 订单金额: " + amount;
	}
 
}

PrometheusMetricsMonitor untuk memulakan perkhidmatan

untuk mengakses

; lihat seperti biasa Pergi ke data pemantauan

http://127.0.0.1:9595/actuator/prometheus

dan tukar amaun beberapa kali kepada

dan

kemudian lawati http://127.0.0.1:8080/order?amount=100. Lihat data pemantauanhttp://127.0.0.1:8080/pay?amount=10http://127.0.0.1:9595/actuator/prometheus

4 Aplikasi dalam projek

Adalah tidak praktikal untuk memantau titik data dalam projek seperti yang dinyatakan di atas pada asasnya , pemantauan titik terkubur dijalankan melalui AOP. Sebagai contoh, tulis satu aspek

; kaedah ini sangat mesra. Pemantauan titik terkubur data boleh dilakukan di pintu masuk tanpa perlu menulis kod dalam pengawal.

package com.olive.aspect;
 
import java.time.LocalDate;
import java.util.concurrent.TimeUnit;
 
import javax.servlet.http.HttpServletRequest;
 
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
 
import io.micrometer.core.instrument.Metrics;
 
@Aspect
@Component
public class PrometheusMetricsAspect {
 
    // 切入所有controller包下的请求方法
    @Pointcut("execution(* com.olive.controller..*.*(..))")
    public void controllerPointcut() {
    }
 
    @Around("controllerPointcut()")
    public Object MetricsCollector(ProceedingJoinPoint joinPoint) throws Throwable {
 
        HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        String userId = StringUtils.hasText(request.getParameter("userId")) ? 
        		request.getParameter("userId") : "no userId";
        
        // 获取api url
        String api = request.getServletPath();
        // 获取请求方法
        String method = request.getMethod();
        long startTs = System.currentTimeMillis();
        LocalDate now = LocalDate.now();
        String[] tags = new String[10];
        tags[0] = "api";
        tags[1] = api;
        tags[2] = "method";
        tags[3] = method;
        tags[4] = "day";
        tags[5] = now.toString();
        tags[6] = "userId";
        tags[7] = userId;
        
        String amount = StringUtils.hasText(request.getParameter("amount")) ? 
        		request.getParameter("amount") : "0.0";
        
        tags[8] = "amount";
        tags[9] = amount;
        // 请求次数加1
        //自定义的指标名称：custom_http_request_all，指标包含数据
        Metrics.counter("custom_http_request_all", tags).increment();
        Object object = null;
        try {
            object = joinPoint.proceed();
        } catch (Exception e) {
            //请求失败次数加1
            Metrics.counter("custom_http_request_error", tags).increment();
            throw e;
        } finally {
            long endTs = System.currentTimeMillis() - startTs;
            //记录请求响应时间
           Metrics.timer("custom_http_request_time", tags).record(endTs, TimeUnit.MILLISECONDS);
        }
        return object;
    }
}

AspectSelepas menulis aspek, mulakan semula perkhidmatan itu mengakses antara muka pengawal, dan anda juga boleh menguburkan penunjuk pemantauan tersuai

Atas ialah kandungan terperinci Bagaimana untuk menyesuaikan penunjuk pemantauan dalam Spring Boot. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!