Introdução à API Cloud Monitoring

A API Cloud Monitoring v3 permite consultar e gravar dados de métricas de maneira programática, organizar recursos monitorados em grupos e gerenciar painéis, políticas de alertas, objetivos de nível de serviço (SLOs) e canais de notificação. Para especificações de métodos e recursos, consulte a API Cloud Monitoring (REST) e a API Cloud Monitoring (gRPC).

Nomes de projetos na API Monitoring

Todos os métodos na API Monitoring têm um parâmetro name obrigatório. Normalmente, esse parâmetro tem uma descrição como esta:

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

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

Alguns métodos na API Monitoring exigem que o projeto seja um projeto de escopo de um escopo de métricas. Outros métodos não. Alguns métodos podem 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:

É necessário um projeto de escopo de métricas de escopo

Todos os métodos da API Monitoring que não fazem parte da API Metrics exigem que o parâmetro name se refira a um projeto de escopo de um escopo de métricas.

O projeto de escopo de um escopo de métricas não é obrigatório

Nenhum dos métodos na API Metrics exige que o parâmetro name se refira a um projeto de escopo de um escopo de métricas, mas alguns métodos se comportam de maneira diferente quando isso acontece:

  • Os métodos a seguir na API Metrics operam no projeto Google Cloud nomeado. Esses métodos afetam os dados apenas no projeto nomeado, independentemente de o projeto também ser um projeto de escopo de um escopo de métricas.

    • timeSeries.create
    • metricDescriptors.create
    • metricDescriptors.delete
    • metricDescriptors.get
    • monitoredResourceDescriptors.get

  • Os métodos restantes na API Metrics se comportam da seguinte maneira:

    • Se o projeto nomeado não for um projeto de escopo de um escopo de métricas, os métodos vão recuperar dados apenas do projeto nomeado.
    • Se o projeto nomeado também for um projeto de escopo de um escopo de métricas, os métodos vão recuperar dados do projeto nomeado e de todos os projetos que ele monitora.

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

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

Para informações sobre como configurar um projeto do Google Cloud como um projeto de escopo de um escopo de métricas, consulte Visão geral dos escopos de métricas.

Recursos de API

Métricas

A API Monitoring dá acesso a aproximadamente 6.500 métricas do Cloud Monitoring do Google Cloud e da Amazon Web Services. É possível criar métricas personalizadas e organizar os 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 as métricas integradas, consulte Visão geral das métricas definidas pelo usuário.

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. Sempre foi possível criar grupos manualmente no console do Google Cloud , e você também pode usar a API Cloud Monitoring para escrever códigos que criam e usam 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 alertas e como notificar você quando esses alertas forem criados. A Visão geral de alertas explica 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 ocorrem alertas. 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 Criar e 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 código.

Para informações gerais sobre a MQL, consulte Visão geral da 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.

Filtros

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

A API Monitoring também usa filtros para restringir o conjunto de resultados de determinadas operações list. Consulte Referência: classificação e filtragem para detalhes sobre como gerenciar os resultados dos métodos alertPolicies.list e notificationChannels.list.

Próximas etapas