Metrics

Mon, 01 Jan 0001 00:00:00 +0000

概述

Dubbo Metrics 的总体设计请参考可观测性 Metrics Proposal。

以下是 Dubbo Java 相关的具体实现与使用方式讲解。

使用方式

要为 Dubbo 进程开启指标采集，需要在项目中引入相关依赖并增加配置。以 Spring Boot 项目为例，增加以下 spring-boot-starter 依赖到项目中，即会自动开启指标采集。

<!-- https://mvnrepository.com/artifact/org.apache.dubbo/dubbo-metrics-prometheus -->
<dependency>
 <groupId>org.apache.dubbo</groupId>
 <artifactId>dubbo-spring-boot-observability-starter</artifactId>
 <version>3.2.0</version>
</dependency>

完整示例请参见 dubbo-samples-metrics-spring-boot
完整配置参数请参见 Metrics 配置项手册

实现原理解析

代码结构与工作流程

移除原来与 Metrics 相关的类
创建新模块 dubbo-metrics/dubbo-metrics-api、dubbo-metrics/dubbo-metrics-prometheus，MetricsConfig 作为该模块的配置类
使用micrometer，在Collector中使用基本类型代表指标，如Long、Double等，并在dubbo-metrics-api中引入micrometer，由micrometer对内部指标进行转换

以下是 Dubbo 实现中的关键组件及数据流转过程

指标上报接口

根据上图架构，指标接口是 Dubbo 对外暴露指标数据的出口，以下是指标接口的具体定义：

另外，该 Service 还作为一些智能自适应流量调度算法的数据来源

public interface MetricsService {

 /**
 * Default {@link MetricsService} extension name.
 */
 String DEFAULT_EXTENSION_NAME = "default";

 /**
 * The contract version of {@link MetricsService}, the future update must make sure compatible.
 */
 String VERSION = "1.0.0";

 /**
 * Get metrics by prefixes
 *
 * @param categories categories
 * @return metrics - key=MetricCategory value=MetricsEntityList
 */
 Map<MetricsCategory, List<MetricsEntity>> getMetricsByCategories(List<MetricsCategory> categories);

 /**
 * Get metrics by interface and prefixes
 *
 * @param serviceUniqueName serviceUniqueName (eg.group/interfaceName:version)
 * @param categories categories
 * @return metrics - key=MetricCategory value=MetricsEntityList
 */
 Map<MetricsCategory, List<MetricsEntity>> getMetricsByCategories(String serviceUniqueName, List<MetricsCategory> categories);

 /**
 * Get metrics by interface、method and prefixes
 *
 * @param serviceUniqueName serviceUniqueName (eg.group/interfaceName:version)
 * @param methodName methodName
 * @param parameterTypes method parameter types
 * @param categories categories
 * @return metrics - key=MetricCategory value=MetricsEntityList
 */
 Map<MetricsCategory, List<MetricsEntity>> getMetricsByCategories(String serviceUniqueName, String methodName, Class<?>[] parameterTypes, List<MetricsCategory> categories);
}

其中 MetricsCategory 设计如下:

Mesh手册 on Apache Dubbo

Metrics

概述

使用方式

实现原理解析

代码结构与工作流程

指标上报接口