Como usar a interface de consulta do Monitor de Internet do Amazon CloudWatch

Uma opção para saber mais sobre o tráfego da Internet para sua aplicação da AWS é usar a interface de consulta do Monitor de Internet do Amazon CloudWatch. Para usar a interface de consulta, você cria uma consulta com filtros de dados escolhidos por você e, em seguida, executa a consulta para retornar um subconjunto dos dados do Monitor de Internet. A exploração dos dados que a consulta retorna pode fornecer insights sobre a performance da sua aplicação na Internet.

Você pode consultar e explorar todas as métricas que o Monitor de Internet captura com seu monitor, incluindo pontuações de disponibilidade e performance, bytes transferidos, tempos de ida e volta e tempo até o primeiro byte (TTFB).

O Monitor de Internet usa a interface de consulta para fornecer os dados que podem ser explorados no painel do console do Monitor de Internet. Ao usar as opções de pesquisa no painel, na guia Explorador histórico ou na guia Informações de tráfego, você pode consultar e filtrar dados da Internet para sua aplicação.

Se você quiser mais flexibilidade para explorar e filtrar seus dados do que o painel oferece, você pode usar a interface de consulta por conta própria, usando as operações da API do Monitor de Internet com a AWS Command Line Interface ou com um SDK da AWS. Esta seção apresenta os tipos de consultas que podem ser usados com a interface de consulta e os filtros que podem ser especificados para criar um subconjunto de dados, a fim de obter insights sobre o tráfego da Internet para a sua aplicação.

Como usar a interface de consulta

Você cria uma consulta com a interface de consulta ao escolher um tipo de consulta e, em seguida, especificar valores de filtro para retornar um subconjunto específico desejado dos dados do arquivo de log. Em seguida, você pode trabalhar com o subconjunto de dados para filtrar e classificar mais detalhadamente, criar relatórios e assim por diante.

O processo de consulta funciona da seguinte forma:

1. Quando você executa uma consulta, o Monitor de Internet retorna um query ID que é exclusivo da consulta. Esta seção descreve os tipos de consulta disponíveis e as opções de filtragem de dados nas consultas. Para entender como isso funciona, consulte também a seção sobre exemplos de consultas.

2. Você especifica o ID da consulta com o nome do monitor com a operação da API GetQueryResults para retornar os resultados dos dados da consulta. Cada tipo de consulta retorna um conjunto diferente de campos de dados. Para saber mais, consulte Como obter resultados de consulta.

A interface de consulta apresenta os três tipos de consulta a seguir. Cada tipo de consulta retorna um conjunto diferente de informações sobre seu tráfego a partir dos arquivos de log, conforme mostrado.

• Medições: fornece pontuação de disponibilidade, pontuação de performance, tráfego total e tempos de ida e volta, em intervalos de cinco minutos.

• Principais localizações: fornece pontuação de disponibilidade, pontuação de performance, tráfego total e informações de tempo até o primeiro byte (TTFB) para as principais combinações de localização e ASN que estão sendo monitorados, por volume de tráfego.

• Detalhes das principais localizações: fornece o TTFB para o Amazon CloudFront, sua configuração atual e a configuração do Amazon EC2 com melhor performance, em intervalos de uma hora.

Com cada um desses tipos de consulta, você pode filtrar mais os dados especificando um ou mais dos seguintes critérios:

• localização da AWS: para a localização da AWS, você pode especificar o CloudFront ou uma Região da AWS, como us-east-2, us-west-2, e assim por diante.

• ASN: especifique uma ASN, que normalmente é um provedor de serviços de Internet (ISP).

• Localização do cliente: para a localização, especifique uma cidade, metro, subdivisão ou país.

• Geo: especifique a geo para algumas consultas. Isso é necessário para as consultas que usam o tipo de consulta Top locations, mas não é permitido para outros tipos de consulta. Para saber quando especificar o geo para os parâmetros de filtro, consulte a seção de exemplos de consulta.

Os operadores que você pode usar para filtrar seus dados são EQUALS e NOT_EQUALS. Para obter detalhes sobre os parâmetros de filtragem, consulte a operação da API FilterParameter.

Para obter detalhes sobre as operações da interface de consulta, consulte as seguintes operações de API no Guia de referência da API do Amazon CloudWatch para o Monitor de Internet do Amazon CloudWatch:

• Para criar e executar uma consulta, consulte a operação da API StartQuery.

• Para interromper uma consulta, consulte a operação da API StopQuery.

• Para retornar dados de uma consulta que você criou, consulte a operação da API GetQueryResults.

• Para recuperar o status de uma consulta, consulte a operação da API GetQueryStatus.

Exemplos de consulta

Para criar uma consulta que você possa usar para recuperar um conjunto filtrado de dados do arquivo de log do seu monitor, use a operação da API StartQuery. Você especifica um tipo de consulta e parâmetros de filtro para a consulta. Então, quando você usar a operação da API da interface de consulta do Monitor de Internet para obter os resultados da consulta usando a consulta, ela recuperará o subconjunto dos dados com os quais você deseja trabalhar.

Para ilustrar como funcionam os tipos de consulta e os parâmetros de filtro, vamos dar uma olhada em alguns exemplos.

Exemplo 1

Digamos que você queira recuperar todos os dados do arquivo de log do seu monitor para um país específico, exceto para uma cidade. O exemplo a seguir mostra os parâmetros de filtro para uma consulta que você poderia criar com a operação StartQuery para esse cenário.

