Visão geral das métricas baseadas em registros

Esta página traz uma visão geral do conceito de métricas com base em registros.

As métricas com base em registros são derivadas do conteúdo das entradas de registro. Por exemplo, é possível usar uma métrica com base em registros para contar o número de entradas que contêm uma mensagem específica ou para extrair informações de latência gravadas nas entradas de registro. É possível usar métricas com base em registros em políticas de alertas e gráficos do Cloud Monitoring.

Origens das métricas com base em registros

É possível usar as métricas definidas pelo Cloud Logging para coletar informações de uso geral e definir sua própria métrica com base em registros para capturar informações específicas do seu aplicativo ou empresa.

As métricas com base em registros podem ser aplicadas em um único projeto do Google Cloud ou em um bucket de registros. Não é possível criar métricas com base em registros para outros recursos do Google Cloud, como contas ou organizações do Cloud Billing.

Para informações sobre as diferenças entre as métricas com base em registros e em buckets, consulte Métricas com base em registros com escopo de bucket.

Métricas definidas pelo sistema

O Logging fornece um conjunto de métricas para valores de uso, como o número de entradas de registro armazenadas em buckets de registro em seu projeto ou o número de bytes exportados. Para uma lista completa das métricas definidas pelo sistema, consulte Métricas do Google Cloud: geração de registros.

Métricas definidas pelo usuário

É possível criar métricas com base em registros definidas pelo usuário para rastrear outras métricas importantes para o projeto. Por exemplo, é possível criar uma métrica com base em registros para contar o número de entradas de registro que correspondem a determinado filtro.

Por padrão, as métricas com base em registros definidas pelo usuário são calculadas com base em todos os registros recebidos pela API Logging para o projeto do Google Cloud, independentemente de quaisquer filtros de inclusão ou filtros de exclusão que possam se aplicar ao projeto do Google Cloud.

Também é possível criar métricas com base em registros definidas pelo usuário para um bucket de registros específico em um projeto do Google Cloud. As métricas com base em registros no escopo do bucket são calculadas com base em todos os registros destinados ao bucket, independentemente de onde foram originados. Para mais informações, consulte Métricas com base em registros em buckets de registros.

Tipos de dados para métricas com base em registros

As métricas com base em registros podem extrair dados de registros para criar métricas dos seguintes tipos:

  • Contador: essas métricas contam o número de entradas de registro que correspondem a um filtro especificado dentro de um período específico. Use os contadores quando quiser acompanhar o número de vezes que um valor ou uma string aparece nos registros.
  • Distribuição: essas métricas também contam valores, mas coletam as contagens em intervalos de valores (buckets de histograma). Use distribuições quando quiser extrair valores como latências.
  • Booleano: essas métricas capturam se uma entrada de registro corresponde ou não a um filtro especificado.

As métricas com base em registros definidas pelo usuário podem ser do tipo de métrica de contagem ou de distribuição. A maioria das métricas com base em registros definidas pelo sistema são contadores, mas algumas são do tipo booleano. As características dos contadores e distribuições são descritas em mais detalhes nas próximas seções.

Os dados de uma métrica com base em registros definida pelo usuário vêm somente de entradas de registro recebidas após a criação da métrica. Uma métrica não é preenchida retroativamente com dados de entradas de registro que já estão no Logging.

As métricas com base em registros do sistema são calculadas apenas com base nos registros incluídos. As métricas com base em registros definidas pelo usuário são calculadas com base nos registros incluídos e excluídos.

O Logging acumula informações para uma métrica com base em registros sempre que recebe uma entrada de registro correspondente. A geração de registros grava um novo ponto de dados na série temporal da métrica com a taxa de 1 ponto de dados por minuto, disponibilizando os dados ao Cloud Monitoring.

Cada ponto de dados em uma série temporal da métrica com base em registros representa apenas as informações extras (o delta) recebidas desde o ponto de dados anterior.

Nas seções a seguir, descrevemos as características das métricas de contador e de distribuição.

Métricas de contador

As métricas de contagem contam o número de entradas de registro correspondentes a determinado filtro. Por exemplo, é possível realizar estas ações:

  • Contar as entradas de registro que contêm uma mensagem de erro específica.
  • Contar o número de vezes que cada usuário invoca uma operação, procurando mensagens de registro que correspondam a esse padrão:

    ... user USERNAME called OPERATION ...

    Ao extrair USERNAME e OPERATION e usá-los como valores para dois rótulos, é possível perguntar mais tarde: "Quantas vezes sally chamou a operação update?", "Quantas pessoas chamaram a operação read?", "Quantas vezes george chamou uma operação?" e assim por diante.

Para mais informações, consulte Configurar métricas de contador.

Métricas de distribuição

As métricas de distribuição acumulam dados numéricos das entradas de registro correspondentes a um filtro. As métricas contêm uma série temporal de objetos de distribuição e cada um deles contém:

  • uma contagem do número de valores na distribuição;
  • a média dos valores;
  • a soma dos desvios quadrados: Somai=1..n(xi–média)2
  • um conjunto de buckets de histograma com a contagem de valores em cada bucket. É possível usar o layout padrão do bucket ou escolher um próprio.

