Esta página foi traduzida pela API Cloud Translation.
Switch to English

Introdução à API Cloud Monitoring

Esta página descreve alguns dos recursos da API Cloud Monitoring v3.

Para a documentação de referência da API, consulte uma das seguintes páginas:

Nomes de projetos na API Monitoring

Todos os métodos na API Monitoring têm um parâmetro name obrigatório. Esse parâmetro geralmente tem uma descrição como a seguinte:

Obrigatório. O projeto em que a solicitação será executada. Este é o formato dele:
projects/[PROJECT_ID_OR_NUMBER]

Na API Monitoring, o valor de PROJECT_ID_OR_NUMBER identifica um dos seguintes:

  • um projeto do Google Cloud;
  • Um projeto do Google Cloud que também é o projeto host de um espaço de trabalho

Alguns métodos na API Monitoring exigem que o projeto seja um projeto host de espaço de trabalho. outros métodos não. Um pequeno número de métodos pode retornar resultados diferentes, dependendo do tipo de projeto.

Para descrever essas classes de métodos, esta discussão usa o termo API metrics para se referir aos seguintes recursos na API Monitoring:

O projeto host do espaço de trabalho é obrigatório

Todos os métodos da API Monitoring que não fazem parte da API de métricas exigem o parâmetro name para se referir ao projeto host de um espaço de trabalho.

O projeto host do espaço de trabalho não é obrigatório

Nenhum dos métodos na API Metrics exige o parâmetro name para se referir ao projeto host de um espaço de trabalho, mas alguns métodos se comportam de maneira diferente quando é:

  • Os métodos a seguir na API de métricas operam no projeto do Cloud nomeado. Esses métodos afetam os dados apenas no projeto nomeado, independentemente de o projeto também ser um projeto host do espaço de trabalho.

    • timeSeries.create
    • metricDescriptors.create
    • metricDescriptors.delete
    • metricDescriptors.get
    • monitoredResourceDescriptors.get
  • Os métodos restantes da API Metrics se comportam da seguinte maneira:

    • Se o projeto nomeado não for um projeto host do espaço de trabalho, os métodos recuperarão dados apenas do projeto nomeado.
    • Se o projeto nomeado também for o projeto host de um espaço de trabalho, os métodos recuperarão dados do projeto nomeado e dos projetos monitorados.

    Os métodos deste grupo são os seguintes:

    • timeSeries.list
    • timeSeries.query
    • metricDescriptors.list
    • monitoredResourceDescriptors.list

Para informações sobre como configurar um projeto do Cloud como um projeto host do espaço de trabalho, consulte Como usar espaços de trabalho.

Recursos de API

Métrica

A API Monitoring fornece acesso a mais de 1500 métricas do Cloud Monitoring no Google Cloud e na Amazon Web Services. É possível criar suas próprias métricas personalizadas e organizar seus recursos de nuvem usando grupos.

Para uma introdução aos conceitos de métrica e às estruturas de dados que as representam, consulte Métricas, séries temporais e recursos.

Para saber como gerenciar suas métricas personalizadas e integradas, consulte Como usar métricas personalizadas.

Para ver uma lista completa de métricas disponíveis, consulte Lista de métricas.

Recursos monitorados

Um recurso monitorado abrange quais métricas são coletadas. Por exemplo, é possível ter interesse na atividade de uma instância de VM ou de um hardware.

Para ver uma lista dos recursos monitorados disponíveis, consulte a Lista de recursos monitorados.

Grupos de recursos monitorados

Um grupo é um conjunto dinâmico de recursos monitorados. Você sempre conseguiu criar grupos manualmente no console do Monitoring e também usou a API Cloud Monitoring para escrever código que cria e usa grupos.

Para saber mais, consulte a Referência da API sobre Group.

Políticas de alertas

Uma política de alertas é um recurso de configuração que descreve os critérios para gerar incidentes e como notificá-lo quando esses incidentes são criados. Os conceitos de alertas explicam os conceitos básicos das políticas de alertas. Para saber mais, consulte a Referência da API sobre AlertPolicy.

A API também permite criar políticas de alertas com base em uma proporção de duas métricas. No momento, não é possível criar proporções usando o Monitoring no Console do Google Cloud. Para mais informações, consulte MetricThreshold na referência de AlertPolicy.

Canais de notificação

Um canal de notificação é um recurso de configuração que descreve como notificar você quando ocorrerem incidentes. Os canais de notificação referem-se a vários tipos diferentes de serviços de comunicação e endpoints. Eles são especificados nos descritores. Os descritores determinam o conjunto de parâmetros de configuração incluídos em um objeto de canal.

Para mais informações, consulte a referência de NotificationChannel e a referência de NotificationChannelDescriptor.

Monitoramento do serviço

Os recursos de monitoramento de serviço são usados para configurar objetivos de nível de serviço que são usados para monitorar a integridade dos serviços.

O Service Monitoring inclui os recursos a seguir na API Monitoring:

Para mais informações sobre esses conceitos de monitoramento de serviço e sobre como usar a API, consulte Monitoramento de SLO.

Painéis

É possível criar e manipular de maneira programática painéis e gráficos usando o endpoint Dashboards. Para informações sobre como usar esse endpoint para gerenciar painéis e gráficos, consulte Como gerenciar painéis por API.

Linguagem de consulta do Monitoring

A Linguagem de consulta do Monitoring (MQL) fornece uma interface baseada em texto para consultar dados de série temporal do Cloud Monitoring. A MQL usa um modelo de consulta em pipeline e é mais expressiva do que os filtros do Monitoring. É possível usar consultas MQL da API Monitoring ou do Editor de consultas.

Para informações gerais sobre MQL, consulte Como usar a Linguagem de consulta do Monitoring.

Para mais informações sobre como usar a MQL para recuperar dados de série temporal usando a API Monitoring, consulte a referência da API para o método timeSeries.query.

Para mais informações sobre como criar painéis com gráficos baseados em MQTT usando a API Monitoring, consulte a referência da API do objeto TimeSeriesQuery. Esse objeto fornece o mecanismo para recuperar o conjunto de dados de um gráfico ou de uma visão geral.

Filtros

A API Monitoring usa filtros para selecionar métricas, buscar dados de série temporal e coletar recursos monitorados em grupos. Para mais informações, consulte Filtros de monitoramento.

A API Monitoring também usa filtros para restringir o conjunto de resultados de determinadas operações de list. Consulte Como classificar e filtrar para ver detalhes sobre como gerenciar os resultados de alertPolicies.list e notificationChannels.list.

Próximas etapas