Solution CloudWatch : charge de travail Tomcat sur Amazon EC2

Cette solution vous aide à configurer la collecte de métriques prête à l’emploi à l’aide des agents CloudWatch pour le serveur Tomcat s’exécutant sur des instances EC2. En outre, elle vous aide à mettre en place un tableau de bord CloudWatch préconfiguré. Pour des informations générales sur toutes les solutions d’observabilité CloudWatch, consultez Solutions d’observabilité CloudWatch.

Prérequis

Cette solution est pertinente pour les conditions suivantes :

Avantages

La solution assure la surveillance du serveur Tomcat et fournit des informations précieuses pour les cas d’utilisation suivants :

Vous trouverez ci-dessous les principaux avantages de la solution :

L’image suivante est un exemple de tableau de bord pour cette solution.

Coûts

Cette solution crée et utilise des ressources dans votre compte. Les coûts d’utilisation standard vous sont facturés, y compris les éléments suivants :

Pour plus d'informations sur la tarification CloudWatch, consultez Tarification d'Amazon CloudWatch.

Le calculateur de prix peut vous aider à estimer les coûts mensuels approximatifs de l’utilisation de cette solution.

Configuration de l’agent CloudWatch pour cette solution

L’agent CloudWatch est un logiciel qui s’exécute en continu et de manière autonome sur vos serveurs et dans les environnements conteneurisés. Il collecte des métriques, des journaux et des traces à partir de votre infrastructure et de vos applications et les envoie à CloudWatch et X-Ray.

Pour plus d’informations sur l’agent CloudWatch, consultez Collecte des métriques, des journaux et des suivis à l’aide de l’agent CloudWatch.

La configuration de l’agent dans cette solution collecte les métriques fondamentales pour Tomcat, la JVM et EC2. L’agent CloudWatch peut être configuré pour collecter davantage de métriques JVM que ce que le tableau de bord affiche par défaut. Pour obtenir une liste de toutes les métriques Tomcat que vous pouvez collecter, consultez Collecte des métriques Tomcat. Pour obtenir une liste de toutes les métriques JVM que vous pouvez collecter, consultez Collecte des métriques JVM. Pour obtenir une liste des métriques Amazon EC2, consultez Métriques collectées par l'agent CloudWatch sur les instances Linux et macOS.

Exposer les ports JMX pour le serveur Tomcat

L’agent CloudWatch s’appuie sur JMX pour collecter les métriques liées au serveur Tomcat et au processus JVM. Pour que cela soit possible, vous devez exposer le port JMX de vos serveurs. Pour activer un port JMX pour la surveillance et la gestion, vous devriez définir les propriétés du système pour vos serveurs Tomcat. Vous pouvez utiliser la variable d’environnement CATALINA_OPTS pour définir les propriétés système requises pour Tomcat. Examinez les scripts de démarrage et les fichiers de configuration de votre serveur Tomcat afin de déterminer le meilleur endroit pour définir la variable d’environnement. Veillez à spécifier un numéro de port inutilisé. Vous devrez redémarrer le serveur après la modification.

export CATALINA_OPTS="-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=<<port-number>> -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.authenticate=false"

Cet exemple configure un JMX non authentifié. Si vos politiques/exigences de sécurité vous obligent à activer JMX avec une authentification par mot de passe ou SSL pour l’accès à distance, reportez-vous à la documentation JMX pour définir la propriété requise.

Pour vérifier le port JMX, exécutez ps aux | grep jmxremote.port. Les résultats doivent montrer que le port JMX a été défini sur les processus JVM.

Agent pour la solution Tomcat

Les métriques collectées par l’agent sont définies dans la configuration de l’agent. La solution fournit des configurations d’agent pour collecter les métriques recommandées avec des dimensions appropriées pour le tableau de bord de la solution.

Les étapes du déploiement de la solution sont décrites plus loin dans Déployer l’agent pour votre solution. Les informations suivantes ont pour but de vous aider à comprendre comment personnaliser la configuration de l’agent en fonction de votre environnement.

