Como criar métricas de contador

Nesta página, explicamos como criar métricas com base em registros do tipo de contagem usando o Console do GCP, a API Stackdriver Logging e o SDK do Cloud (o comando gcloud logging).

Como criar uma métrica de contagem

Console de registro

Siga estes passos para criar uma métrica de contagem com base em registros no Console do GCP:

  1. Clique em Stackdriver Logging > Métricas com base em registros, na lista de navegação no lado esquerdo do Console do GCP ou clique no seguinte botão:

    Acessar Métricas com base em registros

  2. Use o menu suspenso na parte superior da página para selecionar um projeto.

  3. Clique em Criar métrica na parte superior da página. O Editor de métricas é exibido no lado direito da página, e os registros são mostrados no painel do visualizador, no lado esquerdo:

    Criar métrica de contagem

  4. No painel do visualizador, crie um filtro para mostrar apenas as entradas de registro que você quer contar na métrica.

    O filtro básico está disponível nos menus suspensos acima das entradas de registro. Como alternativa, é possível acessar a interface avançada do filtro clicando no menu suspenso no lado direito da barra de pesquisa e selecionando Converter para filtro avançado.

    Para mais informações, consulte o Visualizador de registros.

  5. No painel Editor de métricas, defina os seguintes campos:

    • Nome: escolha um nome que seja exclusivo entre as métricas com base em registros no projeto. Algumas restrições de nomenclatura se aplicam. Consulte Solução de problemas para saber detalhes.
    • Descrição: descreva a métrica.
    • Rótulos: (opcional) adicione rótulos clicando em Adicionar item para cada rótulo. Para saber detalhes sobre como definir rótulos, consulte Rótulos de métricas com base em registros.
    • Unidades: para métricas de contagem, deixe este campo em branco ou digite 1.
    • Tipo: contador.
  6. Clique em Criar métrica para criá-la.

API Logging

Para criar uma métrica de contador, use o método projects.metrics.create da API Stackdriver Logging. É possível testar o método no APIs Explorer. Prepare os argumentos do método da seguinte maneira:

  1. Defina o campo pai como o projeto em que a métrica será criada:

    projects/[PROJECT_ID]
    
  2. Defina o corpo da solicitação como um objeto LogMetric. Veja a seguir um exemplo do objeto:

    {
      name:        "my-metric"
      description: "This is my metric."
      filter:      "resource.type=gce_instance AND logName:\"logs/syslog\"",
      metricDescriptor: {
          labels: [
            {
              key: "my-label",
              valueType: STRING,
              description: "This is my label.",
            }
          ]
      },
      labelExtractors: {
        "my-label":
          "REGEXP_EXTRACT(jsonPayload.someField, \"before ([0-9]+) after\")",
        ...
      },
    }
    

Observações:

  • Escolha um nome de métrica que seja exclusivo entre as métricas com base em registros no projeto. Algumas restrições de nomenclatura se aplicam. Consulte Solução de problemas para saber detalhes.

  • Para métricas de contador, os campos LogMetric, valueExtractor e bucketOptions não têm finalidade e são omitidos.

  • Se a métrica não tiver rótulos, será possível omitir os campos metricDescriptor e labelExtractors. Se a métrica tiver rótulos, consulte Rótulos de métricas com base em registros, que apresenta uma introdução aos rótulos e detalhes sobre como criá-los na API.

Para ver mais detalhes, consulte o tipo LogMetric.

SDK do Cloud

O comando do gcloud logging do Cloud SDK é compatível com métricas com base em registros do tipo de contagem sem rótulos. O comando para criar uma métrica com base em registros é:

gcloud logging metrics create [METRIC_NAME] [METRIC_DESCRIPTION] [FILTER]

Por exemplo, o comando a seguir cria uma métrica de contador com base em registros chamada error_count.

gcloud logging metrics create error_count \
    --description "Errors in syslog." \
    --log-filter "resource.type=gce_instance AND logName:logs/syslog AND severity>=ERROR"

Escolha um nome de métrica que seja exclusivo entre as métricas com base em registros no projeto. Algumas restrições de nomenclatura se aplicam. Consulte Solução de problemas para saber detalhes.

Latência da nova métrica

A nova métrica aparecerá imediatamente na lista de métricas do Visualizador de registros e nos menus pertinentes do Stackdriver Monitoring. Os dados são disponibilizados em menos de um minuto.

Como inspecionar métricas de contagem

