Introdução à Cloud Monitoring API

Esta página descreve algumas das funcionalidades da API Cloud Monitoring v3.

Para consultar 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. Normalmente, este parâmetro tem uma descrição semelhante à seguinte:

Obrigatório. O projeto no qual executar o pedido. O formato é:
projects/[PROJECT_ID_OR_NUMBER]

Na API Monitoring, o valor de PROJECT_ID_OR_NUMBER identifica uma das seguintes opções:

Alguns métodos na API Monitoring requerem que o projeto seja um projeto de âmbito de um âmbito de métricas; outros métodos não. Um pequeno número de métodos pode devolver resultados diferentes, consoante o tipo de projeto.

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

projeto de âmbito de um âmbito de métricas necessário

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

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

Nenhum dos métodos na API de métricas requer o parâmetro name para se referir a um projeto de âmbito de um âmbito de métricas, mas alguns métodos comportam-se de forma diferente quando:

  • Os seguintes métodos na API Metrics operam noGoogle Cloud projeto nomeado. Estes métodos afetam os dados apenas no projeto com nome, independentemente de o projeto também ser um projeto de âmbito de um âmbito de métricas.

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

  • Os restantes métodos na API de métricas comportam-se da seguinte forma:

    • Se o projeto com nome não for um projeto de âmbito de um âmbito de métricas, os métodos obtêm dados apenas do projeto com nome.
    • Se o projeto com nome também for um projeto de âmbito de um âmbito de métricas, os métodos vão obter dados do projeto com nome e de todos os projetos que monitoriza.

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

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

Para ver informações sobre como configurar um Google Cloud projeto como um projeto de âmbito de um âmbito de métricas, consulte a vista geral dos âmbitos de métricas.

Recursos da API

Métrica

A API Monitoring dá-lhe acesso a aproximadamente 6500 métricas do Cloud Monitoring do Google Cloud e dos Amazon Web Services. Pode criar as suas próprias métricas personalizadas e organizar os seus recursos na nuvem através de grupos.

Para uma introdução aos conceitos de métricas e às estruturas de dados que os representam, consulte o artigo Métricas, séries cronológicas e recursos.

Para saber como gerir as métricas personalizadas e as métricas incorporadas, consulte o artigo Vista geral das métricas definidas pelo utilizador.

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

Recursos monitorizados

Um recurso monitorizado é algo sobre o qual são recolhidas métricas. Por exemplo, pode ter interesse na atividade de uma instância de VM ou de um componente de hardware.

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

Grupos de recursos monitorizados

Um grupo é uma coleção dinâmica de recursos monitorizados. Sempre pôde criar grupos manualmente na Google Cloud consola e também pode usar a API Cloud Monitoring para escrever código que cria e usa grupos.

Para mais informações, consulte a referência da API para Group.

Políticas de alerta

Uma política de alertas é um recurso de configuração que descreve os critérios para gerar incidentes e como receber notificações quando esses incidentes são criados. O artigo Conceitos de alertas explica os conceitos básicos das políticas de alertas. Para mais informações, consulte a referência da API para AlertPolicy.

A API também lhe permite criar políticas de alerta com base numa proporção de duas métricas. Atualmente, não é possível criar rácios através da monitorização na consola. Google Cloud Para mais informações, consulte MetricThreshold na AlertPolicy referência.

Canais de notificação

Um canal de notificação é um recurso de configuração que descreve como receber notificações quando ocorrem incidentes. Os canais de notificação podem fazer referência a uma variedade de diferentes tipos de serviços e pontos finais de comunicação. Estes são especificados em descritores. Os descritores determinam o conjunto de parâmetros de configuração incluídos num objeto de canal.

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

Monitorização de serviços

Os recursos de monitorização de serviços são usados para configurar objetivos ao nível do serviço que podem ser usados para monitorizar o estado dos seus serviços.

O Service Monitoring adiciona os seguintes recursos à API Monitoring:

Para mais informações sobre estes conceitos de monitorização de serviços e sobre a utilização da API, consulte o artigo Monitorização de SLOs.

Painéis de controlo

Pode criar e manipular programaticamente painéis de controlo e gráficos usando o ponto final Dashboards. Para obter informações sobre como usar este ponto final para gerir painéis de controlo e gráficos, consulte o artigo Gerir painéis de controlo por API.

Linguagem de consulta de monitorização

A linguagem de consulta de monitorização (MQL) oferece uma interface baseada em texto para consultar dados de séries cronológicas do Cloud Monitoring. A MQL usa um modelo de consulta canalizada e é mais expressiva do que os filtros de monitorização. Pode usar consultas MQL a partir da API Monitoring ou do editor de código.

Para informações gerais sobre a MQL, consulte o artigo Usar a linguagem de consulta de monitorização.

Para obter informações sobre como usar o MQL para obter dados de séries cronológicas através da API Monitoring, consulte a referência da API para o método timeSeries.query.

Filtros

A API Monitoring usa filtros para selecionar métricas, obter dados de séries cronológicas e recolher recursos monitorizados em grupos. Para mais informações, consulte o artigo Monitorização de filtros.

A API Monitoring também usa filtros para restringir o conjunto de resultados de determinadas listoperações. Consulte o artigo Ordenar e filtrar para ver detalhes sobre a gestão dos resultados dos métodos alertPolicies.list e notificationChannels.list.

Passos seguintes