Vous devez adapter certaines parties de la configuration de l’agent à votre environnement :

Par exemple, si vous avez deux applications Tomcat exécutées dans le même Compte AWS, l’une pour l’application billing-system et l’autre pour l’application order-system, vous pouvez définir les dimensions AppName et ProcessGroupName en conséquence dans la configuration de l’agent de chaque instance.

Lorsque vous suivez ces directives, la solution regroupera automatiquement les métriques en fonction des dimensions AppName et ProcessGroupName. Le tableau de bord comprendra des options déroulantes pour sélectionner et afficher les métriques d’une application Tomcat spécifique, ce qui vous permettra de surveiller séparément les performances des différentes applications.

Configuration de l’agent pour les hôtes Tomcat

Utilisez la configuration suivante de l’agent CloudWatch sur les instances EC2 où vos applications Tomcat sont déployées. La configuration sera stockée en tant que paramètre dans le magasin de paramètres de SSM, comme détaillé plus loin dans Étape 2 : stockez le fichier de configuration recommandé de l’agent CloudWatch dans le magasin de paramètres de Systems Manager..

Remplacez AppName par un nom significatif qui représente l’application Tomcat dont les instances font partie. Remplacez port-number par le port JMX de votre serveur Tomcat. Si JMX a été activé avec une authentification par mot de passe ou SSL pour l’accès à distance, consultez Collecte des métriques Java Management Extensions (JMX) pour obtenir des informations sur le paramétrage de TLS ou de l’autorisation dans la configuration de l’agent, le cas échéant.

Les métriques EC2 présentées dans cette configuration (configuration indiquée en dehors du bloc JMX) ne fonctionnent que pour les instances Linux et macOS. Si vous utilisez des instances Windows, vous pouvez choisir d’omettre ces métriques dans la configuration. Pour plus d’informations sur les métriques collectées sur les instances Windows, consultez Métriques collectées par l'agent CloudWatch sur les instances Windows Server.

{
  "metrics": {
    "namespace": "CWAgent",
    "append_dimensions": {
      "InstanceId": "${aws:InstanceId}"
    },
    "metrics_collected": {
      "jmx": [
        {
          "endpoint": "localhost:port-number",
          "tomcat": {
            "measurement": [
              "tomcat.sessions",
              "tomcat.errors",
              "tomcat.processing_time",
              "tomcat.traffic",
              "tomcat.max_time",
              "tomcat.request_count",
              "tomcat.threads"
            ]
          },
          "append_dimensions": {
            "AppName": "AppName"
          }
        },
        {
          "endpoint": "localhost:port-number",
          "jvm": {
            "measurement": [
              "jvm.classes.loaded",
              "jvm.gc.collections.count",
              "jvm.gc.collections.elapsed",
              "jvm.memory.heap.committed",
              "jvm.memory.heap.max",
              "jvm.memory.heap.used",
              "jvm.memory.nonheap.committed",
              "jvm.memory.nonheap.max",
              "jvm.memory.nonheap.used",
              "jvm.threads.count"
            ]
          },
          "append_dimensions": {
            "ProcessGroupName": "AppName"
          }
        }
      ],
      "disk": {
        "measurement": [
          "used_percent"
        ]
      },
      "mem": {
        "measurement": [
          "used_percent"
        ]
      },
      "swap": {
        "measurement": [
          "used_percent"
        ]
      },
      "netstat": {
        "measurement": [
          "tcp_established",
          "tcp_time_wait"
        ]
      }
    }
  }
}

Déployer l’agent pour votre solution

