Solução do CloudWatch: workload do Tomcat no Amazon EC2

Esta solução auxilia na configuração da coleta de métricas prontas para uso com agentes do CloudWatch para servidores do Tomcat que estão sendo executadas em instâncias do EC2 Além disso, a solução ajuda na configuração de um painel do CloudWatch configurado previamente. Para obter informações gerais sobre todas as soluções de observabilidade do CloudWatch, consulte Soluções de observabilidade do CloudWatch.

Requisitos

Esta solução é aplicável nas seguintes condições:

Benefícios

A solução disponibiliza monitoramento do servidor do Tomcat, fornecendo insights valiosos para os seguintes casos de uso:

A seguir, apresentamos as principais vantagens da solução:

A imagem apresentada a seguir é um exemplo do painel para esta solução.

Custos

Esta solução cria e usa recursos em sua conta. A cobrança será realizada com base no uso padrão, que inclui o seguinte:

Para obter mais informações sobre os preços do CloudWatch, consulte Preço do Amazon CloudWatch.

A calculadora de preços pode ajudar a estimar os custos mensais aproximados para o uso desta solução.

Configuração do agente do CloudWatch para esta solução

O agente do CloudWatch é um software que opera de maneira contínua e autônoma em seus servidores e em ambientes com contêineres. Ele coleta métricas, logs e rastreamentos da infraestrutura e das aplicações e os envia para o CloudWatch e para o X-Ray.

Para obter mais informações sobre o agente do CloudWatch, consulte Coletar métricas, logs e rastreamentos com o agente do CloudWatch.

A configuração do agente nesta solução coleta as métricas fundamentais para o Tomcat, a JVM e o EC2. O agente do CloudWatch pode ser configurado para coletar mais métricas da JVM do que as que são exibidas por padrão no painel. Para obter uma lista de todas as métricas do Tomcat que você pode coletar, consulte Coleta métricas do Tomcat. Para obter uma lista de todas as métricas da JVM que você pode coletar, consulte Coletar métricas da JVM. Para obter uma lista das métricas do Amazon EC2, consulte Métricas coletadas pelo atendente do CloudWatch em instâncias do Linux e macOS.

Exposição de portas do JMX para o servidor do Tomcat

O agente do CloudWatch depende do JMX para coletar as métricas relacionadas ao servidor do Tomcat e ao processo da JVM. Para que isso aconteça, é necessário expor a porta do JMX de seus servidores. Para habilitar uma porta do JMX para monitoramento e gerenciamento, você definiria propriedades do sistema para os servidores do Tomcat. É possível usar a variável de ambiente CATALINA_OPTS para definir as propriedades do sistema necessárias para o Tomcat. Analise os scripts de inicialização e os arquivos de configuração do servidor do Tomcat para encontrar o local mais adequado para definir a variável de ambiente. Certifique-se de especificar um número de porta que não esteja em uso. Você precisará reiniciar o servidor depois de realizar a alteração.

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"

Este exemplo configura o JMX sem autenticação. Se suas políticas ou seus requisitos de segurança exigirem que você habilite o JMX com autenticação por senha ou SSL para a obtenção de acesso remoto, consulte a documentação do JMX para definir a propriedade necessária.

Para verificar a porta do JMX, execute ps aux | grep jmxremote.port. Os resultados devem mostrar que a porta do JMX foi definida nos processos da JVM.

Configuração do agente para a solução do Tomcat

As métricas coletadas pelo agente são definidas na configuração do agente. A solução fornece configurações do agente para a coleta das métricas recomendadas com dimensões adequadas para o painel da solução.

As etapas para a implantação da solução são descritas posteriormente em Implantação do agente para a sua solução. As informações apresentadas a seguir são destinadas a ajudar você a compreender como personalizar a configuração do agente para o seu ambiente.

Você deve personalizar algumas partes da seguinte configuração do agente para o seu ambiente:

Por exemplo, caso você tenha duas aplicações do Tomcat em execução na mesma Conta da AWS, sendo uma para a aplicação billing-system e a outra para a aplicação order-system, é possível configurar as dimensões AppName e ProcessGroupName de maneira adequada na configuração do agente de cada instância.

Ao seguir essas diretrizes, a solução agrupará automaticamente as métricas com base nas dimensões AppName e ProcessGroupName. O painel incluirá opções do menu suspenso para a seleção e para a visualização de métricas de uma aplicação do Tomcat específica, permitindo o monitoramento da performance de aplicações individuais separadamente.

