跳到主要内容

可观察性

QWen Max 中英对照 Observability

Spring Security 开箱即用地与 Spring Observability 集成以进行跟踪；不过，配置它来收集指标也非常简单。

跟踪​

当存在 ObservationRegistry bean 时，Spring Security 会为以下内容创建跟踪：

  • 过滤器链

  • AuthenticationManager，以及

  • AuthorizationManager

Boot 集成​

例如，考虑一个简单的 Boot 应用程序：

@SpringBootApplication
public class MyApplication {
    @Bean
    public UserDetailsService userDetailsService() {
        return new InMemoryUserDetailsManager(
                User.withDefaultPasswordEncoder()
                        .username("user")
                        .password("password")
                        .authorities("app")
                        .build()
        );
    }

    @Bean
    ObservationRegistryCustomizer<ObservationRegistry> addTextHandler() {
        return (registry) -> registry.observationConfig().observationHandler(new ObservationTextPublisher());
    }

    public static void main(String[] args) {
        SpringApplication.run(ListenerSamplesApplication.class, args);
    }
}
java

以及相应的请求：

?> http -a user:password :8080
bash

将产生以下输出（为清晰起见添加了缩进）：

START - name='http.server.requests', contextualName='null', error='null', lowCardinalityKeyValues=[], highCardinalityKeyValues=[], map=[class io.micrometer.core.instrument.Timer$Sample='io.micrometer.core.instrument.Timer$Sample@687e16d1', class io.micrometer.core.instrument.LongTaskTimer$Sample='SampleImpl{duration(seconds)=0.001779024, duration(nanos)=1779024.0, startTimeNanos=91695917264958}']
    START - name='spring.security.http.chains', contextualName='spring.security.http.chains.before', error='null', lowCardinalityKeyValues=[chain.position='0', chain.size='17', filter.section='before'], highCardinalityKeyValues=[request.line='GET /'], map=[class io.micrometer.core.instrument.Timer$Sample='io.micrometer.core.instrument.Timer$Sample@79f554a5', class io.micrometer.core.instrument.LongTaskTimer$Sample='SampleImpl{duration(seconds)=7.42147E-4, duration(nanos)=742147.0, startTimeNanos=91695947182029}']
    ... skipped for brevity ...
    STOP - name='spring.security.http.chains', contextualName='spring.security.http.chains.before', error='null', lowCardinalityKeyValues=[chain.position='0', chain.size='17', filter.section='before'], highCardinalityKeyValues=[request.line='GET /'], map=[class io.micrometer.core.instrument.Timer$Sample='io.micrometer.core.instrument.Timer$Sample@79f554a5', class io.micrometer.core.instrument.LongTaskTimer$Sample='SampleImpl{duration(seconds)=0.014771848, duration(nanos)=1.4771848E7, startTimeNanos=91695947182029}']
        START - name='spring.security.authentications', contextualName='null', error='null', lowCardinalityKeyValues=[authentication.failure.type='Optional', authentication.method='ProviderManager', authentication.request.type='UsernamePasswordAuthenticationToken'], highCardinalityKeyValues=[], map=[class io.micrometer.core.instrument.Timer$Sample='io.micrometer.core.instrument.Timer$Sample@4d4b2b56', class io.micrometer.core.instrument.LongTaskTimer$Sample='SampleImpl{duration(seconds)=7.09759E-4, duration(nanos)=709759.0, startTimeNanos=91696094477504}']
        ... skipped for brevity ...
        STOP - name='spring.security.authentications', contextualName='null', error='null', lowCardinalityKeyValues=[authentication.failure.type='Optional', authentication.method='ProviderManager', authentication.request.type='UsernamePasswordAuthenticationToken', authentication.result.type='UsernamePasswordAuthenticationToken'], highCardinalityKeyValues=[], map=[class io.micrometer.core.instrument.Timer$Sample='io.micrometer.core.instrument.Timer$Sample@4d4b2b56', class io.micrometer.core.instrument.LongTaskTimer$Sample='SampleImpl{duration(seconds)=0.895141386, duration(nanos)=8.95141386E8, startTimeNanos=91696094477504}']
        START - name='spring.security.authorizations', contextualName='null', error='null', lowCardinalityKeyValues=[object.type='Servlet3SecurityContextHolderAwareRequestWrapper'], highCardinalityKeyValues=[], map=[class io.micrometer.core.instrument.Timer$Sample='io.micrometer.core.instrument.Timer$Sample@6d834cc7', class io.micrometer.core.instrument.LongTaskTimer$Sample='SampleImpl{duration(seconds)=3.0965E-4, duration(nanos)=309650.0, startTimeNanos=91697034893983}']
        ... skipped for brevity ...
        STOP - name='spring.security.authorizations', contextualName='null', error='null', lowCardinalityKeyValues=[authorization.decision='true', object.type='Servlet3SecurityContextHolderAwareRequestWrapper'], highCardinalityKeyValues=[authentication.authorities='[app]', authorization.decision.details='AuthorizationDecision [granted=true]'], map=[class io.micrometer.core.instrument.Timer$Sample='io.micrometer.core.instrument.Timer$Sample@6d834cc7', class io.micrometer.core.instrument.LongTaskTimer$Sample='SampleImpl{duration(seconds)=0.02084809, duration(nanos)=2.084809E7, startTimeNanos=91697034893983}']
        START - name='spring.security.http.secured.requests', contextualName='null', error='null', lowCardinalityKeyValues=[], highCardinalityKeyValues=[], map=[class io.micrometer.core.instrument.Timer$Sample='io.micrometer.core.instrument.Timer$Sample@649c5ec3', class io.micrometer.core.instrument.LongTaskTimer$Sample='SampleImpl{duration(seconds)=2.67878E-4, duration(nanos)=267878.0, startTimeNanos=91697059819304}']
        ... skipped for brevity ...
        STOP - name='spring.security.http.secured.requests', contextualName='null', error='null', lowCardinalityKeyValues=[], highCardinalityKeyValues=[], map=[class io.micrometer.core.instrument.Timer$Sample='io.micrometer.core.instrument.Timer$Sample@649c5ec3', class io.micrometer.core.instrument.LongTaskTimer$Sample='SampleImpl{duration(seconds)=0.090753322, duration(nanos)=9.0753322E7, startTimeNanos=91697059819304}']
    START - name='spring.security.http.chains', contextualName='spring.security.http.chains.after', error='null', lowCardinalityKeyValues=[chain.position='0', chain.size='17', filter.section='after'], highCardinalityKeyValues=[request.line='GET /'], map=[class io.micrometer.core.instrument.Timer$Sample='io.micrometer.core.instrument.Timer$Sample@47af8207', class io.micrometer.core.instrument.LongTaskTimer$Sample='SampleImpl{duration(seconds)=5.31832E-4, duration(nanos)=531832.0, startTimeNanos=91697152857268}']
    ... skipped for brevity ...
    STOP - name='spring.security.http.chains', contextualName='spring.security.http.chains.after', error='null', lowCardinalityKeyValues=[chain.position='17', chain.size='17', current.filter.name='DisableEncodeUrlFilter', filter.section='after'], highCardinalityKeyValues=[request.line='GET /'], map=[class io.micrometer.core.instrument.Timer$Sample='io.micrometer.core.instrument.Timer$Sample@47af8207', class io.micrometer.core.instrument.LongTaskTimer$Sample='SampleImpl{duration(seconds)=0.007689382, duration(nanos)=7689382.0, startTimeNanos=91697152857268}']
