Métricas personalizadas e métricas estendidas que podem ser enviadas para o CloudWatch ou o CloudWatch Evidently - Amazon CloudWatch
Métricas personalizadasMétricas estendidas

Métricas personalizadas e métricas estendidas que podem ser enviadas para o CloudWatch ou o CloudWatch Evidently

Por padrão, os monitores de aplicações do RUM enviam métricas para o CloudWatch. Essas métricas e dimensões padrão estão listadas em Métricas do CloudWatch que você pode coletar com o CloudWatch RUM.

Além disso, é possível configurar um monitor de aplicações para exportar métricas. O monitor de aplicações pode enviar métricas estendidas, métricas personalizadas ou ambas. Ele pode enviar as métricas para o CloudWatch, para o CloudWatch Evidently, ou para ambos.

  • Métricas personalizadas: métricas personalizadas são métricas que você define. Com métricas personalizadas, é possível usar qualquer nome e namespace de métrica. Para derivar as métricas, é possível usar quaisquer eventos personalizados, eventos incorporados, atributos personalizados ou atributos padrão.

    É possível enviar métricas personalizadas para o CloudWatch ou o CloudWatch Evidently

  • Métricas estendidas: permite enviar as métricas padrão do CloudWatch RUM para o CloudWatch Evidently para serem usadas em experimentos do Evidently. Também é possível enviar qualquer uma das métricas padrão do CloudWatch RUM para o CloudWatch com dimensões adicionais. Dessa forma, essas métricas podem oferecer uma visão mais minuciosa.

Métricas personalizadas

Para enviar métricas personalizadas, você deve usar as APIs da AWS ou a AWS CLI em vez do console. Para obter informações sobre como usar as APIs da AWS, consulte PutRumMetricsDestination e BatchCreateRumMetricDefinitions.

O número máximo de definições de métricas estendidas e métricas personalizadas que um destino pode conter é 2000. Para cada métrica personalizada ou métrica estendida que você envia a cada destino, cada combinação de nome de dimensão e valor de dimensão conta para esse limite. Isso também conta como uma métrica personalizada do CloudWatch para o cálculo de preços.

O exemplo a seguir mostra como criar uma métrica personalizada derivada de um evento personalizado. Aqui está o exemplo de evento personalizado usado:

cwr('recordEvent', {
    type: 'my_custom_event', 
    data: {
        location: 'IAD', 
        current_url: 'amazonaws.com', 
        user_interaction: {
            interaction_1 : "click",
            interaction_2 : "scroll"
        }, 
        visit_count:10
    }
})

Com este evento personalizado, é possível criar uma métrica personalizada que contabilize o número de visitas ao URL amazonaws.com a partir de navegadores Chrome. A definição a seguir cria uma métrica chamada AmazonVisitsCount em sua conta, no namespace RUM/CustomMetrics/PageVisits.

{
    "AppMonitorName":"customer-appMonitor-name",
    "Destination":"CloudWatch",
    "MetricDefinitions":[
        {
            "Name":"AmazonVisitsCount",
            "Namespace":"PageVisit",
            "ValueKey":"event_details.visit_count",
            "UnitLabel":"Count",
            "DimensionKeys":{
                "event_details.current_url": "URL"
            },
            "EventPattern":"{\"metadata\":{\"browserName\":[\"Chrome\"]},\"event_type\":[\"my_custom_event\"],\"event_details\": {\"current_url\": [\"amazonaws.com\"]}}" 
        }
    ]
}

Métricas estendidas

Se configurar métricas estendidas, você poderá fazer um dos seguintes procedimentos ou ambos:

  • Envie as métricas padrão do CloudWatch RUM para o CloudWatch Evidently para serem usadas em experimentos do Evidently. Somente as métricas PerformanceNavigationDuration, PerformanceResourceDuration, WebVitalsCumulativeLayoutShift, WebVitalsFirstInputDelay e WebVitalsLargestContentfulPaint podem ser enviadas para o Evidently.

  • Envie qualquer métrica padrão do CloudWatch RUM para o CloudWatch com dimensões adicionais para que as métricas ofereçam uma visão mais minuciosa. Por exemplo, você pode ver as métricas específicas de um determinado navegador usado pelos usuários ou as métricas para os usuários em uma determinada geolocalização.

Para obter mais informações sobre as métricas padrão do CloudWatch RUM, consulte Métricas do CloudWatch que você pode coletar com o CloudWatch RUM.

