Skip to content

feat(spring): [Logs and Metrics Enable Flags 15] Warn for legacy Metrics property #5956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adinauer wants to merge 3 commits into
base: feat/warn-legacy-metrics-external
Choose a base branch
from
Open

feat(spring): [Logs and Metrics Enable Flags 15] Warn for legacy Metrics property #5956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
61f485a
feat(spring): Warn for legacy Metrics property
adinauer Aug 13, 2026
9545c0c
Merge branch 'feat/warn-legacy-metrics-external' into feat/warn-legac…
adinauer Aug 13, 2026
532ecf2
Merge branch 'feat/warn-legacy-metrics-external' into feat/warn-legac…
adinauer Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions sentry-spring-boot-4/src/main/java/io/sentry/spring/boot4/SentryAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ static class OpenTelemetryNoAgentConfiguration {}
options.getIgnoredExceptionsForType().removeIf(it -> !Throwable.class.isAssignableFrom(it));
Sentry.init(options);
warnForLegacyLogsConfiguration(environment, options);
warnForLegacyMetricsConfiguration(environment, options);
return ScopesAdapter.getInstance();
}

Expand Down Expand Up @@ -216,6 +217,29 @@ private void warnForLegacyLogsConfiguration(
}
}

private void warnForLegacyMetricsConfiguration(
final @NotNull Environment environment, final @NotNull SentryOptions options) {
if (environment.containsProperty("sentry.metrics.enabled")) {
final boolean enableMetrics =
Boolean.TRUE.equals(environment.getProperty("sentry.metrics.enabled", Boolean.class));
if (enableMetrics) {
options
.getLogger()
.log(
SentryLevel.WARNING,
"The 'sentry.metrics.enabled' property is no longer supported. Manual "
+ "Sentry.metrics() calls no longer require it.");
} else {
options
.getLogger()
.log(
SentryLevel.WARNING,
"The 'sentry.metrics.enabled' property no longer disables manual "
+ "Sentry.metrics() calls.");
}
}
}

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(MDC.class)
@Open
Expand Down
46 changes: 46 additions & 0 deletions sentry-spring-boot-4/src/test/kotlin/io/sentry/spring/boot4/SentryAutoConfigurationTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,52 @@ class SentryAutoConfigurationTest {
}
}

@Test
fun `legacy metrics property emits no warning when absent`() {
val logger = mock<ILogger>()
dsnEnabledRunner
.withPropertyValues("sentry.debug=true")
.withBean(ILogger::class.java, { logger })
.withUserConfiguration(LoggerConfiguration::class.java)
.run { verify(logger, never()).log(eq(SentryLevel.WARNING), any<String>()) }
}

@Test
fun `legacy metrics property true emits migration warning`() {
val logger = mock<ILogger>()
dsnEnabledRunner
.withPropertyValues("sentry.debug=true", "sentry.metrics.enabled=true")
.withBean(ILogger::class.java, { logger })
.withUserConfiguration(LoggerConfiguration::class.java)
.run {
verify(logger)
.log(
SentryLevel.WARNING,
"The 'sentry.metrics.enabled' property is no longer supported. Manual " +
"Sentry.metrics() calls no longer require it.",
*emptyArray(),
)
}
}

@Test
fun `legacy metrics property false emits migration warning`() {
val logger = mock<ILogger>()
dsnEnabledRunner
.withPropertyValues("sentry.debug=true", "sentry.metrics.enabled=false")
.withBean(ILogger::class.java, { logger })
.withUserConfiguration(LoggerConfiguration::class.java)
.run {
verify(logger)
.log(
SentryLevel.WARNING,
"The 'sentry.metrics.enabled' property no longer disables manual " +
"Sentry.metrics() calls.",
*emptyArray(),
)
}
}

@Test
fun `properties are applied to SentryOptions`() {
contextRunner
Expand Down
24 changes: 24 additions & 0 deletions ...ing-boot-jakarta/src/main/java/io/sentry/spring/boot/jakarta/SentryAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ static class OpenTelemetryNoAgentConfiguration {}
options.getIgnoredExceptionsForType().removeIf(it -> !Throwable.class.isAssignableFrom(it));
Sentry.init(options);
warnForLegacyLogsConfiguration(environment, options);
warnForLegacyMetricsConfiguration(environment, options);
return ScopesAdapter.getInstance();
}

Expand Down Expand Up @@ -218,6 +219,29 @@ private void warnForLegacyLogsConfiguration(
}
}

private void warnForLegacyMetricsConfiguration(
final @NotNull Environment environment, final @NotNull SentryOptions options) {
if (environment.containsProperty("sentry.metrics.enabled")) {
final boolean enableMetrics =
Boolean.TRUE.equals(environment.getProperty("sentry.metrics.enabled", Boolean.class));
if (enableMetrics) {
options
.getLogger()
.log(
SentryLevel.WARNING,
"The 'sentry.metrics.enabled' property is no longer supported. Manual "
+ "Sentry.metrics() calls no longer require it.");
} else {
options
.getLogger()
.log(
SentryLevel.WARNING,
"The 'sentry.metrics.enabled' property no longer disables manual "
+ "Sentry.metrics() calls.");
}
}
}

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(MDC.class)
@Open
Expand Down
46 changes: 46 additions & 0 deletions ...boot-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryAutoConfigurationTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,52 @@ class SentryAutoConfigurationTest {
}
}

