Como criar métricas de contador

Nesta página, você verá como criar métricas com base em registros de contador usando o Console do Cloud, a API do Logging e a ferramenta de linha de comando gcloud.

Acesse Visão geral das métricas com base em registros para ter uma visão geral sobre esse assunto.

Como criar uma métrica de contador

Ao filtrar as entradas de registro que você quer contabilizar nas métricas, é possível usar expressões regulares.

Console

Siga estas etapas para criar uma métrica de contador baseada em registros no Console do Cloud:

  1. Clique em Geração de registros do Pacote de operações do Google Cloud > Métricas com base em registros na lista de navegação do lado esquerdo no Console do Cloud 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 contador

  4. No painel do visualizador, crie uma consulta que mostre apenas as entradas de registro que você quer contar na sua métrica.

    A consulta básica está disponível nos menus suspensos acima das entradas de registro. Como alternativa, é possível acessar a interface de consulta avançada clicando no menu suspenso no lado direito da barra de pesquisa e selecionando Convert to advanced filter.

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

  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 Como solucionar problemas para mais detalhes.
    • Descrição: descreva a métrica.
    • Rótulos: (opcional) adicione rótulos clicando em Adicionar item para cada rótulo. Para detalhes sobre como definir rótulos, consulte Rótulos de métricas com base em registros.
    • Unidades: para métricas de contador, 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 do 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 detalhes.

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

  • Se sua 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 é uma introdução aos rótulos com detalhes sobre como criá-los na API.

Para ver mais detalhes, consulte o tipo LogMetric.

SDK do Cloud

A ferramenta de linha de comando gcloud é compatível com as métricas baseadas em registros de contador sem rótulos. O comando para criar uma métrica com base em registros é o seguinte:

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

Por exemplo, o comando a seguir cria uma métrica de contador baseada 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 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 aparece imediatamente na lista de métricas do Visualizador de registros legado e nos menus relevantes do 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 de métrica

Para ler os dados de série temporal em uma métrica com base em registros, use projects.timeseries.list na API Cloud Monitoring. Para 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 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 contador

É possível atualizar uma métrica com base em registros para alterar a descrição, as consultas e os nomes dos campos mencionados na métrica. Adicione novos rótulos à métrica e modifique 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.

API Logging

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

Só é possível alterar a descrição e a consulta de uma métrica atual usando o SDK do Cloud.

Para atualizar uma métrica com base em registros, use este comando: 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 mais detalhes, use este comando:

gcloud logging metrics delete --help