Application Real-Time Monitoring Service:Install the ARMS agent for a Java application in Function Compute

Runtimes pris en charge et prérequis

Pour créer une fonction avec un runtime personnalisé, consultez la rubrique Créer une fonction.

Étape 1 : Obtenir une clé de licence

Appelez l'opération API DescribeTraceLicenseKey dans OpenAPI Explorer pour récupérer votre clé de licence ARMS. Conservez cette clé, car vous en aurez besoin à l'Étape 3.

Étape 2 : Ajouter la couche de l'agent ARMS

Function Compute propose des couches communes officielles qui regroupent l'agent ARMS pour chaque version Java prise en charge.

Remplacez {region} par l'ID de la région de votre fonction, par exemple cn-hangzhou.

Pour ajouter la couche dans la console Function Compute :

1. Connectez-vous à la console Function Compute. Dans le volet de navigation de gauche, cliquez sur Functions.

2. Dans la barre de navigation supérieure, sélectionnez une région. Sur la page Functions, cliquez sur la fonction cible.

3. Sur la page des détails de la fonction, cliquez sur l'onglet Configurations.

4. Dans le volet de navigation de gauche, cliquez sur Layers, puis sur Modify.

5. Dans le panneau Layers, choisissez + Add Layer > Add Official Common Layer, puis sélectionnez la couche de l'agent ARMS correspondant à votre version Java.

Étape 3 : Configurer les variables d'environnement

Définissez les variables d'environnement suivantes pour votre fonction :

Pour définir ces variables dans la console Function Compute :

1. Sur la page des détails de la fonction, cliquez sur l'onglet Configurations.

2. Dans le volet de navigation de gauche, cliquez sur Environment Variables, puis sur Modify.

3. Ajoutez FC_EXTENSION_ARMS=true et FC_EXTENSIONS_ARMS_LICENSE_KEY=<your-license-key>.

Pour plus de détails, consultez la page Configurer les variables d'environnement.

Étape 4 : Créer un script bootstrap

L'agent ARMS s'attache à votre processus Java via les paramètres de démarrage de la JVM. Créez un fichier bootstrap pour transmettre ces paramètres au démarrage de la fonction.

Le tableau suivant décrit les paramètres JVM requis :

Exemple de script bootstrap :

#!/bin/bash
set -eo pipefail

# Set the ARMS application name.
# Defaults to FC:{FunctionName} if the FC_FUNCTION_NAME variable exists.
appName="FC:Custom_Java_Arms_Demo"
if [ -n "${FC_FUNCTION_NAME}" ]; then
    appName="FC:${FC_FUNCTION_NAME}"
fi

echo "appName: ${appName}"
params=" "

# Build the ARMS JVM parameters.
if [[ -n "${FC_EXTENSIONS_ARMS_LICENSE_KEY}" ]]; then
    echo "FC_EXTENSIONS_ARMS_LICENSE_KEY: ${FC_EXTENSIONS_ARMS_LICENSE_KEY}"
    params+="-Dfc.instanceId=$HOSTNAME@`hostname -i` "
    params+="-javaagent:/opt/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar "
    params+="-Darms.licenseKey=${FC_EXTENSIONS_ARMS_LICENSE_KEY} "
    params+="-Darms.appName=${appName} "
else
    echo "The environment FC_EXTENSIONS_ARMS_LICENSE_KEY does not exist, please set the FC_EXTENSIONS_ARMS_LICENSE_KEY environment!"
    exit 1
fi

# Launch the application. Replace the JAR path with your own.
echo "params: ${params}"
exec java $params \
    -Dserver.port=9000 \
    -jar /code/target/demo-0.0.1-SNAPSHOT.jar

Remplacez /code/target/demo-0.0.1-SNAPSHOT.jar par le chemin d'accès à votre fichier JAR d'application.

Étape 5 : Vérifier l'intégration

Après le déploiement, invoquez la fonction au moins une fois pour déclencher la collecte des données, puis confirmez qu'ARMS reçoit bien les données :

1. Connectez-vous à la console ARMS.

2. Dans le volet de navigation de gauche, choisissez Application Monitoring > Applications.

3. Recherchez l'application dont le nom correspond à la valeur appName de votre script bootstrap. La valeur par défaut est FC:{FunctionName}.

4. Cliquez sur le nom de l'application pour afficher les traces, les métriques JVM et autres données de surveillance.

Pour plus de détails sur le tableau de bord de surveillance, consultez la page Vue d'ensemble de l'application.

Facturation

L'intégration d'ARMS avec Function Compute engendre des frais provenant de deux services :