Configuração do agente para hosts do Tomcat

Use a configuração do agente do CloudWatch apresentada a seguir nas instâncias do EC2 em que as aplicações do Tomcat estão implantadas. A configuração será armazenada como um parâmetro no Parameter Store do SSM, conforme detalhado posteriormente em Etapa 2: armazenar o arquivo de configuração recomendado do agente do CloudWatch no Systems Manager Parameter Store.

Substitua AppName por um nome significativo que represente a aplicação do Tomcat da qual as instâncias fazem parte. Substitua port-number pela porta do JMX do seu servidor do Tomcat. Se o JMX tiver sido habilitado com autenticação por senha ou SSL para acesso remoto, consulte Coletar métricas do Java Management Extensions (JMX) para obter informações sobre como configurar o TLS ou a autorização na configuração do agente, conforme necessário.

As métricas do EC2 mostradas nesta configuração (configuração apresentada de forma externa ao bloco do JMX) funcionam somente para instâncias do Linux e do macOS. Caso esteja usando instâncias do Windows, é possível optar por omitir essas métricas na configuração. Para obter mais informações sobre as métricas coletadas em instâncias do Windows, consulte Métricas coletadas pelo atendente do CloudWatch em instâncias do 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"
        ]
      }
    }
  }
}

Implantação do agente para a sua solução

Existem várias abordagens para instalar o agente do CloudWatch, dependendo do caso de uso. Recomendamos o uso do Systems Manager para esta solução. Ele fornece uma experiência no console e simplifica o gerenciamento de uma frota de servidores gerenciados em uma única conta da AWS. As instruções apresentadas nesta seção usam o Systems Manager e são destinadas para situações em que o agente do CloudWatch não está em execução com as configurações existentes. É possível verificar se o agente do CloudWatch está em execução ao seguir as etapas apresentadas em Verificar se o atendente do CloudWatch está em execução.

Se você já estiver executando o agente do CloudWatch nos hosts do EC2 nos quais a aplicação da JVM está implantada e gerenciando as configurações do agente, pode pular as instruções apresentadas nesta seção e usar o mecanismo de implantação existente para atualizar a configuração. Certifique-se de combinar a configuração do agente da JVM com a configuração do agente existente e, em seguida, implante a configuração combinada. Se você estiver usando o Systems Manager para armazenar e gerenciar a configuração do agente do CloudWatch, poderá combinar a configuração com o valor do parâmetro existente. Para obter mais informações, consulte Managing CloudWatch agent configuration files.

O processo de implantação inclui as seguintes etapas:

Etapa 1: garantir que as instâncias do EC2 de destino têm as permissões do IAM necessárias

Você deve conceder permissão para o Systems Manager instalar e configurar o agente do CloudWatch. Além disso, é necessário conceder permissão para que o agente do CloudWatch publique a telemetria da instância do EC2 para o CloudWatch. Certifique-se de que o perfil do IAM anexado à instância tenha as políticas do IAM CloudWatchAgentServerPolicy e AmazonSSMManagedInstanceCore associadas.

Etapa 2: armazenar o arquivo de configuração recomendado do agente do CloudWatch no Systems Manager Parameter Store

O Parameter Store simplifica a instalação do agente do CloudWatch em uma instância do EC2 ao armazenar e gerenciar os parâmetros de configuração de forma segura, eliminando a necessidade de valores com codificação rígida. Isso garante um processo de implantação mais seguro e flexível ao possibilitar o gerenciamento centralizado e as atualizações simplificadas para as configurações em diversas instâncias.

Use as etapas apresentadas a seguir para armazenar o arquivo de configuração recomendado do agente do CloudWatch como um parâmetro no Parameter Store.

Etapa 3: instalar o agente do CloudWatch e aplicar a configuração usando um modelo do AWS CloudFormation

É possível usar o AWS CloudFormation para instalar o agente e configurá-lo para usar a configuração do agente do CloudWatch criada nas etapas anteriores.

Se você desejar editar o arquivo de modelo previamente para personalizá-lo, selecione a opção Fazer upload de um arquivo de modelo no Assistente de criação de pilha para fazer o upload do modelo editado. Para obter mais informações, consulte Criar uma pilha no console do AWS CloudFormation. É possível usar o seguinte link para fazer download do modelo: https://aws-observability-solutions.s3.amazonaws.com/CloudWatchAgent/CFN/v1.0.0/cw-agent-installation-template-1.0.0.json.

Etapa 4: verificar se a configuração do agente foi realizada corretamente

