From 5397ffd04a20af297d2e4e8785c449e3eca00c39 Mon Sep 17 00:00:00 2001 From: lcian Date: Fri, 14 Mar 2025 10:34:06 +0100 Subject: [PATCH 1/2] feat(java): document adding the Sentry OTEL agent using JAVA_TOOL_OPTIONS --- .../getting-started-install/opentelemetry/java.mdx | 6 +++++- .../opentelemetry/java.spring-boot.mdx | 7 ++++++- .../opentelemetry/java.spring.mdx | 14 +++++++++++--- .../with-java-agent/with-auto-init/java.mdx | 5 ++++- .../with-java-agent/without-auto-init/java.mdx | 5 ++++- .../without-auto-init/java.spring-boot.mdx | 5 ++++- 6 files changed, 34 insertions(+), 8 deletions(-) diff --git a/platform-includes/getting-started-install/opentelemetry/java.mdx b/platform-includes/getting-started-install/opentelemetry/java.mdx index 58b995130f111..1e625d64d6535 100644 --- a/platform-includes/getting-started-install/opentelemetry/java.mdx +++ b/platform-includes/getting-started-install/opentelemetry/java.mdx @@ -7,7 +7,11 @@ curl https://repo1.maven.org/maven2/io/sentry/sentry-opentelemetry-agent/{{@inje ``` Then run your application with: -```bash +```bash {tabTitle: Environment variable} +SENTRY_PROPERTIES_FILE=sentry.properties JAVA_TOOL_OPTIONS="-javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar" java -jar your-application.jar +``` + +```bash {tabTitle: Java CLI argument} SENTRY_PROPERTIES_FILE=sentry.properties java -javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar -jar your-application.jar ``` diff --git a/platform-includes/getting-started-install/opentelemetry/java.spring-boot.mdx b/platform-includes/getting-started-install/opentelemetry/java.spring-boot.mdx index d12eea460de92..1c6c8205d0f96 100644 --- a/platform-includes/getting-started-install/opentelemetry/java.spring-boot.mdx +++ b/platform-includes/getting-started-install/opentelemetry/java.spring-boot.mdx @@ -7,7 +7,12 @@ curl https://repo1.maven.org/maven2/io/sentry/sentry-opentelemetry-agent/{{@inje ``` Then run your application with: -```bash + +```bash {tabTitle: Environment variable} +SENTRY_AUTO_INIT=false JAVA_TOOL_OPTIONS="-javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar" java -jar your-application.jar +``` + +```bash {tabTitle: Java CLI argument} SENTRY_AUTO_INIT=false java -javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar -jar your-application.jar ``` diff --git a/platform-includes/getting-started-install/opentelemetry/java.spring.mdx b/platform-includes/getting-started-install/opentelemetry/java.spring.mdx index e6f02b754bbfe..96fac632c1f18 100644 --- a/platform-includes/getting-started-install/opentelemetry/java.spring.mdx +++ b/platform-includes/getting-started-install/opentelemetry/java.spring.mdx @@ -8,12 +8,20 @@ curl https://repo1.maven.org/maven2/io/sentry/sentry-opentelemetry-agent/{{@inje ``` Then run your application with: -```bash +```bash {tabTitle: Environment variable} +SENTRY_AUTO_INIT=false JAVA_TOOL_OPTIONS="-javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar" java -jar your-application.jar +``` + +```bash {tabTitle: Java CLI argument} SENTRY_AUTO_INIT=false java -javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar -jar your-application.jar ``` In case of an application server, adding the Agent might look more like the following: -```bash -JAVA_OPTS="${JAVA_OPTS} -javaagent:/somewhere/sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}" +```bash {tabTitle: Environment variable} +JAVA_OPTS="${JAVA_OPTS} JAVA_TOOL_OPTIONS="-javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar" +``` + +```bash {tabTitle: Java CLI argument} +JAVA_OPTS="${JAVA_OPTS} -javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar" ``` diff --git a/platform-includes/performance/opentelemetry-setup/with-java-agent/with-auto-init/java.mdx b/platform-includes/performance/opentelemetry-setup/with-java-agent/with-auto-init/java.mdx index 28425548adbb6..e29a7f2e31580 100644 --- a/platform-includes/performance/opentelemetry-setup/with-java-agent/with-auto-init/java.mdx +++ b/platform-includes/performance/opentelemetry-setup/with-java-agent/with-auto-init/java.mdx @@ -1,7 +1,10 @@ This `java` command shows how to run your application using `sentry-opentelemetry-agent`: +```bash {tabTitle: Environment variable} +SENTRY_PROPERTIES_FILE=sentry.properties JAVA_TOOL_OPTIONS="-javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar" java -jar your-application.jar +``` -```bash +```bash {tabTitle: Java CLI argument} SENTRY_PROPERTIES_FILE=sentry.properties java -javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar -jar your-application.jar ``` diff --git a/platform-includes/performance/opentelemetry-setup/with-java-agent/without-auto-init/java.mdx b/platform-includes/performance/opentelemetry-setup/with-java-agent/without-auto-init/java.mdx index b3477d5b9c60b..5f31e3f5ae0d4 100644 --- a/platform-includes/performance/opentelemetry-setup/with-java-agent/without-auto-init/java.mdx +++ b/platform-includes/performance/opentelemetry-setup/with-java-agent/without-auto-init/java.mdx @@ -1,7 +1,10 @@ This `java` command shows how to run your application using `sentry-opentelemetry-agent`: +```bash {tabTitle: Environment variable} +SENTRY_AUTO_INIT=false JAVA_TOOL_OPTIONS="-javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar" java -jar your-application.jar +``` -```bash +```bash {tabTitle: Java CLI argument} SENTRY_AUTO_INIT=false java -javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar -jar your-application.jar ``` diff --git a/platform-includes/performance/opentelemetry-setup/with-java-agent/without-auto-init/java.spring-boot.mdx b/platform-includes/performance/opentelemetry-setup/with-java-agent/without-auto-init/java.spring-boot.mdx index 03cd5d7664154..4c2596f132444 100644 --- a/platform-includes/performance/opentelemetry-setup/with-java-agent/without-auto-init/java.spring-boot.mdx +++ b/platform-includes/performance/opentelemetry-setup/with-java-agent/without-auto-init/java.spring-boot.mdx @@ -1,7 +1,10 @@ This `java` command shows how to run your application using `sentry-opentelemetry-agent`: +```bash {tabTitle: Environment variable} +SENTRY_AUTO_INIT=false JAVA_TOOL_OPTIONS="-javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar" java -jar your-application.jar +``` -```bash +```bash {tabTitle: Java CLI argument} SENTRY_AUTO_INIT=false java -javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar -jar your-application.jar ``` From 4359a857faf2ef524c4a3f63dab979aa97327471 Mon Sep 17 00:00:00 2001 From: lcian Date: Fri, 14 Mar 2025 10:38:34 +0100 Subject: [PATCH 2/2] fix --- .../getting-started-install/opentelemetry/java.spring.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/platform-includes/getting-started-install/opentelemetry/java.spring.mdx b/platform-includes/getting-started-install/opentelemetry/java.spring.mdx index 96fac632c1f18..47bdf895ee087 100644 --- a/platform-includes/getting-started-install/opentelemetry/java.spring.mdx +++ b/platform-includes/getting-started-install/opentelemetry/java.spring.mdx @@ -22,6 +22,6 @@ JAVA_OPTS="${JAVA_OPTS} JAVA_TOOL_OPTIONS="-javaagent:sentry-opentelemetry-agent ``` ```bash {tabTitle: Java CLI argument} -JAVA_OPTS="${JAVA_OPTS} -javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar" +JAVA_OPTS="${JAVA_OPTS} JAVA_TOOL_OPTIONS="-javaagent:sentry-opentelemetry-agent-{{@inject packages.version('sentry.java.opentelemetry-agent') }}.jar" ```