@Test
fun `legacy metrics property emits no warning when absent`() {
val logger = mock<ILogger>()
dsnEnabledRunner
.withPropertyValues("sentry.debug=true")
.withBean(ILogger::class.java, { logger })
.withUserConfiguration(LoggerConfiguration::class.java)
.run { verify(logger, never()).log(eq(SentryLevel.WARNING), any<String>()) }
}

@Test
fun `legacy metrics property true emits migration warning`() {
val logger = mock<ILogger>()
dsnEnabledRunner
.withPropertyValues("sentry.debug=true", "sentry.metrics.enabled=true")
.withBean(ILogger::class.java, { logger })
.withUserConfiguration(LoggerConfiguration::class.java)
.run {
verify(logger)
.log(
SentryLevel.WARNING,
"The 'sentry.metrics.enabled' property is no longer supported. Manual " +
"Sentry.metrics() calls no longer require it.",
*emptyArray(),
)
}
}

@Test
fun `legacy metrics property false emits migration warning`() {
val logger = mock<ILogger>()
dsnEnabledRunner
.withPropertyValues("sentry.debug=true", "sentry.metrics.enabled=false")
.withBean(ILogger::class.java, { logger })
.withUserConfiguration(LoggerConfiguration::class.java)
.run {
verify(logger)
.log(
SentryLevel.WARNING,
"The 'sentry.metrics.enabled' property no longer disables manual " +
"Sentry.metrics() calls.",
*emptyArray(),
)
}
}

@Test
fun `properties are applied to SentryOptions`() {
contextRunner
Expand Down
24 changes: 24 additions & 0 deletions sentry-spring-boot/src/main/java/io/sentry/spring/boot/SentryAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@ static class OpenTelemetryNoAgentConfiguration {}
options.getIgnoredExceptionsForType().removeIf(it -> !Throwable.class.isAssignableFrom(it));
Sentry.init(options);
warnForLegacyLogsConfiguration(environment, options);
warnForLegacyMetricsConfiguration(environment, options);
return ScopesAdapter.getInstance();
}

Expand Down Expand Up @@ -213,6 +214,29 @@ private void warnForLegacyLogsConfiguration(
}
}

private void warnForLegacyMetricsConfiguration(
final @NotNull Environment environment, final @NotNull SentryOptions options) {
if (environment.containsProperty("sentry.metrics.enabled")) {
final boolean enableMetrics =
Boolean.TRUE.equals(environment.getProperty("sentry.metrics.enabled", Boolean.class));
if (enableMetrics) {
options
.getLogger()
.log(
SentryLevel.WARNING,
"The 'sentry.metrics.enabled' property is no longer supported. Manual "
+ "Sentry.metrics() calls no longer require it.");
} else {
options
.getLogger()
.log(
SentryLevel.WARNING,
"The 'sentry.metrics.enabled' property no longer disables manual "
+ "Sentry.metrics() calls.");
}
}
}

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(MDC.class)
@Open
Expand Down
46 changes: 46 additions & 0 deletions sentry-spring-boot/src/test/kotlin/io/sentry/spring/boot/SentryAutoConfigurationTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,52 @@ class SentryAutoConfigurationTest {
}
}

@Test
fun `legacy metrics property emits no warning when absent`() {
val logger = mock<ILogger>()
dsnEnabledRunner
.withPropertyValues("sentry.debug=true")
.withBean(ILogger::class.java, { logger })
.withUserConfiguration(LoggerConfiguration::class.java)
.run { verify(logger, never()).log(eq(SentryLevel.WARNING), any<String>()) }
}

@Test
fun `legacy metrics property true emits migration warning`() {
val logger = mock<ILogger>()
dsnEnabledRunner
.withPropertyValues("sentry.debug=true", "sentry.metrics.enabled=true")
.withBean(ILogger::class.java, { logger })
.withUserConfiguration(LoggerConfiguration::class.java)
.run {
verify(logger)
.log(
SentryLevel.WARNING,
"The 'sentry.metrics.enabled' property is no longer supported. Manual " +
"Sentry.metrics() calls no longer require it.",
*emptyArray(),
)
}
}

@Test
fun `legacy metrics property false emits migration warning`() {
val logger = mock<ILogger>()
dsnEnabledRunner
.withPropertyValues("sentry.debug=true", "sentry.metrics.enabled=false")
.withBean(ILogger::class.java, { logger })
.withUserConfiguration(LoggerConfiguration::class.java)
.run {
verify(logger)
.log(
SentryLevel.WARNING,
"The 'sentry.metrics.enabled' property no longer disables manual " +
"Sentry.metrics() calls.",
*emptyArray(),
)
}
}

@Test
fun `properties are applied to SentryOptions`() {
contextRunner
Expand Down
Loading