É possível verificar se o agente do CloudWatch está instalado ao seguir as etapas apresentadas em Verificar se o atendente do CloudWatch está em execução. Se o agente do CloudWatch não estiver instalado e em execução, certifique-se de que todas as configurações foram realizadas corretamente.

Se todas as configurações estiverem corretas, as métricas do Tomcat serão publicadas no CloudWatch e estarão disponíveis para visualização. É possível verificar no console do CloudWatch para assegurar que as métricas estão sendo publicadas corretamente.

Criação do painel da solução do Tomcat

Este painel exibe as métricas emitidas recentemente, mostrando o servidor de aplicações do Tomcat e a JVM subjacente. Este painel fornece uma visualização dos principais colaboradores relacionados à obtenção da integridade da workload do Tomcat. A visualização do principal colaborador exibe os dez principais colaboradores por widget de métrica. Isso permite a identificação de discrepâncias rapidamente. O painel também inclui uma visão geral do cluster ao agregar e apresentar métricas de todas as instâncias, disponibilizando um resumo de alto nível sobre a integridade geral e o estado operacional do cluster.

O painel da solução não exibe métricas do EC2. Para visualizar as métricas relacionadas ao EC2, é necessário usar o painel automático do EC2 para acessar as métricas fornecidas diretamente pelo EC2 e usar o painel do console do EC2 para consultar as métricas do EC2 que são coletadas pelo agente do CloudWatch. Para obter mais informações sobre os painéis automáticos para Serviços da AWS, consulte Visualização de um painel do CloudWatch para um único serviço da AWS.

Para criar o painel, é possível usar as seguintes opções:

Ao usar o console do CloudWatch para criar um painel, é possível visualizá-lo previamente antes de criá-lo e incorrer em custos.

Se você desejar editar o arquivo de modelo para personalizá-lo para atender a uma necessidade específica, é possível usar a opção Fazer upload de um arquivo de modelo no Assistente de criação de pilha para fazer o upload do modelo editado. Para obter mais informações, consulte Criar uma pilha no console do AWS CloudFormation. É possível usar este link para fazer download do modelo: https://aws-observability-solutions.s3.amazonaws.com/Tomcat_EC2/CloudWatch/CFN/v1.0.0/dashboard-template-1.0.0.json.

Como começar a usar o painel de monitoramento do Tomcat

A seguir, apresentamos algumas tarefas que você pode realizar para explorar o novo painel do Tomcat. Essas tarefas permitem a validação do funcionamento correto do painel e fornecem uma experiência prática ao usá-lo para monitorar uma aplicação do Tomcat. À medida que realiza as tarefas, você se familiarizará com a navegação no painel e com a interpretação das métricas visualizadas.

Uso das listas suspensas

O painel fornece uma lista suspensa na parte superior que pode ser usada para filtrar e selecionar a aplicação específica do Tomcat que você deseja monitorar. Para exibir as métricas para uma aplicação específica do Tomcat, selecione o nome dessa aplicação na lista suspensa Aplicação do Tomcat.

Verificação da integridade da aplicação

Na seção Visão geral da aplicação, localize os widgets de Solicitações, Erros e Taxa de erros. Esses widgets fornecem um resumo de alto nível da performance de tratamento de solicitações da aplicação. Procure por contagens ou taxas de erros anormalmente altas, pois isso pode indicar problemas que precisam ser investigados.

Monitoramento do processamento de solicitações

Na seção Tempo de processamento de solicitações, localize os widgets de Tempo máximo e de Tempo total para o processamento de todas as solicitações. Essas métricas ajudam a identificar possíveis gargalos de performance no processamento de solicitações. Procure por servidores com tempos máximos de processamento significativamente maiores em comparação aos outros.

Análise do tráfego de rede

Na seção Tráfego de rede, localize os widgets de Tráfego enviado e de Tráfego recebido. Esses widgets apresentam a quantidade de dados enviados e recebidos pela aplicação por meio da rede. Níveis de tráfego inesperadamente elevados podem indicar possíveis problemas relacionados com a saturação de rede ou com a transferência ineficiente de dados.

Investigação do uso de threads

Na seção Sessões e threads, localize os widgets de Contagem de threads em uso, Contagem de threads e Sessões. Essas métricas fornecem insights sobre o gerenciamento de threads e as sessões com usuários ativos da aplicação. Procure por servidores com um número anormalmente elevado de threads ou sessões em uso, pois isso pode indicar possíveis restrições de recursos.