JVM

L'intégration JVM collecte les métriques JVM exposées via les extensions de gestion Java (JMX). L'intégration collecte principalement des métriques concernant la mémoire et la récupération de mémoire. Des métriques d'exécution supplémentaires, telles que le nombre de threads et les classes chargées, sont également disponibles.

Pour en savoir plus sur JVM, consultez la documentation sur JVM.

Prérequis

Pour collecter les données de télémétrie JVM, vous devez installer l'agent Ops :

Pour les métriques, installez la version 2.2.0 ou ultérieure.

Cette intégration est compatible avec les versions de JVM Java 16 et Java 11.

Configurer votre instance JVM

Pour exposer un point de terminaison JMX, vous devez définir la propriété système com.sun.management.jmxremote.port lors du démarrage de la JVM. Nous vous recommandons également de définir la propriété système com.sun.management.jmxremote.rmi.port sur le même port.

Pour exposer un point de terminaison JMX à distance, vous devez également définir la propriété système java.rmi.server.hostname.

Pour définir les propriétés système à l'aide d'arguments de ligne de commande, ajoutez le préfixe -D au nom de la propriété lors du démarrage de la JVM.

Par exemple, pour définir com.sun.management.jmxremote.port sur le port 9999, spécifiez les éléments suivants lors du démarrage de la JVM :

-Dcom.sun.management.jmxremote.port=9999

Configurer l'agent Ops pour la JVM

En suivant le guide de configuration de l'agent Ops, ajoutez les éléments requis pour collecter les journaux de vos instances JVM et redémarrez l'agent.

Exemple de configuration

La commande suivante crée la configuration permettant de collecter et d'ingérer la télémétrie pour JVM, et redémarre l'agent Ops.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    jvm:
      type: jvm
      endpoint: service:jmx:rmi:///jndi/rmi://127.0.0.1:9010/jmxrmi
  service:
    pipelines:
      jvm:
        receivers:
          - jvm
EOF

sudo systemctl restart google-cloud-ops-agent.service
sleep 60

Configurer la collecte de métriques

Pour ingérer des métriques à partir de la JVM, vous devez créer un récepteur pour les métriques produites par la JVM, puis créer un pipeline pour le nouveau récepteur.

Ce récepteur ne permet pas d'utiliser plusieurs instances dans la configuration, par exemple pour surveiller plusieurs points de terminaison. Toutes ces instances écrivent dans la même série temporelle, et Cloud Monitoring n'a aucun moyen de les distinguer.

Pour configurer un récepteur pour vos métriques jvm, spécifiez les champs suivants :

Champ	Par défaut	Description
`collection_interval`	`60s`	Une valeur time duration, telle que `30s` ou `5m`.
`endpoint`	`localhost:9999`	L'URL du service JMX, ou l'hôte et le port utilisés pour créer l'URL du service. Cette valeur doit se présenter au format `service:jmx:<protocol>:<sap>` ou `host:port`. Les valeurs au format `host:port` permettent de créer l'URL de service `service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi`.
`password`		Le mot de passe configuré si JMX est configuré pour exiger une authentification.
`type`		Cette valeur doit être `jvm`.
`username`		Le nom d'utilisateur configuré si JMX est configuré pour exiger une authentification.

Métriques surveillées

Le tableau suivant fournit la liste des métriques que l'agent Ops collecte à partir de l'instance JVM.

