Configurar 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.

Criar uma métrica de contador

Ao criar um filtro para as entradas de registro que você quer contar na métrica, use expressões regulares. O comprimento de um filtro não pode exceder 20.000 caracteres.

Console

Siga estas etapas para criar uma métrica de contador no Console do Cloud no seu projeto do Google Cloud:

  1. Acesse a página Logging > Métricas com base em registros:

    Acessar "Métricas com base em registros"

  2. Clique em Criar métrica. O painel Criar métrica de registros é exibido.

  3. Defina o Tipo de métrica: selecione Contador.

  4. Defina os seguintes campos na seção Detalhes:

    • Nome da métrica de registro: escolha um nome que seja exclusivo entre as métricas com base em registros no projeto do Cloud. Há algumas restrições de nomenclatura. Consulte a seção Solução de problemas para detalhes.
    • Descrição: insira uma descrição para a métrica.
    • Unidades: deixe em branco ou insira o dígito 1.
  5. Defina o filtro de métricas na seção Seleção de filtro.

    Crie um filtro que colete apenas as entradas de registros que você quer contar na métrica usando a linguagem de consulta de geração de registros. Também é possível usar expressões regulares para criar os filtros da métrica.

    Clique em Visualizar registros para abrir um painel que mostra as entradas de registro que correspondem ao filtro.

  6. (Opcional) Adicione um rótulo na seção Rótulos. Para instruções sobre como criar rótulos, consulte Como criar um rótulo.

  7. Clique em Criar métrica.

gcloud

A ferramenta de linha de comando gcloud é compatível com métricas com base em registros do tipo contador 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 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 exclusivo entre as métricas com base em registros no projeto do Cloud. Há algumas restrições de nomenclatura. Consulte os detalhes em Resolver problemas de métricas com base em registros.

API

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 para uma introdução aos rótulos e detalhes sobre como criá-los na API.

Para ver mais detalhes, consulte o tipo LogMetric.

Latência da nova métrica

Sua nova métrica aparece na lista de métricas do visualizador de registros legado e nos menus relevantes do Monitoring imediatamente. Os dados geralmente ficam disponíveis em menos de um minuto.

Inspecionar métricas de contador

Para listar as métricas com base em registros definidas pelo usuário no projeto do Google Cloud ou inspecionar uma métrica específica no projeto do Cloud, faça o seguinte:

Console

Acesse a página Métricas com base em registros:

Acessar "Métricas com base em registros"

No painel Métricas definidas pelo usuário, são exibidas as métricas baseadas em registros definidas pelo usuário no projeto atual do Cloud:

Para visualizar os dados em uma métrica com base em registros, clique no menu na linha da métrica e selecione Visualizar no Metrics Explorer.

gcloud

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

gcloud logging metrics list

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

gcloud logging metrics describe METRIC_NAME

Para receber ajuda, use o seguinte comando:

gcloud logging metrics --help

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

API

Listar métricas

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

  • parent: o nome do recurso do projeto do Cloud: "projects/PROJECT_ID".
  • pageSize: o número máximo de resultados.
  • pageToken: recebe a próxima página de resultados. Para informações sobre como usar tokens de página, consulte projects.metrics.list.

Recuperar definições de métricas

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

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

    projects/PROJECT_ID/metrics/METRIC_ID
    

Ler dados de métricas

Para ler os dados da série temporal em uma métrica com base em registros, use projects.timeseries.list na API Cloud Monitoring. Para detalhes sobre os dados de série temporal, consulte Como ler séries temporais.

Para ler uma única métrica com base em registros definida pelo usuário, preencha os parâmetros do método com este tipo de métrica e identificador:

logging.googleapis.com/user/METRIC_ID

Atualizar métricas de contador

É possível editar uma métrica com base em registros definida pelo usuário para alterar a descrição, o filtro e os nomes dos campos referenciados na métrica. É possível adicionar novos rótulos à métrica e alterar as expressões regulares usadas para extrair valores da métrica e dos rótulos dela.

Não é possível alterar os nomes ou tipos de métricas com base em registros definidas pelo usuário ou os rótulos correspondentes. Além disso, não é possível excluir rótulos existentes em uma métrica com base em registros.

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

Console

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

    Acessar "Métricas com base em registros"

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

  3. Alterar os itens permitidos na métrica.

  4. Clique em Atualizar métrica.

gcloud

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

API

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

  • 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.

Excluir métricas de contador

Para excluir uma métrica com base em registros definida pelo usuário, faça o seguinte:

Console

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

    Acessar "Métricas com base em registros"

  2. Selecione a métrica que você quer excluir e clique em Excluir.

    Como alternativa, clique em Excluir métrica no menu da métrica com base em registros que você quer excluir.

gcloud

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

gcloud logging metrics delete METRIC_NAME

Para saber mais detalhes, use o seguinte comando:

gcloud logging metrics delete --help

API

Para excluir uma métrica com base em registros definida pelo usuário, use o método projects.metrics.delete na API.

Além disso, na página Métrica com base em registros do Console do Google Cloud, o painel Métricas definidas pelo usuário fornece mais recursos. para ajudar você a gerenciar as métricas definidas pelo usuário no projeto do Cloud. Consulte o painel de métricas definidas pelo usuário para mais detalhes.