{
   MonitorName: "TestMonitor"
   StartTime: "2023-07-12T20:00:00Z"
   EndTime: "2023-07-12T21:00:00Z"
   QueryType: "MEASUREMENTS"
   FilterParameters: [
      {
       Field: "country",
       Operator: "EQUALS",
       Values: ["Germany"]
      },
      {
       Field: "city",
       Operator: "NOT_EQUALS",
       Values: ["Berlin"]
      },
    ]
}

Exemplo 2

Como outro exemplo, digamos que você queira ver suas principais localizações por área metropolitana. Você pode usar o exemplo de consulta a seguir para esse cenário.

{
   MonitorName: "TestMonitor"
   StartTime: "2023-07-12T20:00:00Z"
   EndTime: "2023-07-12T21:00:00Z"
   QueryType: "TOP_LOCATIONS"
   FilterParameters: [
      {
       Field: "geo",
       Operator: "EQUALS",
       Values: ["metro"]
      },
    ]
}

Exemplo 3

Agora, digamos que você queira ver as principais combinações de cidade-rede na área metropolitana de Los Angeles. Para fazer isso, especifique geo=city, e depois defina metro como Los Angeles. Agora, a consulta retorna as principais cidades-redes na área metropolitana de Los Angeles em vez das principais metro+redes em geral.

Aqui está o exemplo de consulta que você pode usar:

{
   MonitorName: "TestMonitor"
   StartTime: "2023-07-12T20:00:00Z"
   EndTime: "2023-07-12T21:00:00Z"
   QueryType: "TOP_LOCATIONS"
   FilterParameters: [
      {
       Field: "geo",
       Operator: "EQUALS",
       Values: ["city"]
      },
      {
       Field: "metro",
       Operator: "EQUALS",
       Values: ["Los Angeles"]
      }
    ]
}

Exemplo 4

Por fim, digamos que você queira recuperar dados TTFB para uma subdivisão específica (por exemplo, um estado dos EUA).

A seguir, um exemplo de consulta para esse cenário:

{
   MonitorName: "TestMonitor"
   StartTime: "2023-07-12T20:00:00Z"
   EndTime: "2023-07-12T21:00:00Z"
   QueryType: "TOP_LOCATION_DETAILS"
   FilterParameters: [
      {
       Field: "subdivision",
       Operator: "EQUALS",
       Values: ["California"]
      },
    ]
}

Obter resultados da consulta

Depois de definir uma consulta, você pode retornar um conjunto de resultados com a consulta executando outra operação da API do Monitor de Internet, GetQueryResults. Ao executar GetQueryResults, você especifica o ID da consulta que você definiu, juntamente com o nome do seu monitor. GetQueryResults recupera os dados da consulta especificada em um conjunto de resultados.

Quando você executar uma consulta, certifique-se de que a consulta tenha sido concluída antes de usar GetQueryResults para visualizar os resultados. Você pode determinar se a consulta foi concluída usando a operação da API GetQueryStatus. Quando o Status da consulta for de SUCCEEDED, você pode prosseguir com a análise dos resultados.

Quando a consulta for concluída, você poderá usar as seguintes informações como auxílio para a análise dos resultados. Cada tipo de consulta que você usa para criar uma consulta inclui um conjunto exclusivo de campos de dados dos arquivos de log, conforme descrito na lista a seguir:

Medições

O tipo de consulta measurements retorna os seguintes dados:

timestamp, availability, performance, bytes_in, bytes_out, rtt_p50, rtt_p90, rtt_p95

Principais localizações

O tipo de consulta top locations agrupa os dados por localização e fornece a média dos dados ao longo do período. Os dados que esse tipo de consulta retorna incluem o seguinte:

aws_location, city, metro, subdivision, country, asn, availability, performance, bytes_in, bytes_out, current_fbl, best_ec2, best_ec2_region, best_cf_fbl

Observe que city, metro, e subdivision só serão retornados se você escolher esse tipo de localização para o campo geo. Os seguintes campos de localização são retornados, dependendo do tipo de localização que você especificar para geo:

city = city, metro, subdivision, country
metro = metro, subdivision, country
subdivision = subdivision, country
country = country

Detalhes das principais localizações

O tipo de consulta top locations details retorna dados agrupados hora a hora. A consulta retorna os seguintes dados:

timestamp, current_service, current_fbl, best_ec2_fbl, best_ec2_region, best_cf_fbl

Quando você executa a operação da API GetQueryResults, o Monitor de Internet retorna o seguinte na resposta:

• Uma matriz de cadeia de dados que contém os resultados que a consulta retorna. As informações são retornadas em matrizes alinhadas com o campo Fields, também retornadas pela chamada da API. Usando o campo Fields, você pode analisar as informações do repositório Data e, em seguida, filtrá-las ou classificá-las para seus objetivos.

• Uma matriz de campos que lista os campos para os quais a consulta retornou dados (na resposta do campo Data). Cada item na matriz é um par nome-tipo de dados, como availability_score-float.

Solução de problemas

Caso sejam retornados erros quando você usar as operações da API da interface de consulta, verifique se você tem as permissões necessárias para usar o Monitor de Internet do Amazon CloudWatch. Especificamente, certifique-se de que você tenha as seguintes permissões:

internetmonitor:StartQuery
internetmonitor:GetQueryStatus
internetmonitor:GetQueryResults
internetmonitor:StopQuery

Essas permissões estão incluídas na política do AWS Identity and Access Management recomendada para usar o painel do Monitor de Internet no console. Para ter mais informações, consulte Permissões do IAM para o Monitor de Internet do Amazon CloudWatch.