Type de métrique
Genre, type Ressources surveillées	Étiquettes
`workload.googleapis.com/jvm.classes.loaded`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.gc.collections.count`
`CUMULATIVE`, `INT64` gce_instance	`name`
`workload.googleapis.com/jvm.gc.collections.elapsed`
`CUMULATIVE`, `INT64` gce_instance	`name`
`workload.googleapis.com/jvm.memory.heap.committed`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.heap.init`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.heap.max`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.heap.used`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.nonheap.committed`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.nonheap.init`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.nonheap.max`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.nonheap.used`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/jvm.memory.pool.committed`
`GAUGE`, `INT64` gce_instance	`name`
`workload.googleapis.com/jvm.memory.pool.init`
`GAUGE`, `INT64` gce_instance	`name`
`workload.googleapis.com/jvm.memory.pool.max`
`GAUGE`, `INT64` gce_instance	`name`
`workload.googleapis.com/jvm.memory.pool.used`
`GAUGE`, `INT64` gce_instance	`name`
`workload.googleapis.com/jvm.threads.count`
`GAUGE`, `INT64` gce_instance

Vérifier la configuration

Cette section explique comment vérifier que vous avez bien configuré le récepteur JVM. La collecte de la télémétrie par l'agent Ops peut prendre une ou deux minutes.

Pour vérifier que les métriques JVM sont envoyées à Cloud Monitoring, procédez comme suit :

Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis Explorateur de métriques :
Accéder à l'Explorateur de métriques
Dans la barre d'outils du volet du générateur de requêtes, sélectionnez le bouton dont le nom est MQL ou PromQL.
Vérifiez que MQL est sélectionné dans le bouton Langage. Le bouton d'activation/de désactivation de la langue se trouve dans la barre d'outils qui vous permet de mettre en forme votre requête.

Saisissez la requête suivante dans l'éditeur, puis cliquez sur Exécuter la requête :

fetch gce_instance
| metric 'workload.googleapis.com/jvm.memory.heap.used'
| every 1m

Afficher le tableau de bord

Pour afficher vos métriques JVM, vous devez configurer un graphique ou un tableau de bord. L'intégration JVM inclut un ou plusieurs tableaux de bord. Tous les tableaux de bord sont automatiquement installés après la configuration de l'intégration et que l'agent Ops a commencé à collecter des données de métriques.

Vous pouvez également afficher des aperçus statiques de tableaux de bord sans installer l'intégration.

Pour afficher un tableau de bord installé, procédez comme suit :

Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis Tableaux de bord :
Accéder à la page Tableaux de bord
Sélectionnez l'onglet Liste des tableaux de bord, puis choisissez la catégorie Intégrations.
Cliquez sur le nom du tableau de bord que vous souhaitez afficher.

Si vous avez configuré une intégration, mais que le tableau de bord n'a pas été installé, vérifiez que l'agent Ops est en cours d'exécution. Lorsqu'un graphique ne contient aucune donnée de métrique, l'installation du tableau de bord échoue. Une fois que l'agent Ops a commencé à collecter des métriques, le tableau de bord est installé.

Pour afficher un aperçu statique du tableau de bord, procédez comme suit :

Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis Intégrations :
Accéder à la page Intégrations
Cliquez sur le filtre de plate-forme de déploiement Compute Engine.
Recherchez l'entrée correspondant à la JVM, puis cliquez sur Afficher les détails.
Cliquez sur l'onglet Tableaux de bord pour afficher un aperçu statique. Si le tableau de bord est installé, vous pouvez y accéder en cliquant sur Afficher le tableau de bord.

Pour en savoir plus sur les tableaux de bord dans Cloud Monitoring, consultez la page Tableaux de bord et graphiques.

Pour en savoir plus sur l'utilisation de la page Intégrations, consultez la page Gérer les intégrations.

Installer des règles d'alerte

Les règles d'alerte indiquent à Cloud Monitoring de vous avertir lorsque des conditions spécifiées se produisent. L'intégration JVM inclut une ou plusieurs règles d'alerte. Vous pouvez afficher et installer ces règles d'alerte à partir de la page Intégrations dans Monitoring.

Pour afficher la description des règles d'alerte disponibles et les installer, procédez comme suit :

Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis Intégrations :
Accéder à la page Intégrations
Recherchez l'entrée correspondant à la JVM, puis cliquez sur Afficher les détails.
Sélectionnez l'onglet Alertes. Cet onglet fournit une description des règles d'alerte disponibles et fournit une interface pour les installer.
Installez les règles d'alerte. Les règles d'alerte doivent savoir où envoyer des notifications indiquant que l'alerte a été déclenchée. Elles nécessitent donc des informations de votre part pour l'installation. Pour installer des règles d'alerte, procédez comme suit :
1. Dans la liste des règles d'alerte disponibles, sélectionnez celles que vous souhaitez installer.
2. Dans la section Configurer les notifications, sélectionnez un ou plusieurs canaux de notification. Vous avez la possibilité de désactiver l'utilisation des canaux de notification. Toutefois, si vous le faites, vos règles d'alerte se déclenchent en mode silencieux. Vous pouvez vérifier leur état dans Monitoring, mais vous ne recevez aucune notification.
  
  Pour plus d'informations sur les canaux de notification, consultez la section Gérer les canaux de notification.
3. Cliquez sur Créer des règles.

Pour plus d'informations sur les règles d'alerte dans Cloud Monitoring, consultez la section Présentation des alertes.

Pour en savoir plus sur l'utilisation de la page Intégrations, consultez la page Gérer les intégrations.

Étapes suivantes

Pour accéder à un tutoriel pas à pas expliquant comment utiliser Ansible pour installer l'agent Ops, configurer une application tierce et installer un exemple de tableau de bord, consultez la vidéo Install the Ops Agent to troubleshoot third-party applications (Installer l'agent Ops pour résoudre les problèmes liés à des applications tierces).