Skip to main content
Veuillez suivre d’abord le guide d’installation lorsque vous ajoutez une nouvelle application à AppSignal. Ensuite, assurez-vous d’installer le collecteur AppSignal avant de continuer. Pour installer et configurer OpenTelemetry pour votre application Java, nous recommandons d’utiliser l’agent OpenTelemetry Java pour exporter les données vers le collecteur AppSignal. Cet agent instrumentera automatiquement votre application.

Télécharger l’agent OpenTelemetry Java

Téléchargez l’agent OpenTelemetry Java depuis la dernière version sur Github. Lorsque vous exécutez votre application, l’agent OpenTelemetry Java devra être présent.

Exécuter votre application avec l’agent

Lorsque vous exécutez votre application, vous devrez configurer le runtime Java pour charger l’agent OpenTelemetry Java. Modifiez la façon dont vous démarrez votre application pour charger l’agent OpenTelemetry Java avec votre application :
java -javaagent:/path/to/opentelemetry-javaagent.jar -jar your-application.jar
Remplacez /path/to/opentelemetry-javaagent.jar par le chemin vers l’agent téléchargé et your-application.jar par le chemin vers le fichier JAR de votre application.

Gradle

Lorsque vous utilisez Gradle, vous pouvez ajouter l’agent à la tâche qui démarre votre application dans le fichier build.gradle :
tasks.bootRun {
    jvmArgs = listOf("-javaagent:/path/to/opentelemetry-javaagent.jar")
    // With any other configuration after
}

Configurer l’agent

L’agent peut être configuré à l’aide de propriétés Java ou de variables d’environnement. Nous recommandons d’utiliser les variables d’environnement pour la configuration. Tout d’abord, configurez l’agent pour exporter les traces et les journaux vers le collecteur AppSignal :
# Export traces and metrics to the AppSignal collector using the OTLP protocol.
# Replace `http://localhost:8099` with the address of your AppSignal collector
# if it's running on another host.
export OTEL_TRACES_EXPORTER=otlp
export OTEL_METRICS_EXPORTER=otlp
export OTEL_LOGS_EXPORTER=otlp
export OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:8099
Ensuite, configurez les attributs de ressource OpenTelemetry requis par AppSignal :
# Replace these values with your AppSignal application name, environment
# and push API key. These are used by the resource attributes configuration below.
APPSIGNAL_APP_NAME=your-app-name
APPSIGNAL_APP_ENV=production
APPSIGNAL_PUSH_API_KEY=your-push-api-key

# Optionally, set a custom revision and hostname. If not set, the resource attributes
# configuration below will use the current Git revision and system hostname.
# REVISION=your-custom-revision
# HOSTNAME=your-custom-hostname

# Set the name of the service that is being monitored. A common choice is the
# name of the framework used. This is used to group traces and metrics in AppSignal.
export OTEL_SERVICE_NAME=my-service-name

export OTEL_RESOURCE_ATTRIBUTES="\
appsignal.config.name=$APPSIGNAL_APP_NAME,\
appsignal.config.environment=$APPSIGNAL_APP_ENV,\
appsignal.config.push_api_key=$APPSIGNAL_PUSH_API_KEY,\
appsignal.config.revision=${REVISION:-$(git rev-parse --short HEAD 2>/dev/null || echo unknown)},\
appsignal.config.language_integration=java,\
appsignal.config.app_path=$PWD,\
host.name=${HOSTNAME:-$(hostname)}\
"

Tester l’application !

Maintenant que tous les composants sont connectés, démarrez votre application avec les variables d’environnement requises et testez si vous voyez des données arriver dans AppSignal. Vérifiez les pages “Errors > Issue list” et “Performance > Traces” en particulier. Si après avoir suivi nos instructions d’installation, vous ne voyez toujours pas de données dans AppSignal, faites-le nous savoir et nous vous aiderons à finaliser votre installation OpenTelemetry !