Il existe plusieurs approches pour installer l’agent CloudWatch, en fonction du cas d’utilisation. Nous vous recommandons d’utiliser Systems Manager pour cette solution. Il offre une expérience de console et simplifie la gestion d’une flotte de serveurs gérés au sein d’un seul compte AWS. Les instructions de cette section utilisent Systems Manager et sont destinées aux cas où vous n’avez pas l’agent CloudWatch en cours d’exécution avec les configurations existantes. Vous pouvez vérifier si l’agent CloudWatch est en cours d’exécution en suivant les étapes de la section Vérification de l'exécution de l'agent CloudWatch.

Si vous exécutez déjà l’agent CloudWatch sur les hôtes EC2 où l’application JVM est déployée et que vous gérez les configurations d’agent, vous pouvez ignorer les instructions de cette section et suivre votre mécanisme de déploiement existant pour mettre à jour la configuration. Veillez à fusionner la configuration de l’agent de la JVM avec votre configuration d’agent existante, puis déployez la configuration fusionnée. Si vous utilisez Systems Manager pour stocker et gérer la configuration de l’agent CloudWatch, vous pouvez fusionner la configuration avec la valeur de paramètre existante. Pour plus d’informations, consultez Gestion des fichiers de configuration de l’agent CloudWatch.

Le processus de déploiement comprend les étapes suivantes :

Étape 1 : assurez-vous que les instances EC2 cibles disposent des autorisations IAM requises.

Vous devez accorder l’autorisation à Systems Manager d’installer et de configurer l’agent CloudWatch. Vous devez également accorder l’autorisation à l’agent CloudWatch de publier la télémétrie de votre instance EC2 vers CloudWatch. Assurez-vous que le rôle IAM attaché à l’instance dispose des politiques IAM CloudWatchAgentServerPolicy et AmazonSSMManagedInstanceCore.

Étape 2 : stockez le fichier de configuration recommandé de l’agent CloudWatch dans le magasin de paramètres de Systems Manager.

Le magasin de paramètres simplifie l’installation de l’agent CloudWatch sur une instance EC2 en stockant et en gérant de manière sécurisée les paramètres de configuration, éliminant ainsi le besoin de valeurs codées en dur. Cela garantit un processus de déploiement plus sûr et plus flexible, permettant une gestion centralisée et des mises à jour plus faciles des configurations sur plusieurs instances.

Suivez les étapes suivantes pour stocker le fichier de configuration de l’agent CloudWatch recommandé en tant que paramètre dans le magasin de paramètres.

Étape 3 : installez l’agent CloudWatch et appliquez la configuration à l’aide d’un modèle CloudFormation.

Vous pouvez utiliser AWS CloudFormation pour installer l’agent et le configurer pour utiliser la configuration de l’agent CloudWatch que vous avez créée dans les étapes précédentes.

Si vous voulez d’abord modifier le fichier modèle pour le personnaliser, choisissez l’option Charger un fichier modèle sous Assistant de création de pile pour charger le modèle modifié. Pour plus d’informations, consultez Création d’une pile sur la console CloudFormation. Vous pouvez utiliser le lien suivant pour télécharger le modèle : https://aws-observability-solutions-prod-us-east-1.s3.us-east-1.amazonaws.com/CloudWatchAgent/CFN/v1.0.0/cw-agent-installation-template-1.0.0.json.

Étape 4 : vérifiez que la configuration de l’agent est correcte

Vous pouvez vérifier si l’agent CloudWatch est installé en suivant les étapes de l’étape Vérification de l'exécution de l'agent CloudWatch. Si l’agent CloudWatch n’est pas installé et ne fonctionne pas, assurez-vous que vous avez tout configuré correctement.

Si tout est configuré correctement, vous devriez alors voir les métriques Tomcat être publiées sur CloudWatch. Vous pouvez consulter la console CloudWatch pour vérifier qu’elles sont bien publiées.

Créer le tableau de bord de la solution Tomcat

