Neste documento, você verá como usar a API Cloud Monitoring para ver listas ou descrições dos itens a seguir:
- Tipos de métricas personalizadas definidos no projeto.
- Tipos de métricas de terceiros com dados de série temporal no projeto.
As métricas geradas pelo BindPlane são exemplos de métricas de terceiros. As métricas do BindPlane
têm um prefixo
external.googleapis.com/bluemedora/generic_node/
. - Tipos de métricas integrados fornecidos pelo Google Cloud. Esses tipos de métrica podem ajudar você a criar métricas personalizadas. Também é possível encontrar informações sobre essas métricas na documentação. Consulte Lista de métricas.
- Tipos de recursos monitorados disponíveis para o projeto. Você também pode encontrar informações sobre esses recursos na documentação. Consulte Lista de recursos monitorados.
Existem várias maneiras de usar os métodos de API descritos nesta página:
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.
Antes de começar
- Para uma introdução a métricas e recursos monitorados, consulte Métricas, séries temporais e recursos.
Listar descritores de métrica
Os descritores de métricas são os esquemas que definem as métricas. Para encontrar detalhes sobre as métricas do seu interesse, acesse os descritores de métrica disponíveis:
- Métricas integradas: é possível emitir solicitações de API para qualquer projeto existente ou usar a documentação de Listas de métricas.
- Métricas personalizadas e externas: é preciso emitir a solicitação de API para um projeto em que a métrica personalizada esteja definida ou onde existam dados de série temporal para a métrica.
Para mais informações sobre como os tipos de métricas são nomeados, consulte Convenções de nomenclatura.
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.
Para ajuda sobre como decidir quais tipos de métricas pesquisar, consulte
Tipos de valores e tipos de métrica.
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")
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": [ { "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_bytes_count", "labels": [{...}], ... "description": "Count of incoming bytes dropped by the firewall.", "displayName": "Dropped bytes", "type": "compute.googleapis.com/firewall/dropped_bytes_count", ... }, { "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count", "labels": [{...}], ... "description": "Count of incoming packets dropped by the firewall.", "displayName": "Dropped packets", "type": "compute.googleapis.com/firewall/dropped_packets_count", }, ... ]
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
Se tiver dificuldade, consulte Solução de problemas de chamadas de API.
Receber descritores de métrica
Para informações sobre um tipo de métrica específico, use o método metricDescriptors.get
.
Esse método retorna um descritor de métrica.
Para recuperar um descritor de métrica específico, forneça o nome completo da métrica à API. O nome completo é construído 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 Tipos de métricas de lista para mais informações sobre o valortype
.
Veja a seguir um exemplo do nome completo de uma métrica:
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:
{ "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count", "labels": [ { "key": "instance_name", "description": "The name of the VM instance." } ], "metricKind": "DELTA", "valueType": "INT64", "unit": "1", "description": "Count of incoming packets dropped by the firewall.", "displayName": "Dropped packets", "type": "compute.googleapis.com/firewall/dropped_packets_count", }
C#
Go
Java
Node.js
PHP
Python
Ruby
Se tiver dificuldade, consulte Solução de problemas de chamadas de API.
Listar recursos monitorados
Os recursos monitorados são entidades da nuvem que podem ser acompanhadas. Para encontrar os tipos de entidades que têm métricas, procure na lista de tipos de recursos monitorados.
Para receber informações sobre recursos monitorados, emita solicitações de API para qualquer projeto atual ou use a documentação da Lista de recursos monitorados.
Listar tipos de recurso
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:
- nome:
projects/PROJECT_ID
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": "aiplatform.googleapis.com/Endpoint", "displayName": "AI Platform Endpoint", "description": "A Cloud AI Platform API Endpoint where Models are deployed into it.", "labels": [{...}], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/aiplatform.googleapis.com/Endpoint", }, { "type": "aiplatform.googleapis.com/Featurestore", "displayName": "AI Platform Feature Store", "description": "A Cloud AI Platform Feature Store.", "labels": [{...}], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/aiplatform.googleapis.com/Featurestore", },
C#
Go
Java
Node.js
PHP
Python
Ruby
Se tiver dificuldade, consulte Solução de problemas de chamadas de API.
Como conseguir descritores de recursos
Para ver detalhes sobre um tipo de recurso monitorado específico, use o método monitoredResourceDescriptors.get
.
Para recuperar um descritor de recurso monitorado específico, é necessário fornecer o nome completo do descritor à API. O nome completo é construído a partir de dois componentes:
- Um prefixo composto por
projects/PROJECT_ID/monitoredResourceDescriptors
. - O valor
type
que identifica o descritor de recurso monitorado, por exemplo,gce_instance
. Consulte a guia Protocolo em Tipos de recursos da lista para mais informações sobre o valortype
.
Veja a seguir um exemplo do nome completo de um recurso monitorado:
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": "VM Instance", "description": "A virtual machine instance hosted in Compute Engine.", "labels": [ { "key": "project_id", "description": "The identifier of the Google Cloud 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
Se tiver dificuldade, consulte Solução de problemas de chamadas de API.
A seguir
Para informações sobre como usar a API Cloud Monitoring para ler dados de série temporal, consulte Como ler dados de métricas.
Para uma lista de tipos de recursos monitorados disponíveis para uso com métricas personalizadas, consulte Como escolher um tipo de recurso monitorado.