O número máximo de definições de métricas estendidas e métricas personalizadas que um destino pode conter é 2000. Para cada métrica estendida ou métrica personalizada que você envia a cada destino, cada combinação de nome de dimensão e valor de dimensão conta como uma métrica estendida para esse limite. Isso também conta como uma métrica personalizada do CloudWatch para o cálculo de preços.

Quando você envia métricas estendidas para o CloudWatch, pode usar o console do CloudWatch RUM para criar alarmes do CloudWatch para essas métricas.

As métricas estendidas são cobradas como métricas personalizadas do CloudWatch. Para obter mais informações, consulte Preços do Amazon CloudWatch.

As dimensões a seguir são compatíveis com as métricas estendidas para todos os nomes de métricas que os monitores de aplicações podem enviar. Esses nomes de métricas estão listados em Métricas do CloudWatch que você pode coletar com o CloudWatch RUM.

  • BrowserName

    Exemplo de valores de dimensão: Chrome, Firefox, Chrome Headless

  • CountryCode O formato ISO-3166, com códigos de duas letras, é usado.

    Exemplo de valores de dimensão: US, JP, DE

  • DeviceType

    Exemplo de valores de dimensão: desktop, mobile, tablet, embedded

  • FileType

    Exemplo de valores de dimensão: Image, Stylesheet

  • OSName

    Exemplo de valores de dimensão: Linux, Windows, iOS, Android

  • PageId

Configurar métricas estendidas usando o console

Para usar o console para enviar métricas estendidas ao CloudWatch, use as etapas a seguir.

Para enviar métricas estendidas para o CloudWatch Evidently, você deve usar as APIs da AWS ou a AWS CLI em vez do console. Para obter informações sobre como usar as APIs da AWS para enviar métricas estendidas para o CloudWatch ou para o Evidently, consulte PutrumMetricsDestination e BatchCreateRumMetricDefinitions.

Para usar o console para configurar um monitor de aplicações e enviar métricas estendidas do RUM para o CloudWatch

  1. Abra o console do CloudWatch em https://console.aws.amazon.com/cloudwatch/.

  2. No painel de navegação, escolha Application Signals e, em seguida, RUM.

  3. Escolha List view (Visualização em lista) e depois o nome do monitor de aplicações que deverá enviar as métricas.

  4. Escolha a guia Configuration (Configuração) e escolha RUM extended metrics (Métricas estendidas do RUM).

  5. Escolha Send metrics (Enviar métricas).

  6. Selecione um ou mais nomes de métricas para enviar com dimensões adicionais.

  7. Selecione um ou mais fatores para usar como dimensões para essas métricas. À medida que você faz suas escolhas, o número de métricas estendidas que são criadas é exibido em Number of extended metrics (Número de métricas estendidas).

    Esse número é calculado multiplicando o número de nomes de métricas escolhidos pelo número de dimensões diferentes que você cria. Esse número representa por quantas métricas personalizadas a cobrança é efetuada. Para obter mais informações sobre os preços do CloudWatch, consulte Preço do Amazon CloudWatch.

    1. Para enviar uma métrica com o ID da página como dimensão, escolha Browse for page ID (Procurar ID de página) e selecione os IDs de página a serem usados.

    2. Para enviar uma métrica com o tipo de dispositivo como dimensão, escolha Desktop devices (Dispositivos desktop) ou Mobile and tablets (Celulares e tablets).

    3. Para enviar uma métrica com o sistema operacional como dimensão, selecione um ou mais sistemas operacionais em Operating system (Sistema operacional).

    4. Para enviar uma métrica com o tipo de navegador como dimensão, selecione um ou mais navegadores em Browsers (Navegadores).

    5. Para enviar uma métrica com geolocalização como dimensão, selecione um ou mais locais em Locations (Locais).

      Somente os locais de onde esse monitor de aplicações relatou métricas aparecerão na lista para você escolher.

  8. Quando você terminar de fazer suas seleções, escolha Send metrics (Enviar métricas).

  9. (Opcional) Na lista Extended metrics (Métricas estendidas), para criar um alarme que monitore uma das métricas, escolha Create alarm (Criar alarme) na linha dessa métrica.

    Para obter informações gerais sobre alarmes do CloudWatch, consulte Usar alarmes do Amazon CloudWatch. Para ver um tutorial sobre como configurar um alarme em uma métrica estendida do CloudWatch RUM, consulte Tutorial: criar uma métrica estendida e definir um alarme para ela.

Parar de enviar métricas estendidas