Para listar as métricas com base em registros ou inspecionar uma métrica específica no projeto do GCP, faça o seguinte:

Console do Logging

Para acessar a página Métricas com base em registros, que lista todas as métricas com base em registros no projeto atual, clique no botão a seguir:

Acessar métricas com base em registros

Para visualizar os dados em uma métrica com base em registros, selecione Ver no Metrics Explorer no menu flutuante, no lado direito da listagem da métrica.

API Logging

Como listar métricas

Para listar as métricas com base em registros definidas pelo usuário em um projeto, use o método API projects.metrics.list. Preencha os parâmetros do método da seguinte maneira:

  • parent: o nome do recurso do projeto: projects/[PROJECT_ID].
  • pageSize: o número máximo de resultados.
  • pageToken: recebe a próxima página de resultados. Consulte projects.metrics.list.

Como recuperar definições de métrica

Para recuperar uma única métrica com base em registros definida pelo usuário, use o método API projects.metrics.get. Preencha os parâmetros do método da seguinte maneira:

  • metricName: o nome do recurso da métrica:

    projects/[PROJECT_ID]/metrics/[METRIC_ID]
    

Leitura de dados métricos

Para ler os dados da série temporal em uma métrica com base em registros, use projects.timeseries.list na API Stackdriver Monitoring. Para saber mais detalhes, consulte Como ler séries temporais. Esta é a informação necessária para métricas com base em registros:

  • O tipo de métrica é logging.googleapis.com/user/[METRIC_ID].

SDK do Cloud

Para listar as métricas com base em registros definidas pelo usuário no seu projeto, use o seguinte comando:

gcloud logging metrics list

Para exibir uma métrica com base em registros definida pelo usuário no projeto, use o seguinte comando:

gcloud logging metrics describe [METRIC_NAME]

Para saber mais detalhes, use o seguinte comando:

gcloud logging metrics --help

Não é possível ler dados da série temporal de uma métrica do Cloud SDK.

Como atualizar métricas de contagem

Você pode atualizar uma métrica com base em registros para alterar a descrição, os filtros e os nomes dos campos referenciados na métrica. Adicione novos rótulos à métrica e altere as expressões regulares usadas para extrair valores para a métrica e seus rótulos.

Não é possível alterar os nomes ou tipos de métricas com base em registros ou os rótulos deles e excluir rótulos atuais em uma métrica com base em registros.

Para editar ou atualizar uma métrica com base em registros, siga as instruções abaixo:

Console do Logging

  1. Vá para a página Métricas com base em registros:

    Acessar métricas com base em registros

  2. Clique em Editar métrica no menu no lado direito da métrica com base em registros que você quer editar.

  3. Altere apenas os itens permitidos na métrica.

  4. Clique em Concluído.

Logging API

Para editar ou atualizar uma métrica com base em registros, use o método projects.metrics.update na API. Defina os campos da seguinte maneira:

  • metricName: o nome completo do recurso da métrica:

    projects/[PROJECT_ID]/metrics/[METRIC_ID]
    

    Exemplo:

    projects/my-gcp-project/metrics/my-error-metric
    
  • No corpo da solicitação, inclua um objeto LogMetric que seja exatamente igual à métrica atual, exceto pelas alterações e adições que você quer fazer.

SDK do Cloud

Ele permite alterar somente a descrição e o filtro de uma métrica atual.

Para atualizar uma métrica com base em registros, use o comando a seguir. Especifique uma ou ambas as sinalizações:

gcloud logging metrics update [METRIC_NAME] --description=[DESCRIPTION] --log-filter=[FILTER]

Para saber mais detalhes, use o seguinte comando:

gcloud logging metrics update --help

Como excluir métricas de contagem

Para excluir uma métrica com base em registros, faça o seguinte:

Console do Logging

  1. Vá para a página Métricas com base em registros:

    Acessar métricas com base em registros

  2. Selecione as métricas que você quer excluir e clique em Excluir na parte superior da página.

    Também é possível clicar em Excluir métrica no menu no lado direito da métrica com base em registros que você quer excluir.

API Logging

Use o método projects.metrics.delete na API.

SDK do Cloud

Use o seguinte comando para excluir uma métrica com base em registros definida pelo usuário no projeto atual:

gcloud logging metrics delete [METRIC_NAME]

Para saber mais detalhes, use o seguinte comando:

gcloud logging metrics delete --help

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Stackdriver Logging
Precisa de ajuda? Acesse nossa página de suporte.