Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

CloudWatch solution : charge de travail Tomcat sur Amazon EC2

Cette solution vous permet de configurer la collecte de out-of-the-box métriques à l'aide d' CloudWatch agents pour le serveur Tomcat exécuté sur des EC2 instances. En outre, il vous aide à configurer un tableau de CloudWatch bord préconfiguré. Pour des informations générales sur toutes les solutions CloudWatch d'observabilité, consultezCloudWatch solutions d'observabilité.

Prérequis

Cette solution est pertinente pour les conditions suivantes :

Avantages

La solution assure la surveillance des serveurs Tomcat, fournissant des informations précieuses pour les cas d'utilisation suivants :

Voici les principaux avantages de cette solution :

L'image suivante est un exemple du tableau de bord de cette solution.

Coûts

Cette solution crée et utilise les ressources de votre compte. L'utilisation standard vous est facturée, y compris les frais suivants :

Pour plus d'informations sur CloudWatch les tarifs, consultez Amazon CloudWatch Pricing.

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

CloudWatch configuration de l'agent pour cette solution

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

Pour plus d'informations sur l' CloudWatch agent, consultezCollectez des métriques, des journaux et des traces avec l' CloudWatch agent.

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

Exposer les ports JMX pour le serveur Tomcat

L' CloudWatch agent s'appuie sur JMX pour collecter les métriques relatives 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 à des fins de surveillance et de gestion, vous devez définir les propriétés système de vos serveurs Tomcat. Vous pouvez utiliser la variable CATALINA_OPTS d'environnement pour définir les propriétés système requises pour Tomcat. Passez en revue les scripts de démarrage et les fichiers de configuration de votre serveur Tomcat au meilleur endroit pour définir la variable d'environnement. Assurez-vous de spécifier un numéro de port non utilisé. Vous devrez redémarrer le serveur après le changement.

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 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écutezps aux | grep jmxremote.port. Les résultats devraient montrer que le port JMX a été défini sur les processus JVM.

Configuration de l'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'agents permettant de collecter les métriques recommandées avec des dimensions adaptées au tableau de bord de la solution.

Les étapes de déploiement de la solution sont décrites plus loin dansDéployez l'agent correspondant à votre solution. Les informations suivantes ont pour but de vous aider à comprendre comment personnaliser la configuration de l'agent pour votre environnement.

Vous devez personnaliser certaines parties de la configuration d'agent suivante pour votre environnement :

Par exemple, si deux applications Tomcat s'exécutent simultanément Compte AWS, l'une pour l'billing-systemapplication et l'autre pour l'order-systemapplication, vous pouvez définir les ProcessGroupName dimensions AppName et en conséquence dans la configuration de l'agent de chaque instance.

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

Configuration de l'agent pour les hôtes Tomcat

Utilisez la configuration d' CloudWatch agent suivante sur les EC2 instances 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 : enregistrer le fichier de configuration d' CloudWatch agent recommandé dans le magasin de paramètres de Systems Manager.

AppNameRemplacez-le par un nom significatif qui représente l'application Tomcat dont font partie les instances. port-numberRemplacez-le par le port JMX de votre serveur Tomcat. Si JMX a été activé avec l'authentification par mot de passe ou le protocole SSL pour l'accès à distance, reportez-vous à la section Collectez les métriques des extensions de gestion Java (JMX) pour obtenir des informations sur la configuration du protocole TLS ou de l'autorisation dans la configuration de l'agent, selon les besoins.