Um uso comum para as métricas de distribuição é rastrear as latências. À medida que cada entrada de registro é recebida, um valor de latência é extraído de algum lugar na entrada de registro e é adicionado à distribuição. Em intervalos regulares, a distribuição acumulada é gravada no Cloud Monitoring.

Para informações sobre distribuições, incluindo o formato delas em uma série temporal e como elas são visualizadas, consulte Gráficos de métricas de distribuição.

Para informações sobre como criar métricas com base em registros de distribuição, consulte Configurar métricas de distribuição.

Tipos de recurso

Recomendamos que as métricas com base em registros especifiquem um único tipo de recurso. Essa especificação garante que os dados da série temporal gerados para sua métrica com base em registros correspondam ao modelo de dados esperado pelo Cloud Monitoring. Isso também simplifica o processo de criação de gráficos e políticas de alertas, já que não há ambiguidade sobre quais dados de séries temporais são gráficos ou monitorados.

Considere uma métrica com base em registros com o seguinte filtro:

severity>="ERROR"
resource.type="gce_instance"

O Cloud Monitoring reconhece que esses dados são de uma instância de VM do Compute Engine. Portanto, ao criar um gráfico para uma instância de VM, sua métrica com base em registros será listada como uma opção nos menus. Ao criar um gráfico para um tipo de recurso diferente, sua métrica com base em registros não é listada como uma opção.

Se você criar uma métrica com base em registros sem especificar um tipo de recurso, o Monitoring a listará como uma opção para vários tipos de recurso, mesmo que você não conte as entradas desses recursos.

Rótulos

As métricas com base em registros podem ter rótulos que permitem a coleta de várias séries temporais para a métrica. Os valores dos rótulos são extraídos dos campos nas entradas de registro correspondentes. O Logging grava séries temporais separadas para cada combinação de valores de rótulo.

Todas as métricas com base em registros fornecem um rótulo log padrão. Esse rótulo contém o valor da parte LOG_ID do campo logName na entrada de registro, por exemplo, cloudresourcemanager.googleapis.com%2Factivity.

As métricas com base em registros do sistema têm rótulos predefinidos que não podem ser alterados. No entanto, é possível personalizar rótulos para métricas definidas pelo usuário. Por exemplo, é possível usar rótulos na métrica com base em registros para registrar a pasta ou a organização de origem de uma entrada de registro, mesmo que essas métricas não possam ser criadas para pastas ou organizações. Para mais informações, consulte Rótulos de métricas com base em registros.

Gráficos e alertas no Cloud Monitoring

Use as métricas com base em registros definidas pelo usuário e pelo sistema no Cloud Monitoring para criar gráficos e políticas de alerta. Para mais informações, consulte Listar e gerar gráficos com métricas com base em registros e Alertar sobre métricas com base em registros.

No Cloud Monitoring, as métricas com base em registros usam os seguintes padrões de nomenclatura:

  • Sistema: logging.googleapis.com/SYSTEM_METRIC_NAME
  • Definido pelo usuário: logging.googleapis.com/user/USER_METRIC_NAME

As métricas com base em registros definidas pelo usuário incluem a string user.

Visibilidade dos escopos de métricas do Monitoring

As métricas com base em registros são ingeridas pelo Cloud Monitoring. A visibilidade dos dados de métricas para um projeto do Google Cloud é determinada por um escopo de métricas. Um escopo de métricas é uma lista de projetos monitorados pelo projeto que hospeda o escopo. O projeto host é chamado de projeto de escopo.

Por padrão, cada projeto hospeda um escopo de métricas que inclui apenas ele mesmo. Portanto, um projeto é um projeto de escopo por si só. Portanto, suas métricas, incluindo aquelas com base em registros, ficam visíveis apenas para seu projeto do Google Cloud.

Também é possível criar um escopo de métricas de vários projetos para o projeto do escopo. Com um escopo de métricas de vários projetos, o projeto pode ver as métricas de todos os projetos no escopo. O que fica visível para projetos individuais em um escopo de métricas de vários projetos é determinado pelo escopo de métricas hospedado por cada um desses projetos. O fato de dois projetos estarem em um escopo de métricas de vários projetos não significa que cada um deles tenha acesso às métricas ou aos dados de configuração no outro projeto.

Um único projeto também pode aparecer em vários escopos de métricas. As métricas desse projeto ficam visíveis para os projetos de cada um desses escopos.

As métricas, incluindo aquelas com base em registros, são definidas dentro de um projeto específico. Quando esse projeto aparece em vários escopos de métricas, elas ficam visíveis para projetos diferentes daquele em que estão definidos. Para informações sobre como os escopos de métricas e as métricas com base em registro com escopo de bucket interagem, consulte Projetos e escopos de métricas.

Para mais informações sobre escopos de métricas, incluindo escopos de várias projetos, e sobre projetos de escopo, consulte:

Preços

Todas as métricas com base em registros definidas pelo usuário são uma classe de métricas personalizadas do Cloud Monitoring e estão sujeitas a cobrança. Para informações sobre preços, consulte Preços do Cloud Logging: métricas com base em registros.

Cota

Para informações sobre as cotas e os limites associados a métricas com base em registros definidas pelo usuário, consulte Cotas e limites.

Solução de problemas

Se você encontrar problemas ao usar métricas com base em registros, consulte Solução de problemas de métricas com base em registros.