Para usar o console para parar de enviar métricas estendidas

  1. Abra o console do CloudWatch em https://console.aws.amazon.com/cloudwatch/.

  2. No painel de navegação, escolha Application Signals e, em seguida, RUM.

  3. Escolha List view (Visualização em lista) e depois o nome do monitor de aplicações que deverá enviar as métricas.

  4. Escolha a guia Configuration (Configuração) e escolha RUM extended metrics (Métricas estendidas do RUM).

  5. Selecione uma ou mais combinações de nome de métrica e dimensão da métrica para parar de enviar. Em seguida, escolha Actions (Ações), Delete (Excluir).

Tutorial: criar uma métrica estendida e definir um alarme para ela

Este tutorial demonstra como configurar uma métrica estendida para ser enviada ao CloudWatch e, em seguida, como definir um alarme para essa métrica. Neste tutorial, você cria uma métrica que rastreia erros de JavaScript no navegador Chrome.

Para configurar essa métrica estendida e definir um alarme para ela

  1. Abra o console do CloudWatch em https://console.aws.amazon.com/cloudwatch/.

  2. No painel de navegação, escolha Application Signals e, em seguida, RUM.

  3. Escolha List view (Visualização em lista) e escolha o nome do monitor de aplicações que deverá enviar a métrica.

  4. Escolha a guia Configuration (Configuração) e escolha RUM extended metrics (Métricas estendidas do RUM).

  5. Escolha Send metrics (Enviar métricas).

  6. Selecione JSErrorCount.

  7. Em Browsers (Navegadores), selecione Chrome.

    Essa combinação de JSErrorCount e Chrome enviará uma métrica estendida para o CloudWatch. A métrica conta os erros de JavaScript apenas para as sessões de usuário que usam o navegador Chrome. O nome da métrica será JSErrorCount e o nome da dimensão será Browser (Navegador).

  8. Escolha Send metrics (Enviar métricas).

  9. Na lista Extended metrics (Métricas estendidas), escolha Create alarm (Criar alarme) na linha que exibe JSErrorCount em Name (Nome) e Chrome em BrowserName.

  10. Em Specify metric and conditions (Especificar métrica e condições), confirme se os campos Metric name (Nome da métrica) e BrowserName estão preenchidos com os valores corretos.

  11. Em Statistic (Estatística), selecione a estatística que você deseja usar para o alarme. Average (Média) é uma boa escolha para esse tipo de métrica de contagem.

  12. Em Period (Período), selecione 5 minutes (5 minutos).

  13. Em Condições, faça o seguinte:

    • Escolha Static (Estático).

    • Escolha Greater (Maior) para especificar que o alarme entre no estado ALARM (ALARME) quando o número de erros for maior do que o limite que você está prestes a especificar.

    • Em than... (de...), insira o número para o limite do alarme. O alarme entra no estado ALARM (ALARME) quando o número de erros em um período de 5 minutos excede esse número.

  14. (Opcional) Por padrão, o alarme entra no estado ALARM (ALARME) assim que o número de erros excede o número limite que você define durante um período de 5 minutos. Opcionalmente, você pode alterar esse valor para que o alarme só entre no estado ALARM (ALARME) se esse número for excedido por um período maior que 5 minutos.

    Para fazer isso, escolha Additional configuration(Configuração adicional) e, em Datapoints to alarm (Pontos de dados para alarme), especifique quantos períodos de 5 minutos precisam ter o número de erros acima do limite para disparar o alarme. Por exemplo, você pode selecionar 2 de 2 para que o alarme só seja disparado quando dois períodos consecutivos de 5 minutos ficarem acima do limite, ou 2 de 3 para que o alarme seja disparado se dois dos três períodos consecutivos de 5 minutos ficarem acima do limite.

    Para obter mais informações sobre esse tipo de avaliação de alarme, consulte Avaliar um alarme.

  15. Escolha Próximo.

  16. Em Configure actions (Configurar ações), especifique o que deve acontecer quando o alarme entrar em estado de alarme. Para receber uma notificação com o Amazon SNS, faça o seguinte:

    • Escolha Adicionar notificação.

    • Escolha Em alarme.

    • Selecione um tópico existente do SNS ou crie um novo. Se você criar um novo, especifique um nome para o tópico e adicione pelo menos um endereço de e-mail a ele.

  17. Escolha Próximo.

  18. Insira um nome e uma descrição opcional para o alarme e escolha Next (Avançar).

  19. Revise os detalhes e escolha Create alarm (Criar alarme).