Nesta página, explicamos como usar a API Monitoring para automatizar todas estas tarefas:
- conseguir uma lista ou descrição dos tipos de métricas personalizadas;
- conseguir uma lista ou descrição dos tipos de métricas integradas, que ajudam a criar métricas personalizadas. Essa lista também aparece na documentação. Veja Lista de métricas;
- conseguir uma lista ou descrição dos tipos de recursos monitorados disponíveis, que você usa para rotular os dados de série temporal das métricas personalizadas. Essa lista também aparece na documentação. Consulte Tipos de recursos monitorados.
Para ver uma introdução a esses conceitos, consulte Métricas, séries temporais e recursos.
Nesta página, descrevemos os métodos metricDescriptors.list
e get
, e também os monitoredResourceDescriptors.list
e get
.
Há várias maneiras de usá-los:
Para executar os métodos sem gravar códigos, o API Explorer baseado em formulários é usado nos exemplos das guias PROTOCOLO nesta página. Consulte API Explorer para ver mais informações sobre essa ferramenta.
Para saber como usar os métodos nas linguagens de programação selecionadas, consulte as amostras de códigos executáveis nesta página.
Métricas de navegação do BindPlane
As métricas do BindPlane são encontradas em Metrics Explorer.
Todas as métricas do BindPlane são mostradas com um tipo de recurso generic_node
, e o nome da métrica é prefixado com external.googleapis.com/bluemedora/generic_node/
.
Para ver informações sobre as fontes disponíveis no BindPlane, leia a documentação BindPlane Sources (em inglês).
Espaço de trabalho não obrigatório
Exceto ao trabalhar com métricas personalizadas, é possível usar qualquer projeto existente nas invocações metricDescriptors.list
e get
, mesmo que o projeto não esteja em um espaço de trabalho. Se você estiver trabalhando com métricas personalizadas, especifique o projeto em que elas serão definidas.
Também é possível usar qualquer projeto existente com os métodos monitoredResourceDescriptors.list
e get
.
Como listar descritores de métrica
Os descritores de métrica são os esquemas que definem métricas integradas e personalizadas. Navegue pelos descritores disponíveis para descobrir detalhes sobre as métricas que interessam você.
No momento, há mais de 900 métricas integradas. Consulte a Lista de métricas completa como referência.
Para mais informações sobre como os tipos de métricas são nomeados, consulte Convenções de nomenclatura.
Exemplo: como listar tipos de métrica
Para uma lista atual de tipos de métricas, use o método metricDescriptors.list
.
Para restringir o conjunto de tipos de métricas retornados, use um filtro. Veja tipos de valor e tipos de métrica para ajudar a decidir quais tipos de métricas serão pesquisados.
Protocolo
Veja a seguir exemplos de parâmetros para metricDescriptors.list
para retornar métricas do Compute Engine:
- nome:
projects/[PROJECT_ID]
- filter:
metric.type = starts_with("compute.googleapis.com")
- fields:
metricDescriptors.type,metricDescriptors.displayName
Antes de clicar no botão Execute, altere [PROJECT_ID]
para um ID válido.
O resultado de amostra a seguir mostra três das muitas métricas do Compute Engine que correspondem ao filtro:
"metricDescriptors": [
{
"displayName": "Dropped bytes",
"type": "compute.googleapis.com/firewall/dropped_bytes_count"
},
{
"displayName": "Dropped packets",
"type": "compute.googleapis.com/firewall/dropped_packets_count"
},
{
"displayName": "Reserved cores.",
"type": "compute.googleapis.com/instance/cpu/reserved_cores"
},
...
]
O valor type
aqui identifica o descritor de métrica, como compute.googleapis.com/firewall/dropped_packets_count
. Às vezes, esse valor também é chamado “tipo de métrica” ou “nome do tipo de métrica”.
C#
Go
Java
Node.js
PHP
Python
Ruby
Consulte Solução de problemas de chamadas da API se tiver dificuldade.
Exemplo: como conseguir descritores de métrica
Para ver mais detalhes sobre um tipo de métrica, recupere o descritor de métrica completo usando o método metricDescriptors.get
.
Para recuperar um descritor de métrica específico, você precisa do nome completo dele. Esse valor é criado a partir de dois componentes:
- Um prefixo composto por
projects/[PROJECT_ID]/metricDescriptors
. - O valor de
type
que identifica o descritor de métrica, por exemplo,compute.googleapis.com/firewall/dropped_packets_count
. Consulte a guia PROTOCOLO em Exemplo: como listar tipos de métricas para ver mais informações sobre o valortype
.
Exemplo: projects/[PROJECT_ID]/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
.
Protocolo
Para ver os detalhes da métrica /firewall/dropped_packets_count
do Compute Engine, use o seguinte parâmetro para metricDescriptors.get
:
- name:
projects/[PROJECT_ID]/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
Antes de clicar no botão Execute, altere [PROJECT_ID]
para um ID válido.
A resposta de amostra a seguir exibe o descritor da métrica:
{
"type": "compute.googleapis.com/firewall/dropped_packets_count",
"name": "projects/[PROJECT_ID]/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count",
"description": "Delta count of incoming packets dropped by the firewall.",
"displayName": "Dropped packets",
"labels": [
{
"key": "instance_name",
"description": "The name of the VM instance."
}
],
"metricKind": "DELTA",
"valueType": "INT64",
"unit": "1"
}
C#
Go
Java
Node.js
PHP
Python
Ruby
Consulte Solução de problemas de chamadas da API se tiver dificuldade.
Como listar recursos monitorados
Os recursos monitorados são entidades da nuvem que podem ser acompanhadas. Navegue pelos tipos de recursos monitorados atuais para encontrar os tipos de entidades que têm métricas.
No momento, há cerca de 100 descritores de recursos monitorados diferentes. Veja Tipos de recursos monitorados para ver o conjunto completo.
Para ver uma introdução aos descritores de métrica e aos recursos monitorados, consulte Métricas, séries temporais e recursos.
É possível usar qualquer projeto existente nas invocações monitoredResourceDescriptors.list
e get
, mesmo que o projeto não esteja em um espaço de trabalho.
Exemplo: como listar tipos de recursos
Para ver uma lista atual de tipos de recursos monitorados da API Monitoring, use o método monitoredResourceDescriptors.list
e forneça seu ID do projeto.
Protocolo
Para ver uma lista atual de tipos de recursos monitorados, use monitoredResourceDescriptors.list
com os seguintes parâmetros de amostra:
- name:
projects/[PROJECT_ID]
- fields:
resourceDescriptors.type
Antes de clicar no botão Execute, altere [PROJECT_ID]
para um ID válido.
A seguinte resposta de amostra exibe alguns dos tipos de recursos monitorados retornados:
{
"resourceDescriptors": [
{
"type": "api"
},
{
"type": "aws_cloudfront_distribution"
},
{
"type": "aws_dynamodb_table"
},
{
"type": "aws_ebs_volume"
},
...
}
C#
Go
Java
Node.js
PHP
Python
Ruby
Consulte Solução de problemas de chamadas da API se tiver dificuldade.
Como conseguir descritores de recursos
Para ver mais detalhes sobre os tipos de recursos monitorados, recupere o descritor completo usando o método monitoredResourceDescriptors.get
.
Para recuperar um descritor de recurso monitorado específico, você precisa do nome completo do descritor. Esse valor é criado a partir de dois componentes:
- Um prefixo composto por
projects/[PROJECT_ID]/monitoredResourceDescriptors
. - O valor de
type
que identifica o descritor de métrica, por exemplo,gce_instance
. Consulte a guia PROTOCOLO em Exemplo: como listar tipos de recursos para ver mais sobre o valortype
.
Exemplo: projects/[PROJECT_ID]/monitoredResourceDescriptors/gce_instance
.
Protocolo
Para ver os detalhes do tipo de recurso gce_instance
, use o parâmetro a seguir para o método monitoredResourceDescriptors.get
:
- nome:
projects/[PROJECT_ID]/monitoredResourceDescriptors/gce_instance
Antes de clicar no botão Execute, altere [PROJECT_ID]
para um ID válido.
A seguinte resposta de amostra exibe o descritor deste recurso monitorado:
{
"type": "gce_instance",
"displayName": "GCE VM Instance",
"description": "A virtual machine instance hosted in Google Compute Engine (GCE).",
"labels": [
{
"key": "project_id",
"description": "The identifier of the GCP project associated with this resource, such as \"my-project\"."
},
{
"key": "instance_id",
"description": "The numeric VM instance identifier assigned by Compute Engine."
},
{
"key": "zone",
"description": "The Compute Engine zone in which the VM is running."
}
],
"name": "projects/[PROJECT_ID]/monitoredResourceDescriptors/gce_instance"
}
C#
Go
Java
Node.js
PHP
Python
Ruby
Consulte Solução de problemas de chamadas da API se tiver dificuldade.
Encontrar recursos
Objetos de recurso monitorados são incluídos em dados de série temporal. No geral, é possível adivinhar quais métricas incluem recursos monitorados de tipos específicos. Por exemplo, caso queira ver um recurso monitorado gce_instance
, observe os dados da série temporal de uma métrica como compute.googleapils.com/instance/cpu/utilization
. Depois de identificar uma série temporal provável para métricas, veja Reading metric data (em inglês).