Les EC2 métriques affichées dans cette configuration (configuration affiché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 mesures dans la configuration. Pour plus d'informations sur les métriques collectées sur les instances Windows, consultezMesures collectées par l' CloudWatch agent 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éployez l'agent correspondant à votre solution

Il existe plusieurs approches pour installer l' CloudWatch agent, selon le cas d'utilisation. Nous vous recommandons d'utiliser Systems Manager pour cette solution. Il fournit une expérience de console et simplifie la gestion d'un parc de serveurs gérés au sein d'un seul AWS compte. Les instructions de cette section utilisent Systems Manager et sont destinées aux situations où l' CloudWatch agent n'est pas exécuté avec des configurations existantes. Vous pouvez vérifier si l' CloudWatch agent est en cours d'exécution en suivant les étapes décrites dansVérifiez que l' CloudWatch agent est en cours d'exécution.

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

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

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

Vous devez autoriser Systems Manager à installer et configurer l' CloudWatch agent. Vous devez également autoriser l' CloudWatch agent à publier des données télémétriques depuis votre EC2 instance vers. CloudWatch Assurez-vous que le rôle IAM attaché à l'instance est associé aux politiques Amazon SSMManaged InstanceCore IAM CloudWatchAgentServerPolicyet Amazon.

Étape 2 : enregistrer le fichier de configuration d' CloudWatch agent recommandé dans le magasin de paramètres de Systems Manager

Parameter Store simplifie l'installation de l' CloudWatch agent sur une EC2 instance 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 simplifiées des configurations sur plusieurs instances.

Procédez comme suit pour enregistrer le fichier de configuration d' CloudWatch agent recommandé en tant que paramètre dans Parameter Store.

Étape 3 : Installation de l' CloudWatch agent et application de la configuration à l'aide d'un AWS CloudFormation modèle

Vous pouvez l'utiliser AWS CloudFormation pour installer l'agent et le configurer de manière à utiliser la configuration d' CloudWatch agent que vous avez créée lors des étapes précédentes.

Si vous souhaitez d'abord modifier le fichier modèle pour le personnaliser, choisissez l'option Télécharger un fichier modèle sous Create Stack Wizard pour télécharger le modèle modifié. Pour plus d'informations, consultez la section Création d'une pile sur AWS CloudFormation console. 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érifier que la configuration de l'agent est correctement configurée

Vous pouvez vérifier si l' CloudWatch agent est installé en suivant les étapes décrites dansVérifiez que l' CloudWatch agent est en cours d'exécution. Si l' CloudWatch agent n'est pas installé et n'est pas en cours d'exécution, assurez-vous que tout est correctement configuré.

Si tout est correctement configuré, vous devriez voir les métriques Tomcat publiées sur CloudWatch. Vous pouvez consulter la CloudWatch console pour vérifier qu'ils sont publiés.

Création du tableau de bord de la solution Tomcat

Ce tableau de bord affiche les nouvelles métriques émises, indiquant à la fois le serveur d'applications Tomcat et la JVM sous-jacente. Ce tableau de bord fournit une vue des principaux contributeurs sur l'état de votre charge de travail Tomcat. La vue des meilleurs contributeurs affiche les 10 meilleurs widgets par métrique. Cela vous permet d'identifier les valeurs aberrantes en un coup d'œil. Le tableau de bord inclut également une vue d'ensemble du cluster en agrégeant et en présentant des métriques pour toutes les instances, fournissant ainsi un résumé de haut niveau de l'état de santé général et de l'état opérationnel du cluster.

Le tableau de bord de la solution n'affiche pas de EC2 statistiques. Pour consulter EC2 les métriques, vous devez utiliser le tableau de bord EC2 automatique pour voir les EC2 métriques vendues et utiliser le tableau de bord de la EC2 console pour voir les EC2 métriques collectées par l' CloudWatch agent. Pour plus d'informations sur les tableaux de bord automatiques pour Services AWS, consultezAfficher un CloudWatch tableau de bord pour un seul AWS service.

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

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

Si vous souhaitez modifier le fichier modèle pour le personnaliser à quelque fin que ce soit, vous pouvez utiliser l'option Télécharger un fichier modèle sous Create Stack Wizard pour télécharger le modèle modifié. Pour plus d'informations, consultez la section Création d'une pile sur AWS CloudFormation console. 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 avec le tableau de bord de surveillance Tomcat

Voici quelques tâches que vous pouvez essayer avec le nouveau tableau de bord Tomcat. Ces tâches vous permettent de vérifier que le tableau de bord fonctionne correctement et vous fournissent une expérience pratique de son utilisation pour surveiller une application Tomcat. En les essayant, vous vous familiariserez avec la navigation dans le tableau de bord et l'interprétation des indicateurs visualisés.

Utilisation de la liste déroulante

Le tableau de bord fournit une liste déroulante en haut que vous pouvez utiliser pour filtrer et sélectionner l'application Tomcat spécifique que vous souhaitez surveiller. Pour afficher les statistiques d'une application Tomcat spécifique, sélectionnez le nom de cette application dans la liste déroulante des applications Tomcat.

Vérifier l'état de santé des applications

Dans la section Présentation de l'application, recherchez les widgets Demandes, Erreurs et Taux d'erreurs. Ils fournissent un résumé détaillé des performances de gestion des demandes de l'application. Recherchez tout nombre ou taux d'erreur anormalement élevé, qui pourrait indiquer des problèmes nécessitant une enquête.

Surveiller le traitement des demandes

Dans la section Durée de traitement des demandes, recherchez les widgets Durée maximale et Durée totale de traitement de toutes les demandes. Ces indicateurs vous aident à identifier les problèmes de performance potentiels liés au traitement des demandes. Recherchez les serveurs dont les temps de traitement maximaux sont nettement plus élevés que les autres.

Analyser le trafic réseau

Dans la section Trafic réseau, recherchez 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 étonnamment élevés peuvent indiquer des problèmes potentiels de saturation du réseau ou de transfert de données inefficace.

Étudier l'utilisation des fils

Dans la section Sessions et fils de discussion, recherchez les widgets Nombre de fils occupés, Nombre de fils et Sessions. Ces indicateurs fournissent des informations sur la gestion des fils de discussion et les sessions utilisateur actives de l'application. 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.