STOP - name='http.server.requests', contextualName='null', error='null', lowCardinalityKeyValues=[], highCardinalityKeyValues=[request.line='GET /'], map=[class io.micrometer.core.instrument.Timer$Sample='io.micrometer.core.instrument.Timer$Sample@687e16d1', class io.micrometer.core.instrument.LongTaskTimer$Sample='SampleImpl{duration(seconds)=1.245858319, duration(nanos)=1.245858319E9, startTimeNanos=91695917264958}']
bash

手动配置​

对于非 Spring Boot 应用程序，或者要覆盖现有的 Boot 配置，你可以发布你自己的 ObservationRegistry，Spring Security 仍然会使用它。

@SpringBootApplication
public class MyApplication {
    @Bean
    public UserDetailsService userDetailsService() {
        return new InMemoryUserDetailsManager(
                User.withDefaultPasswordEncoder()
                        .username("user")
                        .password("password")
                        .authorities("app")
                        .build()
        );
    }

    @Bean
    ObservationRegistry observationRegistry() {
        ObservationRegistry registry = ObservationRegistry.create();
        registry.observationConfig().observationHandler(new ObservationTextPublisher());
        return registry;
    }

    public static void main(String[] args) {
        SpringApplication.run(ListenerSamplesApplication.class, args);
    }
}
java

禁用可观察性​

如果你不希望有任何 Spring Security 观测，在 Spring Boot 应用程序中，你可以发布一个 ObservationRegistry.NOOP @Bean。然而，这可能会关闭不仅仅是 Spring Security 的观测。

相反，你可以发布一个如下的 SecurityObservationSettings：

@Bean
SecurityObservationSettings noSpringSecurityObservations() {
    return SecurityObservationSettings.noObservations();
}
java

然后 Spring Security 将不会把任何过滤器链、认证或授权包装在其对应的 ObservationXXX 中。

提示

没有提供用于禁用带有 XML 支持的观察的功能。相反，只需不要设置 observation-registry-ref 属性即可。

您也可以仅为安全性的部分观察禁用安全性。例如，SecurityObservationSettings bean 默认排除过滤链观察。因此，您也可以这样做：

@Bean
SecurityObservationSettings defaultSpringSecurityObservations() {
    return SecurityObservationSettings.withDefaults().build();
}
java

或者，你可以根据默认设置单独开启或关闭观察：

@Bean
SecurityObservationSettings allSpringSecurityObservations() {
    return SecurityObservationSettings.withDefaults()
            .shouldObserveFilterChains(true).build();
}
java
备注

为了向后兼容，除非发布了 SecurityObservationSettings，否则将进行所有 Spring Security 观察。

跟踪列表​

Spring Security 在每个请求中跟踪以下跨度：

  1. spring.security.http.requests - 一个包装整个过滤器链的 span，包括请求

  2. spring.security.http.chains.before - 一个包装安全过滤器接收部分的 span

  3. spring.security.http.chains.after - 一个包装安全过滤器返回部分的 span

  4. spring.security.http.secured.requests - 一个包装现已受保护的应用程序请求的 span

  5. spring.security.http.unsecured.requests - 一个包装 Spring Security 不保护的请求的 span

  6. spring.security.authentications - 一个包装身份验证尝试的 span

  7. spring.security.authorizations - 一个包装授权尝试的 span

提示

spring.security.http.chains.before + spring.security.http.secured.requests + spring.security.http.chains.after = spring.security.http.requests
spring.security.http.chains.before + spring.security.http.chains.after = Spring Security 的请求部分