POTEL 70 - Add sentry-opentelemetry-agentless-spring module (#4000)

* add agentless module for OpenTelemetry setup without any agent

* Replace bool with enum for OpenTelemetryUtil mode

* Move OpenTelemetryUtil into core sentry

* Add openTelemetryMode option

* Add SentryOpenTelemetryMode.OFF

* fix HubAdapter and ScopeAdapter tests by calling Sentry.init so that the ScopesStorage is initialized

* Hold a strong reference to OTel span if created via Sentry API

* add sentry-opentelemetry-agentless-spring module

* fix tests

* fix build

* changelog

* fix agentless due to late call to SpanFactoryFactory

* Format code

* changelog

* fix order of scope storage close vs scopes close

* changelog

* add PR link to changelog

* use initForTest

* use initForTest

---------

Co-authored-by: Lukas Bloder <lukas.bloder@gmail.com>
Co-authored-by: Sentry Github Bot <bot+github-bot@sentry.io>

Author: 3 people

.craft.yml

@@ -45,6 +45,7 @@ targets:
       maven:io.sentry:sentry-opentelemetry-agentcustomization:
       maven:io.sentry:sentry-opentelemetry-core:
 #      maven:io.sentry:sentry-opentelemetry-agentless:
+#      maven:io.sentry:sentry-opentelemetry-agentless-spring:
       maven:io.sentry:sentry-apollo:
       maven:io.sentry:sentry-jdbc:
       maven:io.sentry:sentry-graphql:

.github/ISSUE_TEMPLATE/bug_report_java.yml

@@ -16,6 +16,7 @@ body:
         - sentry-kotlin-extensions
         - sentry-opentelemetry-agent
         - sentry-opentelemetry-agentless
+        - sentry-opentelemetry-agentless-spring
         - sentry-opentelemetry-core
         - sentry-servlet
         - sentry-servlet-jakarta

CHANGELOG.md

@@ -4,6 +4,9 @@
 
 ### Features
 
+- Add `sentry-opentelemetry-agentless-spring` module ([#4000](https://github.com/getsentry/sentry-java/pull/4000))
+  - This module can be added as a dependency when using Sentry with OpenTelemetry and Spring Boot but don't want to use our Agent. It takes care of configuring OpenTelemetry for use with Sentry.
+  - You may want to set `OTEL_LOGS_EXPORTER=none;OTEL_METRICS_EXPORTER=none;OTEL_TRACES_EXPORTER=none` env vars to not have the log flooded with error messages regarding OpenTelemetry features we don't use.
 - Add `sentry-opentelemetry-agentless` module ([#3961](https://github.com/getsentry/sentry-java/pull/3961))
   - This module can be added as a dependency when using Sentry with OpenTelemetry but don't want to use our Agent. It takes care of configuring OpenTelemetry for use with Sentry.
   - To enable the auto configuration of it, please set `-Dotel.java.global-autoconfigure.enabled=true` on the `java` command, when starting your application.

sentry-opentelemetry/sentry-opentelemetry-agentless-spring/README.md

@@ -0,0 +1,54 @@
+# sentry-opentelemetry-agentless-spring
+
+*NOTE: Our OpenTelemetry modules are still experimental. Any feedback is welcome.*
+
+## How to use it
+
+Add the latest `sentry-opentelemetry-agentless-spring` module as a dependency and add a `sentry.properties` 
+configuration file to your project that could look like this:
+
+```properties
+# NOTE: Replace the test DSN below with YOUR OWN DSN to see the events from this app in your Sentry project/dashboard
+dsn=https://502f25099c204a2fbf4cb16edc5975d1@o447951.ingest.sentry.io/5428563
+traces-sample-rate=1.0
+```
+
+For more details on configuring Sentry via `sentry.properties` please see the
+[docs page](https://docs.sentry.io/platforms/java/configuration/).
+
+As an alternative to the `SENTRY_PROPERTIES_FILE` environment variable you can provide individual
+settings as environment variables (e.g. `SENTRY_DSN=...`) or you may initialize `Sentry` inside
+your target application. If you do so, please make sure to apply OpenTelemetry specific options, e.g.
+like this:
+
+```
+Sentry.init(
+        options -> {
+          options.setDsn("...");
+          ...
+          OpenTelemetryUtil.applyOpenTelemetryOptions(options, false);
+        }
+)
+```
+
+## Getting rid of exporter error messages
+
+In case you are using this module without needing to use any OpenTelemetry exporters you can add
+the following environment variables to turn off exporters and stop seeing error messages about 
+servers not being reachable in the logs.
+
+Example log message:
+```
+ERROR io.opentelemetry.exporter.internal.grpc.OkHttpGrpcExporter - Failed to export spans. The request could not be executed. Full error message: Failed to connect to localhost/[0:0:0:0:0:0:0:1]:4317
+ERROR io.opentelemetry.exporter.internal.grpc.OkHttpGrpcExporter - Failed to export metrics. The request could not be executed. Full error message: Failed to connect to localhost/[0:0:0:0:0:0:0:1]:4317
+```
+
+### Traces
+
+To turn off exporting of traces you can set `OTEL_TRACES_EXPORTER=none`
+see [OpenTelemetry GitHub](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure#otlp-exporter-span-metric-and-log-exporters)
+
+### Metrics
+
+To turn off exporting of metrics you can set `OTEL_METRICS_EXPORTER=none`
+see [OpenTelemetry GitHub](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure#otlp-exporter-span-metric-and-log-exporters)

sentry-opentelemetry/sentry-opentelemetry-agentless-spring/build.gradle.kts

@@ -0,0 +1,19 @@
+plugins {
+    `java-library`
+}
+
+configure<JavaPluginExtension> {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
+
+dependencies {
+    api(projects.sentry)
+    api(projects.sentryOpentelemetry.sentryOpentelemetryBootstrap)
+    implementation(projects.sentryOpentelemetry.sentryOpentelemetryAgentcustomization)
+    api(Config.Libs.OpenTelemetry.otelSdk)
+    api(Config.Libs.OpenTelemetry.otelSemconv)
+    api(Config.Libs.OpenTelemetry.otelSemconvIncubating)
+    api(Config.Libs.OpenTelemetry.otelExtensionAutoconfigure)
+    api(Config.Libs.springBoot3StarterOpenTelemetry)
+}

sentry-opentelemetry/sentry-opentelemetry-agentless-spring/src/main/java/io/sentry/opentelemetry/agent/AgentlessSpringMarker.java

@@ -0,0 +1,3 @@
+package io.sentry.opentelemetry.agent;
+
+public final class AgentlessSpringMarker {}

sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/build.gradle.kts

@@ -52,8 +52,7 @@ dependencies {
     implementation(projects.sentryLogback)
     implementation(projects.sentryGraphql22)
     implementation(projects.sentryQuartz)
-    implementation(Config.Libs.springBoot3StarterOpenTelemetry)
-    implementation(projects.sentryOpentelemetry.sentryOpentelemetryAgentless)
+    implementation(projects.sentryOpentelemetry.sentryOpentelemetryAgentlessSpring)
 
     // database query tracing
     implementation(projects.sentryJdbc)

sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/build.gradle.kts

@@ -52,8 +52,7 @@ dependencies {
     implementation(projects.sentryLogback)
     implementation(projects.sentryGraphql)
     implementation(projects.sentryQuartz)
-    implementation(Config.Libs.springBoot3StarterOpenTelemetry)
-    implementation(projects.sentryOpentelemetry.sentryOpentelemetryAgentless)
+    implementation(projects.sentryOpentelemetry.sentryOpentelemetryAgentlessSpring)
 
     // database query tracing
     implementation(projects.sentryJdbc)

settings.gradle.kts

@@ -49,6 +49,7 @@ include(
     "sentry-opentelemetry:sentry-opentelemetry-agentcustomization",
     "sentry-opentelemetry:sentry-opentelemetry-agent",
     "sentry-opentelemetry:sentry-opentelemetry-agentless",
+    "sentry-opentelemetry:sentry-opentelemetry-agentless-spring",
     "sentry-quartz",
     "sentry-okhttp",
     "sentry-samples:sentry-samples-android",