可观测性

可观测性是指从外部观察正在运行的系统的内部状态的能力。它由三个支柱组成：日志记录、指标和跟踪。

对于指标和跟踪，Spring Boot 使用 Micrometer Observation。要创建你自己的观察（这将导致指标和跟踪），你可以注入一个 ObservationRegistry。

import io.micrometer.observation.Observation;
import io.micrometer.observation.ObservationRegistry;

import org.springframework.stereotype.Component;

@Component
public class MyCustomObservation {

	private final ObservationRegistry observationRegistry;

	public MyCustomObservation(ObservationRegistry observationRegistry) {
		this.observationRegistry = observationRegistry;
	}

	public void doSomething() {
		Observation.createNotStarted("doSomething", this.observationRegistry)
			.lowCardinalityKeyValue("locale", "en-US")
			.highCardinalityKeyValue("userId", "42")
			.observe(() -> {
				// Execute business logic here
			});
	}

}
低基数标签将添加到指标和跟踪中，而高基数标签将仅添加到跟踪中。

类型为 ObservationPredicate、GlobalObservationConvention、ObservationFilter 和 ObservationHandler 的 Bean 将自动注册到 ObservationRegistry 上。你还可以注册任意数量的 ObservationRegistryCustomizer Bean 以进一步配置注册表。

可观测性支持依赖于 上下文传播库 来转发跨线程和反应式管道中的当前观察。默认情况下，ThreadLocal 值不会自动在反应式运算符中恢复。此行为由 spring.reactor.context-propagation 属性控制，该属性可以设置为 auto 以启用自动传播。

有关观察的更多详细信息，请参阅 Micrometer Observation 文档。

JDBC 的可观测性可以通过单独的项目进行配置。 Datasource Micrometer 项目 提供了一个 Spring Boot 启动器，它会在调用 JDBC 操作时自动创建观测数据。 可以在 参考文档 中了解更多信息。
R2DBC 的可观测性已内置于 Spring Boot 中。要启用它，请将 io.r2dbc:r2dbc-proxy 依赖项添加到您的项目中。

通用标签

通用标签通常用于对操作环境进行维度细分，例如主机、实例、区域、堆栈等。通用标签作为低基数标签应用于所有观测数据，并且可以配置，如下例所示

  • 属性

  • YAML

management.observations.key-values.region=us-east-1
management.observations.key-values.stack=prod
management:
  observations:
    key-values:
      region: "us-east-1"
      stack: "prod"

以上示例将 region 和 stack 标签分别添加到了所有观测数据中，其值分别为 us-east-1 和 prod。

阻止观测数据

如果您想阻止报告某些观测数据，可以使用 management.observations.enable 属性

  • 属性

  • YAML

management.observations.enable.denied.prefix=false
management.observations.enable.another.denied.prefix=false
management:
  observations:
    enable:
      denied:
        prefix: false
      another:
        denied:
          prefix: false

以上示例将阻止所有名称以 denied.prefix 或 another.denied.prefix 开头的观测数据。

如果您想阻止 Spring Security 报告观测数据，请将属性 management.observations.enable.spring.security 设置为 false。

如果您需要更精细地控制观测数据的阻止，可以注册类型为 ObservationPredicate 的 Bean。只有当所有 ObservationPredicate Bean 对该观测数据返回 true 时，才会报告观测数据。

import io.micrometer.observation.Observation.Context;
import io.micrometer.observation.ObservationPredicate;

import org.springframework.stereotype.Component;

@Component
class MyObservationPredicate implements ObservationPredicate {

	@Override
	public boolean test(String name, Context context) {
		return !name.contains("denied");
	}

}

以上示例将阻止所有名称包含“denied”的观测数据。

OpenTelemetry 支持

有多种方法可以在您的应用程序中支持 OpenTelemetry。您可以使用 OpenTelemetry Java Agent 或 OpenTelemetry Spring Boot Starter，它们都由 OTel 社区支持；指标和跟踪使用 OTel 库定义的语义约定。本文档将 OpenTelemetry 描述为 Spring 团队官方支持，使用 Micrometer 和 OTLP 导出器；指标和跟踪使用 Spring 项目文档中描述的语义约定，例如 Spring Framework。

Spring Boot 的 Actuator 模块包含对 OpenTelemetry 的基本支持。

它提供了一个类型为 OpenTelemetry 的 Bean，如果应用程序上下文中存在类型为 SdkTracerProvider、ContextPropagators、SdkLoggerProvider 或 SdkMeterProvider 的 Bean，则它们会自动注册。此外，它还提供了一个 Resource Bean。自动配置的 Resource 的属性可以通过 management.opentelemetry.resource-attributes 配置属性进行配置。如果您已定义了自己的 Resource Bean，则不会再这样。

Spring Boot 不会为 OpenTelemetry 指标或日志记录提供自动配置。只有在与 Micrometer Tracing 一起使用时，才会自动配置 OpenTelemetry 追踪。

接下来的部分将提供有关日志记录、指标和跟踪的更多详细信息。

Micrometer 观测注解支持

要启用对指标和跟踪注解（如 @Timed、@Counted、@MeterTag 和 @NewSpan 注解）的扫描，您需要将 management.observations.annotations.enabled 属性设置为 true。此功能由 Micrometer 直接支持。请参考 Micrometer 和 Micrometer Tracing 参考文档。