Ce tableau de bord affiche les métriques nouvellement émises, montrant à la fois le serveur d’application Tomcat et la JVM sous-jacente. Ce tableau de bord fournit une vue d’ensemble de l’état de votre charge de travail Tomcat. La vue des principaux contributeurs affiche les 10 premiers par widget de métrique. Cela vous permet d’identifier les valeurs aberrantes en un coup d’œil. Le tableau de bord comprend également une vue d’ensemble du cluster en regroupant et en présentant les métriques de toutes les instances, fournissant ainsi un résumé de haut niveau de l’état général et opérationnel du cluster.

Le tableau de bord de la solution n’affiche pas les métriques EC2. Pour afficher les métriques EC2, vous devrez utiliser le tableau de bord automatique EC2 pour voir les métriques EC2 vended et utiliser le tableau de bord de la console EC2 pour voir les métriques EC2 qui sont collectées par l’agent CloudWatch. Pour plus d’informations sur les tableaux de bord automatiques pour les Services AWS, consultez Affichage d’un tableau de bord CloudWatch pour un seul service AWS.

Pour créer le tableau de bord, vous pouvez utiliser les options suivantes :

En utilisant la console CloudWatch pour créer un tableau de bord, vous pouvez prévisualiser le tableau de bord avant de le créer et de le facturer.

Si vous voulez modifier le fichier modèle pour l’adapter à vos besoins, vous pouvez utiliser l’option Charger un fichier modèle sous Assistant de création de pile pour charger le modèle modifié. Pour plus d’informations, consultez Création d’une pile sur la console CloudFormation. Vous pouvez utiliser ce lien pour télécharger le modèle : https://aws-observability-solutions-prod-us-east-1.s3.us-east-1.amazonaws.com/Tomcat_EC2/CloudWatch/CFN/v1.0.0/dashboard-template-1.0.0.json.

Commencez à utiliser le tableau de bord de surveillance de Tomcat

Voici quelques tâches que vous pouvez essayer avec le nouveau tableau de bord Tomcat. Ces tâches vous permettent de valider le bon fonctionnement du tableau de bord et vous donnent une expérience pratique de son utilisation pour surveiller une application Tomcat. Au fur et à mesure de vos essais, vous vous familiariserez avec la navigation dans le tableau de bord et l’interprétation des métriques visualisées.

Utilisation de la liste déroulante

Le tableau de bord comporte une liste déroulante en haut, que vous pouvez utiliser pour filtrer et sélectionner l’application Tomcat spécifique que vous voulez surveiller. Pour afficher les métriques d’une application Tomcat spécifique, sélectionnez le nom de cette application dans la liste déroulante Applications Tomcat.

Vérifier l’état de l’application

Dans la section Vue d’ensemble de l’application, trouvez les widgets Demandes, Erreurs et Taux d’erreur. Ceux-ci fournissent un résumé de haut niveau des performances de l’application en matière de traitement des demandes. Recherchez tout nombre ou taux d’erreurs anormalement élevé, qui pourrait indiquer des problèmes à résoudre.

Surveiller le traitement des demandes

Dans la section Temps de traitement des demandes, vous trouverez les widgets Temps maximum et Temps total de traitement de toutes les demandes. Ces métriques vous aident à identifier les goulets d’étranglement potentiels dans le traitement des demandes. Recherchez les serveurs dont le temps de traitement maximal est nettement plus élevé que celui des autres serveurs.

Analyser le trafic réseau

Dans la section Trafic réseau, vous trouverez les widgets Trafic envoyé et Trafic reçu. Ils indiquent la quantité de données envoyées et reçues par l’application sur le réseau. Des niveaux de trafic élevés et inattendus peuvent indiquer des problèmes potentiels de saturation du réseau ou de transfert de données inefficace.

Examiner l’utilisation des threads

Dans la section Sessions et threads, vous trouverez les widgets Nombre de threads occupés, Nombre de threads et Sessions. Ces métriques donnent un aperçu de la gestion des threads de l’application et des sessions utilisateur actives. Recherchez les serveurs présentant un nombre anormalement élevé de threads ou de sessions occupés, ce qui pourrait indiquer des contraintes de ressources potentielles.