Spring Security
OpenTelemetry Java agent instrumentation
This instrumentation does not emit any telemetry on its own. Instead, it captures identity attributes, and is only enabled when at least one common identity configuration is enabled. NOTE: The enduser attributes have been deprecated. When otel.instrumentation.common.v3-preview is enabled, enduser.id is emitted as user.name, enduser.role is emitted as the string array user.roles, and enduser.scope is not emitted.
- Name:
spring-security-config-6.0 - Scope:
io.opentelemetry.spring-security-config-6.0 - Target versions:
org.springframework.security:spring-security-config:[6.0.0,] - Library: https://spring.io/projects/spring-security
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
otel.instrumentation.common.enduser.id.enabled | boolean | false | Enables capturing the enduser.id attribute. This property and the associated attribute are not supported when v3 preview is enabled. |
otel.instrumentation.common.enduser.role.enabled | boolean | false | Enables capturing the enduser.role attribute. This property and the associated attribute are not supported when v3 preview is enabled. |
otel.instrumentation.common.enduser.scope.enabled | boolean | false | Enables capturing the enduser.scope attribute when v3 preview is not enabled. This property is not honored when v3 preview is enabled. |
otel.instrumentation.common.user.name.enabled | boolean | false | Enables capturing the user.name attribute when v3 preview is enabled. This property and the associated attribute are not supported when v3 preview is disabled. |
otel.instrumentation.common.user.roles.enabled | boolean | false | Enables capturing the user.roles attribute when v3 preview is enabled. This property and the associated attribute are not supported when v3 preview is disabled. |
otel.instrumentation.spring-security.enduser.role.granted-authority-prefix | string | ROLE_ | Prefix of granted authorities identifying roles to capture in the enduser.role semantic attribute. This property is not honored when v3 preview is enabled; use the user.roles variant instead. |
otel.instrumentation.spring-security.enduser.scope.granted-authority-prefix | string | SCOPE_ | Prefix of granted authorities identifying scopes to capture in the enduser.scope semantic attribute. This property and the associated attribute are not supported when v3 preview is enabled. |
otel.instrumentation.spring-security.user.roles.granted-authority-prefix | string | ROLE_ | Prefix of granted authorities identifying roles to capture in the user.roles semantic attribute when v3 preview is enabled. This property is not honored when v3 preview is disabled; use the enduser.role variant instead. |