From fae85e1922f2dc83ba44682d8b3dfff28511a0f7 Mon Sep 17 00:00:00 2001 From: Lukas Bloder Date: Tue, 10 Dec 2024 10:11:37 +0100 Subject: [PATCH 01/11] update readmes for noagent samples, add otel properties to application.properties in noagent samples --- .../README.md | 2 +- .../src/main/resources/application.properties | 4 ++++ .../README.md | 2 +- .../src/main/resources/application.properties | 6 ++++++ 4 files changed, 12 insertions(+), 2 deletions(-) diff --git a/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/README.md b/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/README.md index 58b94ba899..89a8e603a3 100644 --- a/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/README.md +++ b/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/README.md @@ -1,6 +1,6 @@ # Sentry Sample Spring Boot 3.0+ -Sample application showing how to use Sentry with [Spring boot](http://spring.io/projects/spring-boot) from version `3.0` onwards. +Sample application showing how to use Sentry with [Spring boot](http://spring.io/projects/spring-boot) from version `3.0` onwards integrated with the [OpenTelemetry Spring Boot Starter](https://opentelemetry.io/docs/zero-code/java/spring-boot-starter/). ## How to run? diff --git a/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/src/main/resources/application.properties b/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/src/main/resources/application.properties index 1c21d32049..402538a83a 100644 --- a/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/src/main/resources/application.properties +++ b/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/src/main/resources/application.properties @@ -31,4 +31,8 @@ spring.graphql.graphiql.enabled=true spring.graphql.websocket.path=/graphql spring.quartz.job-store-type=memory +# OTEL configuration otel.propagators=tracecontext,baggage,sentry +otel.logs.exporter=none +otel.metrics.exporter=none +otel.traces.exporter=none diff --git a/sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/README.md b/sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/README.md index bd8d0af480..e8068dab25 100644 --- a/sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/README.md +++ b/sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/README.md @@ -1,6 +1,6 @@ # Sentry Sample Spring Boot -Sample application showing how to use Sentry with [Spring boot](http://spring.io/projects/spring-boot). +Sample application showing how to use Sentry with [Spring boot](http://spring.io/projects/spring-boot) integrated with the [OpenTelemetry Spring Boot Starter](https://opentelemetry.io/docs/zero-code/java/spring-boot-starter/). ## How to run? diff --git a/sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/src/main/resources/application.properties b/sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/src/main/resources/application.properties index c7402eacc2..43d84aeb41 100644 --- a/sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/src/main/resources/application.properties +++ b/sentry-samples/sentry-samples-spring-boot-opentelemetry-noagent/src/main/resources/application.properties @@ -23,3 +23,9 @@ spring.datasource.username=sa spring.datasource.password= spring.graphql.graphiql.enabled=true spring.graphql.websocket.path=/graphql + +# OTEL configuration +otel.propagators=tracecontext,baggage,sentry +otel.logs.exporter=none +otel.metrics.exporter=none +otel.traces.exporter=none From 4fa43273e9f9907b075a1ed83ed9fd52bfec1652 Mon Sep 17 00:00:00 2001 From: Lukas Bloder Date: Tue, 10 Dec 2024 16:10:51 +0100 Subject: [PATCH 02/11] update readme for console - noagent --- .../sentry-samples-console-opentelemetry-noagent/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sentry-samples/sentry-samples-console-opentelemetry-noagent/README.md b/sentry-samples/sentry-samples-console-opentelemetry-noagent/README.md index 9e4b9e3e8a..bc918c5824 100644 --- a/sentry-samples/sentry-samples-console-opentelemetry-noagent/README.md +++ b/sentry-samples/sentry-samples-console-opentelemetry-noagent/README.md @@ -1,6 +1,6 @@ # Sentry Sample Console -Sample application showing how to use Sentry manually without any framework integration. +Sample application showing how to use Sentry with OpenTelemetry manually without any framework integration and without java agent. ## How to run? From 44d5b429da3b780eda69633c3b91d65485dd6aab Mon Sep 17 00:00:00 2001 From: Lukas Bloder Date: Tue, 10 Dec 2024 16:24:53 +0100 Subject: [PATCH 03/11] update opentelemetry and optentelemetry agent readme --- sentry-opentelemetry/README.md | 35 +++++++++++++++++-- .../sentry-opentelemetry-agent/README.md | 7 +--- 2 files changed, 34 insertions(+), 8 deletions(-) diff --git a/sentry-opentelemetry/README.md b/sentry-opentelemetry/README.md index 02c5e3f1ae..47a8113568 100644 --- a/sentry-opentelemetry/README.md +++ b/sentry-opentelemetry/README.md @@ -21,8 +21,7 @@ application. Please see the module [README](sentry-opentelemetry-agent/README.md This contains customizations to the OpenTelemetry Java Agent such as registering the `SentrySpanProcessor` and `SentryPropagator` as well as providing default properties that -enable the `sentry` propagator and disable exporters so our agent doesn't trigger lots of log -warnings due to OTLP server not being there. This can also be used without the agent. +enable the `sentry` propagator. This can also be used without the agent. ### `sentry-opentelemetry-bootstrap` @@ -40,3 +39,35 @@ Contains `SentrySpanProcessor` and `SentryPropagator` which are used by our Java be used when manually instrumenting using OpenTelemetry. If you want to use OpenTelemetry without the agent but still want some configuration convenience, you should rather use the `sentry-opentelemetry-agentcustomization` module. + +## Running without an Agent +If you want to use Sentry with OpenTelemetry without an agent, you can do so by adding the `sentry-opentelemetry-agentcustomization` +and `sentryopentelemetry-bootstrap` modules as dependencies to your project. + +You can then initialize Sentry with OpenTelemetry like this: + +```java +// Initialize OpenTelemetry by using the AutoConfiguredOpenTelemetrySdk which automatically +// registers the `SentrySpanProcessor` and `SentryPropagator` and others. +// Additionally, you can disable the OTEL exporters to avoid seeing error messages in the logs. +final OpenTelemetrySdk sdk = AutoConfiguredOpenTelemetrySdk.builder() + .addPropertiesSupplier(() -> { + final Map properties = new HashMap<>(); + properties.put("otel.logs.exporter", "none"); + properties.put("otel.metrics.exporter", "none"); + properties.put("otel.traces.exporter", "none"); + return properties; + }) + .build().getOpenTelemetrySdk(); + +// Set the global OpenTelemetry instance +GlobalOpenTelemetry.set(sdk); + +// Initialize Sentry +Sentry.init( + options -> { + options.setDsn("..."); + ... + } +) +``` diff --git a/sentry-opentelemetry/sentry-opentelemetry-agent/README.md b/sentry-opentelemetry/sentry-opentelemetry-agent/README.md index 92ddb89a1c..321f1b2696 100644 --- a/sentry-opentelemetry/sentry-opentelemetry-agent/README.md +++ b/sentry-opentelemetry/sentry-opentelemetry-agent/README.md @@ -22,22 +22,17 @@ For more details on configuring Sentry via `sentry.properties` please see the 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 set the `instrumenter` to `otel`, e.g. -like this: +your target application: ``` Sentry.init( options -> { options.setDsn("..."); ... - options.setInstrumenter(Instrumenter.OTEL); } ) ``` -Using the `otel` instrumenter will ensure `Sentry` instrumentation will be done via OpenTelemetry -and integrations as well as direct interactions with transactions and spans have no effect. - ## Controlling auto initialization of Sentry By default if you pass either `SENTRY_DSN` or `SENTRY_PROPERTIES_FILE` as environment variable, From 8e9ce937f3d730d5d7e84ebfb3078186f3e78f0c Mon Sep 17 00:00:00 2001 From: Lukas Bloder Date: Tue, 17 Dec 2024 12:36:26 +0100 Subject: [PATCH 04/11] add java options and new agentless module to readme --- sentry-opentelemetry/README.md | 33 ++++++++++++++++++++++----------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/sentry-opentelemetry/README.md b/sentry-opentelemetry/README.md index 47a8113568..fcd352d52e 100644 --- a/sentry-opentelemetry/README.md +++ b/sentry-opentelemetry/README.md @@ -21,7 +21,7 @@ application. Please see the module [README](sentry-opentelemetry-agent/README.md This contains customizations to the OpenTelemetry Java Agent such as registering the `SentrySpanProcessor` and `SentryPropagator` as well as providing default properties that -enable the `sentry` propagator. This can also be used without the agent. +enable the `sentry` propagator. ### `sentry-opentelemetry-bootstrap` @@ -38,31 +38,42 @@ you also need this module as a dependency. Contains `SentrySpanProcessor` and `SentryPropagator` which are used by our Java Agent but can also be used when manually instrumenting using OpenTelemetry. If you want to use OpenTelemetry without the agent but still want some configuration convenience, you should rather use the -`sentry-opentelemetry-agentcustomization` module. +`sentry-opentelemetry-agentless` module. + +### `sentry-opentelemetry-agentless` +Combines all modules and dependencies needed to use Sentry with OpenTelemetry without the agent. ## Running without an Agent -If you want to use Sentry with OpenTelemetry without an agent, you can do so by adding the `sentry-opentelemetry-agentcustomization` -and `sentryopentelemetry-bootstrap` modules as dependencies to your project. +If you want to use Sentry with OpenTelemetry without an agent, you can do so by adding the `sentry-opentelemetry-agentless` module as dependencies to your project. + +And run your application with the following JVM arguments: +``` +-Dotel.java.global-autoconfigure.enabled=true +``` +You may also want to set the following environment variables to if you do not use OTEL exporters: +`OTEL_LOGS_EXPORTER=none;OTEL_METRICS_EXPORTER=none;OTEL_TRACES_EXPORTER=none` -You can then initialize Sentry with OpenTelemetry like this: +Alternatively you can initialize OpenTelemetry programmatically like this: ```java // Initialize OpenTelemetry by using the AutoConfiguredOpenTelemetrySdk which automatically // registers the `SentrySpanProcessor` and `SentryPropagator` and others. -// Additionally, you can disable the OTEL exporters to avoid seeing error messages in the logs. -final OpenTelemetrySdk sdk = AutoConfiguredOpenTelemetrySdk.builder() +// Also, you need to disable the OTEL exporters if you do not use them. +AutoConfiguredOpenTelemetrySdk.builder() + .setResultAsGlobal() .addPropertiesSupplier(() -> { - final Map properties = new HashMap<>(); +final Map properties = new HashMap<>(); properties.put("otel.logs.exporter", "none"); properties.put("otel.metrics.exporter", "none"); properties.put("otel.traces.exporter", "none"); return properties; }) - .build().getOpenTelemetrySdk(); + .build(); +``` -// Set the global OpenTelemetry instance -GlobalOpenTelemetry.set(sdk); +And then initialize Sentry as usual: +```java // Initialize Sentry Sentry.init( options -> { From 0926957cea21e2565d670b6de77f7e42f6f7b5fe Mon Sep 17 00:00:00 2001 From: Lukas Bloder Date: Tue, 7 Jan 2025 16:17:06 +0100 Subject: [PATCH 05/11] update readmes --- sentry-opentelemetry/README.md | 5 +- .../sentry-opentelemetry-agent/README.md | 23 ++++--- .../README.md | 54 ++++------------- .../sentry-opentelemetry-agentless/README.md | 60 ++++++++++--------- .../README.md | 2 +- 5 files changed, 62 insertions(+), 82 deletions(-) diff --git a/sentry-opentelemetry/README.md b/sentry-opentelemetry/README.md index fcd352d52e..6391fd32ca 100644 --- a/sentry-opentelemetry/README.md +++ b/sentry-opentelemetry/README.md @@ -38,11 +38,14 @@ you also need this module as a dependency. Contains `SentrySpanProcessor` and `SentryPropagator` which are used by our Java Agent but can also be used when manually instrumenting using OpenTelemetry. If you want to use OpenTelemetry without the agent but still want some configuration convenience, you should rather use the -`sentry-opentelemetry-agentless` module. +`sentry-opentelemetry-agentless` module or the `sentry-opentelemetry-agentless-spring` module if you are using Spring Boot. ### `sentry-opentelemetry-agentless` Combines all modules and dependencies needed to use Sentry with OpenTelemetry without the agent. +### `sentry-opentelemetry-agentless-spring` +Combines all modules and dependencies needed to use Sentry with OpenTelemetry in SpringBoot without an agent. + ## Running without an Agent If you want to use Sentry with OpenTelemetry without an agent, you can do so by adding the `sentry-opentelemetry-agentless` module as dependencies to your project. diff --git a/sentry-opentelemetry/sentry-opentelemetry-agent/README.md b/sentry-opentelemetry/sentry-opentelemetry-agent/README.md index 321f1b2696..55646f3b16 100644 --- a/sentry-opentelemetry/sentry-opentelemetry-agent/README.md +++ b/sentry-opentelemetry/sentry-opentelemetry-agent/README.md @@ -21,8 +21,14 @@ 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: +settings as environment variables (e.g. `SENTRY_DSN=...`). + +## Controlling auto initialization of Sentry + +By default, if you pass either `SENTRY_DSN` or `SENTRY_PROPERTIES_FILE` as environment variable, +Sentry will automatically be initialized by this agent. To disable this behaviour, you can set +`SENTRY_AUTO_INIT=false` as environment variable. You will then have to initialize Sentry inside +the target application: ``` Sentry.init( @@ -33,13 +39,6 @@ Sentry.init( ) ``` -## Controlling auto initialization of Sentry - -By default if you pass either `SENTRY_DSN` or `SENTRY_PROPERTIES_FILE` as environment variable, -Sentry will automatically be initialized by this agent. To disable this behaviour, you can set -`SENTRY_AUTO_INIT=false` as environment variable. You will then have to initialize Sentry inside -the target application. - ## Debugging To enable debug logging for Sentry, please provide `SENTRY_DEBUG=true` as environment variable or @@ -57,6 +56,7 @@ 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 +ERROR io.opentelemetry.exporter.internal.http.HttpExporter - Failed to export logs. The request could not be executed. Full error message: Failed to connect to localhost/[0:0:0:0:0:0:0:1]:4318 ``` ### Traces @@ -68,3 +68,8 @@ see [OpenTelemetry GitHub](https://github.com/open-telemetry/opentelemetry-java/ 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) + +### Logs + +To turn off log exporting, set `OTEL_LOGS_EXPORTER=none` +see [OpenTelemetry GitHub](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure#otlp-exporter-span-metric-and-log-exporters). diff --git a/sentry-opentelemetry/sentry-opentelemetry-agentless-spring/README.md b/sentry-opentelemetry/sentry-opentelemetry-agentless-spring/README.md index b808195c90..7fda913fac 100644 --- a/sentry-opentelemetry/sentry-opentelemetry-agentless-spring/README.md +++ b/sentry-opentelemetry/sentry-opentelemetry-agentless-spring/README.md @@ -2,53 +2,21 @@ *NOTE: Our OpenTelemetry modules are still experimental. Any feedback is welcome.* +This module allows the use of Sentry with OpenTelemetry in SpringBoot without an agent by using the OpenTelemetry Spring Boot Starter. +For guidance on when to use this module instead of the agent, please have a look at the [OpenTelemetry Spring Boot Starter documentation](https://opentelemetry.io/docs/zero-code/java/spring-boot-starter/). + ## 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: +Add the latest `sentry-opentelemetry-agentless-spring` module as a dependency to your Sentry enabled [SpringBoot](https://docs.sentry.io/platforms/java/guides/spring-boot/) application and add the following to your `application.properties`: ```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 +# OTEL configuration +otel.propagators=tracecontext,baggage,sentry +otel.logs.exporter=none +otel.metrics.exporter=none +otel.traces.exporter=none ``` -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 +This module will automatically configure OpenTelemetry and Sentry for you. -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) +With the dependency and configuration in place, just run your SpringBoot application as usual. diff --git a/sentry-opentelemetry/sentry-opentelemetry-agentless/README.md b/sentry-opentelemetry/sentry-opentelemetry-agentless/README.md index 9ce3319bae..7fd9ee156b 100644 --- a/sentry-opentelemetry/sentry-opentelemetry-agentless/README.md +++ b/sentry-opentelemetry/sentry-opentelemetry-agentless/README.md @@ -17,38 +17,42 @@ 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: +settings as environment variables (e.g. `SENTRY_DSN=...`). +Run your application with the following JVM arguments: ``` -Sentry.init( - options -> { - options.setDsn("..."); - ... - OpenTelemetryUtil.applyOpenTelemetryOptions(options, false); - } -) +-Dotel.java.global-autoconfigure.enabled=true ``` -## 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 +You may also want to set the following environment variables to if you do not use OTEL exporters: +`OTEL_LOGS_EXPORTER=none;OTEL_METRICS_EXPORTER=none;OTEL_TRACES_EXPORTER=none` + +Alternatively you can initialize OpenTelemetry programmatically like this: + +```java +// Initialize OpenTelemetry by using the AutoConfiguredOpenTelemetrySdk which automatically +// registers the `SentrySpanProcessor` and `SentryPropagator` and others. +// Also, you need to disable the OTEL exporters if you do not use them. +AutoConfiguredOpenTelemetrySdk.builder() + .setResultAsGlobal() + .addPropertiesSupplier(() -> { +final Map properties = new HashMap<>(); + properties.put("otel.logs.exporter", "none"); + properties.put("otel.metrics.exporter", "none"); + properties.put("otel.traces.exporter", "none"); + return properties; + }) + .build(); ``` -### Traces +If you're not using `sentry.properties` or environment variables you can then initialize Sentry programmatically as usual: -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) +```java +// Initialize Sentry +Sentry.init( + options -> { + options.setDsn("..."); + ... + } +) +``` diff --git a/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/README.md b/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/README.md index 89a8e603a3..4a5f2a7739 100644 --- a/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/README.md +++ b/sentry-samples/sentry-samples-spring-boot-jakarta-opentelemetry-noagent/README.md @@ -1,6 +1,6 @@ # Sentry Sample Spring Boot 3.0+ -Sample application showing how to use Sentry with [Spring boot](http://spring.io/projects/spring-boot) from version `3.0` onwards integrated with the [OpenTelemetry Spring Boot Starter](https://opentelemetry.io/docs/zero-code/java/spring-boot-starter/). +Sample application showing how to use Sentry with [Spring boot](http://spring.io/projects/spring-boot) from version `3.0` onwards integrated with the [OpenTelemetry Spring Boot Starter](https://opentelemetry.io/docs/zero-code/java/spring-boot-starter/) without an agent. ## How to run? From 84b6fb1cdccaa188ce0aad7b10e79031c887dcb8 Mon Sep 17 00:00:00 2001 From: Lukas Bloder Date: Tue, 21 Jan 2025 14:24:31 +0100 Subject: [PATCH 06/11] Update sentry-opentelemetry/README.md Co-authored-by: Alexander Dinauer --- sentry-opentelemetry/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sentry-opentelemetry/README.md b/sentry-opentelemetry/README.md index 6391fd32ca..0553feac43 100644 --- a/sentry-opentelemetry/README.md +++ b/sentry-opentelemetry/README.md @@ -47,7 +47,7 @@ Combines all modules and dependencies needed to use Sentry with OpenTelemetry wi Combines all modules and dependencies needed to use Sentry with OpenTelemetry in SpringBoot without an agent. ## Running without an Agent -If you want to use Sentry with OpenTelemetry without an agent, you can do so by adding the `sentry-opentelemetry-agentless` module as dependencies to your project. +If you want to use Sentry with OpenTelemetry without an agent, you can do so by adding the `sentry-opentelemetry-agentless` (or `sentry-opentelemetry-agentless-spring`) module as dependency to your project. And run your application with the following JVM arguments: ``` From 987b8bdea0cf544b88b13f497d32d1cce93d063e Mon Sep 17 00:00:00 2001 From: Lukas Bloder Date: Tue, 21 Jan 2025 14:24:41 +0100 Subject: [PATCH 07/11] Update sentry-opentelemetry/README.md Co-authored-by: Alexander Dinauer --- sentry-opentelemetry/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sentry-opentelemetry/README.md b/sentry-opentelemetry/README.md index 0553feac43..a82bad322a 100644 --- a/sentry-opentelemetry/README.md +++ b/sentry-opentelemetry/README.md @@ -53,7 +53,7 @@ And run your application with the following JVM arguments: ``` -Dotel.java.global-autoconfigure.enabled=true ``` -You may also want to set the following environment variables to if you do not use OTEL exporters: +You may also want to set the following environment variables to if you do not use OpenTelemetry exporters: `OTEL_LOGS_EXPORTER=none;OTEL_METRICS_EXPORTER=none;OTEL_TRACES_EXPORTER=none` Alternatively you can initialize OpenTelemetry programmatically like this: From e9253901f6e84efda9f6ce5f882e0b4e0d27a125 Mon Sep 17 00:00:00 2001 From: Lukas Bloder Date: Tue, 21 Jan 2025 14:24:57 +0100 Subject: [PATCH 08/11] Update sentry-opentelemetry/sentry-opentelemetry-agent/README.md Co-authored-by: Alexander Dinauer --- sentry-opentelemetry/sentry-opentelemetry-agent/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sentry-opentelemetry/sentry-opentelemetry-agent/README.md b/sentry-opentelemetry/sentry-opentelemetry-agent/README.md index 55646f3b16..58abe22587 100644 --- a/sentry-opentelemetry/sentry-opentelemetry-agent/README.md +++ b/sentry-opentelemetry/sentry-opentelemetry-agent/README.md @@ -27,7 +27,7 @@ settings as environment variables (e.g. `SENTRY_DSN=...`). By default, if you pass either `SENTRY_DSN` or `SENTRY_PROPERTIES_FILE` as environment variable, Sentry will automatically be initialized by this agent. To disable this behaviour, you can set -`SENTRY_AUTO_INIT=false` as environment variable. You will then have to initialize Sentry inside +`SENTRY_AUTO_INIT=false` as environment variable. You will then have to use a Sentry SDK that takes care of initialization or initialize Sentry manually inside the target application: ``` From 556a7f8c95ea3d8281e1a4625c302ee1ec754bb1 Mon Sep 17 00:00:00 2001 From: Lukas Bloder Date: Tue, 21 Jan 2025 14:25:28 +0100 Subject: [PATCH 09/11] Update sentry-opentelemetry/sentry-opentelemetry-agentless/README.md Co-authored-by: Alexander Dinauer --- sentry-opentelemetry/sentry-opentelemetry-agentless/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sentry-opentelemetry/sentry-opentelemetry-agentless/README.md b/sentry-opentelemetry/sentry-opentelemetry-agentless/README.md index 7fd9ee156b..5c3a5a1ae6 100644 --- a/sentry-opentelemetry/sentry-opentelemetry-agentless/README.md +++ b/sentry-opentelemetry/sentry-opentelemetry-agentless/README.md @@ -24,7 +24,7 @@ Run your application with the following JVM arguments: -Dotel.java.global-autoconfigure.enabled=true ``` -You may also want to set the following environment variables to if you do not use OTEL exporters: +You may also want to set the following environment variables to if you do not use OpenTelemetry exporters: `OTEL_LOGS_EXPORTER=none;OTEL_METRICS_EXPORTER=none;OTEL_TRACES_EXPORTER=none` Alternatively you can initialize OpenTelemetry programmatically like this: From 793698bfe982dbb6f7b04cb41bb3d841f213a496 Mon Sep 17 00:00:00 2001 From: Lukas Bloder Date: Tue, 21 Jan 2025 14:28:39 +0100 Subject: [PATCH 10/11] Update sentry-opentelemetry/README.md Co-authored-by: Alexander Dinauer --- sentry-opentelemetry/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sentry-opentelemetry/README.md b/sentry-opentelemetry/README.md index a82bad322a..2ad349296b 100644 --- a/sentry-opentelemetry/README.md +++ b/sentry-opentelemetry/README.md @@ -44,7 +44,7 @@ the agent but still want some configuration convenience, you should rather use t Combines all modules and dependencies needed to use Sentry with OpenTelemetry without the agent. ### `sentry-opentelemetry-agentless-spring` -Combines all modules and dependencies needed to use Sentry with OpenTelemetry in SpringBoot without an agent. +Combines all modules and dependencies needed to use Sentry with OpenTelemetry in Spring Boot without an agent. ## Running without an Agent If you want to use Sentry with OpenTelemetry without an agent, you can do so by adding the `sentry-opentelemetry-agentless` (or `sentry-opentelemetry-agentless-spring`) module as dependency to your project. From 36c0361aeb46888f63d0b31cbdccec2daefd318c Mon Sep 17 00:00:00 2001 From: Lukas Bloder Date: Tue, 21 Jan 2025 14:30:58 +0100 Subject: [PATCH 11/11] remove experimental note in opentelemetry readmes --- sentry-opentelemetry/README.md | 2 -- sentry-opentelemetry/sentry-opentelemetry-agent/README.md | 2 -- .../sentry-opentelemetry-agentless-spring/README.md | 2 -- sentry-opentelemetry/sentry-opentelemetry-agentless/README.md | 2 -- 4 files changed, 8 deletions(-) diff --git a/sentry-opentelemetry/README.md b/sentry-opentelemetry/README.md index a82bad322a..ea2c12c66d 100644 --- a/sentry-opentelemetry/README.md +++ b/sentry-opentelemetry/README.md @@ -1,7 +1,5 @@ # sentry-opentelemetry -*NOTE: Our OpenTelemetry modules are still experimental. Any feedback is welcome.* - ## OpenTelemetry More information on OpenTelemetry can be found on their [website](https://opentelemetry.io/) as well diff --git a/sentry-opentelemetry/sentry-opentelemetry-agent/README.md b/sentry-opentelemetry/sentry-opentelemetry-agent/README.md index 58abe22587..e6feb1f3ae 100644 --- a/sentry-opentelemetry/sentry-opentelemetry-agent/README.md +++ b/sentry-opentelemetry/sentry-opentelemetry-agent/README.md @@ -1,7 +1,5 @@ # sentry-opentelemetry-agent -*NOTE: Our OpenTelemetry modules are still experimental. Any feedback is welcome.* - ## How to use it Download the latest `sentry-opentelemetry-agent.jar` and use it when launching your Java diff --git a/sentry-opentelemetry/sentry-opentelemetry-agentless-spring/README.md b/sentry-opentelemetry/sentry-opentelemetry-agentless-spring/README.md index 7fda913fac..9e4bd992fb 100644 --- a/sentry-opentelemetry/sentry-opentelemetry-agentless-spring/README.md +++ b/sentry-opentelemetry/sentry-opentelemetry-agentless-spring/README.md @@ -1,7 +1,5 @@ # sentry-opentelemetry-agentless-spring -*NOTE: Our OpenTelemetry modules are still experimental. Any feedback is welcome.* - This module allows the use of Sentry with OpenTelemetry in SpringBoot without an agent by using the OpenTelemetry Spring Boot Starter. For guidance on when to use this module instead of the agent, please have a look at the [OpenTelemetry Spring Boot Starter documentation](https://opentelemetry.io/docs/zero-code/java/spring-boot-starter/). diff --git a/sentry-opentelemetry/sentry-opentelemetry-agentless/README.md b/sentry-opentelemetry/sentry-opentelemetry-agentless/README.md index 5c3a5a1ae6..8663a6caa9 100644 --- a/sentry-opentelemetry/sentry-opentelemetry-agentless/README.md +++ b/sentry-opentelemetry/sentry-opentelemetry-agentless/README.md @@ -1,7 +1,5 @@ # sentry-opentelemetry-agentless -*NOTE: Our OpenTelemetry modules are still experimental. Any feedback is welcome.* - ## How to use it Add the latest `sentry-opentelemetry-agentless` module as a dependency and add a `sentry.properties`