Jboss - Signoz — ContextQMD

Requirements

Java 8 or higher

Send Traces to SigNoz Cloud

OpenTelemetry provides a handy Java JAR agent that can be attached to any Java 8+ application and dynamically injects bytecode to capture telemetry from a number of popular libraries and frameworks.

Based on your application environment, you can choose the setup below to send traces to SigNoz Cloud.

Application on VMs

From VMs, there are two ways to send data to SigNoz Cloud.

Send traces directly to SigNoz Cloud (quick start)
Send traces via OTel Collector binary (recommended)

Send traces directly to SigNoz Cloud

OpenTelemetry Java agent can send traces directly to SigNoz Cloud.

Step 1. Download otel java binary agent

bash

wget https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar

Step 2. Open the configuration file

bash

vim /opt/jboss-eap-7.1/bin/standalone.conf

Step 3. Update JAVA_OPTS environment variable

Update JAVA_OPTS environment variable with configurations required to send data to SigNoz cloud in your configuration file.

bash

JAVA_OPTS="-javaagent:/<path>/opentelemetry-javaagent.jar
-Dotel.exporter.otlp.endpoint=https://ingest.{{REGION}}.signoz.cloud:443
-Dotel.exporter.otlp.headers="signoz-ingestion-key={{SIGNOZ_INGESTION_KEY}}"
-Dotel.resource.attributes="service.name={{MYAPP}}""

You need to replace the following things based on your environment:

<path> - Update it to the path of your downloaded Java JAR agent.

Step 4. [Optional] Write the output/logs of standalone.sh script to a file nohup.out as a background thread

bash

/opt/jboss-eap-7.1/bin/standalone.sh > /opt/jboss-eap-7.1/bin/nohup.out &

Send traces via OTel Collector binary

OTel Collector binary helps to collect logs, hostmetrics, resource and infra attributes. It is recommended to install Otel Collector binary to collect and send traces to SigNoz cloud. You can correlate signals and have rich contextual data through this way.

You can find instructions to install OTel Collector binary here in your VM. Once you are done setting up your OTel Collector binary, you can follow the below steps for instrumenting your Java application.

Step 1. Download OTel java binary agent

bash

wget https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar

Step 2. Open the configuration file

bash

vim /opt/jboss-eap-7.1/bin/standalone.conf

Step 3. Update JAVA_OPTS environment variable

Update JAVA_OPTS environment variable with configurations required to send data to SigNoz cloud in your configuration file.

bash

JAVA_OPTS="-javaagent:/<path>/opentelemetry-javaagent.jar"

where,

<path> - Update it to the path of your downloaded Java JAR agent.

Applications Deployed on Kubernetes

For Java application deployed on Kubernetes, you need to install OTel Collector agent in your k8s infra to collect and send traces to SigNoz Cloud. You can find the instructions to install OTel Collector agent here.

Once you have set up OTel Collector agent, you can proceed with OpenTelemetry java instrumentation by following the below steps:

Step 1. Download otel java binary

bash

wget https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar

Step 2. Open the configuration file

bash

vim /opt/jboss-eap-7.1/bin/standalone.conf

Step 3. Update JAVA_OPTS environment variable

Update JAVA_OPTS environment variable with configurations required to send data to SigNoz cloud in your configuration file.

bash

JAVA_OPTS="-javaagent:/<path>/opentelemetry-javaagent.jar"

where,

<path> - Update it to the path of your downloaded Java JAR agent.

Step 4. Make sure to dockerise your application along with OpenTelemetry instrumentation.