Monitorar o Azure Cosmos DB
Este artigo descreve:
- Os tipos de dados de monitoramento que você pode coletar para esse serviço.
- Maneiras de analisar esses dados.
Observação
Se já estiver familiarizado com esse serviço e/ou com o Azure Monitor e apenas quiser saber como analisar os dados de monitoramento, confira a seção Analisar ao final deste artigo.
Quando seus aplicativos e processos de negócios críticos dependem de recursos do Azure, você precisa monitorar e receber alertas para o seu sistema. O serviço do Azure Monitor coleta e agrega métricas e logs de cada componente do seu sistema. O Azure Monitor lhe fornece uma exibição da disponibilidade, desempenho e resiliência e notifica você em caso de problemas. Você pode usar o portal do Azure, o PowerShell, a CLI do Azure, a API REST ou as bibliotecas de cliente para configurar e exibir dados de monitoramento.
- Para obter mais informações sobre o Azure Monitor, confira a Visão geral do Azure Monitor.
- Para obter mais informações sobre como monitorar os recursos do Azure de modo geral, confira Monitorar os recursos do Azure com o Azure Monitor.
Insights
Alguns serviços no Azure têm um painel de monitoramento integrado no portal do Azure que fornece um ponto de partida para monitorar seu serviço. Esses painéis são chamados de insights e você pode encontrá-los no Hub de Insights do Azure Monitor no portal do Azure.
Insights do Azure Cosmos DB
Os insights do Azure Cosmos DB são um recurso baseado no recurso de pastas de trabalho do Azure Monitor. Use os insights do Azure Cosmos DB para ter ver o desempenho geral, falhas, capacidade e integridade operacional de todos os seus recursos do Azure Cosmos DB em uma experiência interativa unificada.
Para obter mais informações sobre os insights do Azure Cosmos DB, consulte os seguintes artigos:
Tipos de recurso
O Azure usa o conceito de tipos de recursos e IDs para identificar tudo em uma assinatura. O Azure Monitor organiza os principais dados de monitoramento de maneira similar em métricas e logs com base em tipos de recursos, também chamados de namespaces. Métricas e logs diferentes estão disponíveis para diferentes tipos de recursos. Seu serviço pode estar associado a mais de um tipo de recurso.
Os tipos de recurso também fazem parte das IDs de recursos para cada recurso em execução no Azure. Por exemplo, um tipo de recurso para uma máquina virtual é Microsoft.Compute/virtualMachines. Para obter uma lista de serviços e os tipos de recursos associados a eles, confira Provedores de recursos.
Para obter mais informações sobre os tipos de recursos do Azure Cosmos DB, consulte a Referência de dados de monitoramento do Azure Cosmos DB.
Armazenamento de dados
Para o Azure Monitor:
- Os dados de métricas são armazenados no banco de dados de métricas do Azure Monitor.
- Os dados de log são armazenados no repositório de logs do Azure Monitor. O Log Analytics é uma ferramenta no portal do Azure que pode consultar esse repositório.
- O log de atividades do Azure é um repositório separado com uma interface própria no portal do Azure.
Opcionalmente, você pode rotear dados de log de atividades e métricas para o repositório de logs do Azure Monitor. Em seguida, você pode usar o Log Analytics para consultar os dados e correlacioná-los com outros dados de log.
Muitos serviços podem usar configurações de diagnóstico para enviar dados de métricas e logs para outros locais de armazenamento fora do Azure Monitor. Os exemplos incluem o Armazenamento do Azure, sistemas de parceiros hospedados e sistemas de parceiros não Azure usando os Hubs de Eventos.
Para obter informações detalhadas sobre como o Azure Monitor armazena dados, confira Plataforma de dados do Azure Monitor.
Métricas de plataforma do Azure Monitor
O Azure Monitor fornece métricas de plataforma para a maioria dos serviços. Essas métricas são:
- Definidas individualmente para cada namespace.
- Armazenadas no banco de dados de métricas da série temporal do Azure Monitor.
- Leves e capazes de dar suporte a alertas quase em tempo real.
- Usadas para acompanhar o desempenho de um recurso ao longo do tempo.
Coleta: O Azure Monitor coleta as métricas da plataforma automaticamente. Nenhuma configuração é necessária.
Roteamento: você também pode rotear métricas de plataforma para Logs do Azure Monitor / Log Analytics para que você possa consultá-los com outros dados de log. Para obter mais informações, confira a Configuração de diagnóstico de métricas. Para saber como definir as configurações de diagnóstico para um serviço, confira Criar configurações de diagnóstico no Azure Monitor.
Para obter uma lista de todas as métricas que é possível coletar para todos os recursos no Azure Monitor, confira Métricas com suporte no Azure Monitor.
O Azure Monitor coleta as métricas do Azure Cosmos DB por padrão. Você não precisa configurar explicitamente nada. A maioria das métricas está disponível na página do portal do Azure Cosmos DB ou na página do Azure Monitor. Por padrão, essas métricas são coletadas com granularidade de um minuto. A granularidade pode variar com base na métrica escolhida. Por padrão, essas métricas têm um período de retenção de 30 dias.
As métricas do lado do servidor do Azure Cosmos DB incluem taxa de transferência, armazenamento, disponibilidade, latência, consistência e métricas de nível de sistema. No lado do cliente, você pode coletar os detalhes de cobrança de solicitação, a ID da atividade, as informações de exceção e rastreamento de pilha, o código de status e substatus HTTP e a cadeia de caracteres de diagnóstico. Por padrão, essas métricas têm um período de retenção de sete dias. Você pode usar esses dados para depurar problemas ou se precisar entrar em contato com a equipe de suporte do Azure Cosmos DB.
Os valores de dimensão para as métricas, como o nome do contêiner, não diferenciam maiúsculas de minúsculas. Essa situação pode resultar em confusão ou colisão de telemetria e ações em contêineres com esses nomes. Use a comparação de maiúsculas e minúsculas ao fazer comparações de cadeias de caracteres nesses valores de dimensão.
Para obter uma lista das métricas disponíveis para o Azure Cosmos DB, consulte a Referência de dados de monitoramento do Azure Cosmos DB.
Métricas não baseadas no Azure Monitor
Esse serviço fornece outras métricas que não estão incluídas no banco de dados de métricas do Azure Monitor.
- Para obter informações sobre soluções de parceiros e ferramentas que podem ajudar a monitorar o Azure Cosmos DB, consulte Monitorar o Azure Cosmos DB usando soluções de terceiros.
- Para implementar as métricas do Micrometer no SDK do Java para Azure Cosmos DB consumindo métricas do Prometheus, consulte Usar métricas do cliente do Micrometer para Java.
Logs de recursos do Azure Monitor
Os logs de recursos fornecem insights sobre as operações que foram executadas por um recurso do Azure. Os logs são gerados automaticamente, mas você precisa encaminhá-los para os logs do Azure Monitor para serem salvos ou consultados. Os logs são organizados em categorias. Um determinado namespace pode ter várias categorias de logs de recursos.
Coleta: Os logs de recursos não serão coletados nem armazenados enquanto você não criar uma configuração de diagnóstico e encaminhar os logs para um ou mais locais. Ao criar uma configuração de diagnóstico, você especifica quais categorias de logs coletar. Há várias maneiras de criar e manter configurações de diagnóstico, incluindo o portal do Azure, programaticamente e por meio do Azure Policy.
Encaminhamento: O padrão sugerido é encaminhar os logs de recursos para os logs do Azure Monitor para que você possa consultá-los com outros dados de logs. Também estão disponíveis outros locais, como o Armazenamento do Microsoft Azure, os Hubs de Eventos do Azure e determinados parceiros de monitoramento da Microsoft. Para obter mais informações, confira Logs de recursos do Azure e Destinos de logs de recursos.
Para obter informações detalhadas sobre como coletar, armazenar e encaminhar logs de recursos, confira Configurações de diagnóstico no Azure Monitor.
Para obter uma lista de todas as categorias de logs de recursos disponíveis no Azure Monitor, confira Logs de recursos com suporte no Azure Monitor.
Todos os logs de recursos no Azure Monitor têm os mesmos campos de cabeçalho, seguidos de campos específicos do serviço. O esquema comum está descrito em Esquema do log de recursos do Azure Monitor.
Você pode monitorar os logs de diagnóstico de sua conta do Azure Cosmos DB e criar painéis do Azure Monitor. Os dados como eventos e rastreamentos que ocorrem em uma segunda granularidade são armazenados como logs. Por exemplo, se a taxa de transferência de um contêiner for alterada, as propriedades de uma conta do Azure Cosmos DB são alteradas. Os logs capturam esses eventos. Você pode analisar esses logs ao executar consultas nos dados coletados.
Para exibir as categorias de log de recursos disponíveis, suas tabelas do Log Analytics associadas e os esquemas de logs do Azure Cosmos DB, confira Referência de dados de monitoramento do Azure Cosmos DB.
Log de atividades do Azure
O log de atividades contém eventos de nível de assinatura que acompanham as operações de cada recurso do Azure, conforme visto fora desse recurso, por exemplo, criar um recurso ou iniciar uma máquina virtual.
Coleta: Os eventos do log de Atividades são gerados e coletados automaticamente em um repositório separado para serem vistos no portal do Azure.
Roteamento: você pode enviar dados de log de atividades para os logs do Azure Monitor para analisá-los junto com outros dados de log. Também estão disponíveis outros locais, como o Armazenamento do Microsoft Azure, os Hubs de Eventos do Azure e determinados parceiros de monitoramento da Microsoft. Para obter mais informações sobre como encaminhar o log de atividades, confira Visão geral do log de atividades do Azure.
Analisar dados de monitoramento
Existem várias ferramentas para analisar os dados de monitoramento.
Ferramentas do Azure Monitor
O Azure Monitor dá suporte às seguintes ferramentas básicas:
Explorador de Métricas, uma ferramenta no portal do Azure que permite que você veja e analise as métricas de recursos do Azure. Para obter mais informações sobre essa ferramenta, consulte Analisar métricas com o explorador de métricas do Azure Monitor.
Log Analytics, uma ferramenta no portal do Azure que permite consultar e analisar dados de log usando o KQL (Linguagem de Consulta Kusto). Para obter mais informações, consulte Introdução às consultas de log no Azure Monitor.
O log de atividades, que tem uma interface do usuário no portal do Azure para exibição e pesquisas básicas. Para fazer uma análise mais detalhada, você precisa encaminhar os dados para os logs do Azure Monitor e executar consultas mais complexas no Log Analytics.
As ferramentas que permitem uma visualização mais complexa incluem:
- Painéis, que permitem que você combine diferentes tipos de dados em um único painel no portal do Azure.
- Pastas de Trabalho, relatórios personalizáveis que você pode criar no portal do Azure. As pastas de trabalho podem incluir texto, métricas e consultas de log.
- Grafana, uma ferramenta de plataforma aberta que oferece excelência em termos de painéis operacionais. Você pode usar o Grafana para criar painéis que incluem dados de várias fontes além do Azure Monitor.
- Power BI, um serviço de análises corporativas que fornece visualizações interativas nas diversas fontes de dados. Você pode configurar o Power BI para importar dados de log automaticamente do Azure Monitor a fim de aproveitar essas visualizações.
Ferramentas de exportação do Azure Monitor
Você pode obter dados do Azure Monitor em outras ferramentas usando os seguintes métodos:
Métricas: Use a API REST para métricas para extrair dados de métricas do banco de dados de métricas do Azure Monitor. A API dá suporte a expressões de filtros para refinar os dados recuperados. Para obter mais informações, confira Referência da API REST do Azure Monitor.
Logs: Use a API REST ou as bibliotecas de cliente associadas.
Outra opção é a exportação de dados do workspace.
Para começar a usar a API REST do Azure Monitor, confira o Passo a passo da API REST de monitoramento do Azure.
Analisar métricas do Azure Cosmos DB
Você pode usar o Metrics Explorer do Azure Monitor para analisar as métricas do Azure Cosmos DB com métricas de outros serviços do Azure selecionando Métricas em Monitoramento na navegação do portal da conta do Azure Cosmos DB. Para obter mais informações sobre como usar o Metrics Explorer, consulte Analisar métricas com o Metrics Explorer do Azure Monitor.
Você também pode monitorar a latência do lado do servidor, o uso da unidade de solicitação e o uso da unidade de solicitação normalizado para seus recursos do Azure Cosmos DB. Você pode selecionar métricas específicas para unidades de solicitação, armazenamento, latência, disponibilidade, Cassandra e outros.
No lado do cliente, você pode depurar problemas coletando métricas de cobrança de solicitação, a ID da atividade, as informações de exceção e rastreamento de pilha, o código de status e substatus HTTP e a cadeia de caracteres de diagnóstico.
Para obter mais informações e instruções detalhadas, consulte os seguintes artigos:
- Monitorar a latência do lado do servidor
- Monitorar o uso da unidade de solicitação
- Monitorar o uso da unidade de solicitação normalizada
- Monitorar atualizações de chave
Para obter uma lista de todas as métricas de recursos com suporte no Azure Monitor, consulte Métricas do Azure Monitor com suporte. Para obter uma lista das métricas de plataforma coletadas para o Azure Cosmos DB, veja Monitoramento das métricas de referência de dados do Azure Cosmos DB.
Monitorar o Azure Cosmos DB de forma programática
As métricas no nível da conta disponíveis no portal, como o uso de armazenamento da conta e o total de solicitações, não estão disponíveis por meio da API para NoSQL. No entanto, você pode recuperar os dados de uso no nível da coleção usando a API para NoSQL. Para recuperar os dados de nível de coleta, use uma das abordagens a seguir:
Para usar a API REST, execute um GET na coleção. As informações de uso e cota da coleção são retornadas nos cabeçalhos
x-ms-resource-quotaex-ms-resource-usagena resposta.Para usar o SDK do .NET, use o método DocumentClient.ReadDocumentCollectionAsync, que retorna uma ResourceResponse que contém várias propriedades de uso, como CollectionSizeUsage, DatabaseUsage e DocumentUsage.
Para acessar mais métricas, use o SDK do Azure Monitor. As definições de métrica disponíveis podem ser recuperadas usando este formato:
https://management.azure.com/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroup}/providers/Microsoft.DocumentDb/databaseAccounts/{DocumentDBAccountName}/providers/microsoft.insights/metricDefinitions?api-version=2018-01-01
Para recuperar métricas individuais, use o seguinte formato:
https://management.azure.com/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroup}/providers/Microsoft.DocumentDb/databaseAccounts/{DocumentDBAccountName}/providers/microsoft.insights/metrics?timespan={StartTime}/{EndTime}&interval={AggregationInterval}&metricnames={MetricName}&aggregation={AggregationType}&`$filter={Filter}&api-version=2018-01-01
Para saber mais, veja API REST de monitoramento do Azure.
Analisar logs do Azure Cosmos DB
Os dados nos Logs do Azure Monitor são armazenados em tabelas. Cada tabela tem seu próprio conjunto de propriedades exclusivas. Todos os logs de recursos no Azure Monitor têm os mesmos campos seguidos por campos específicos do serviço. O esquema comum está descrito em Esquema do log de recursos do Azure Monitor.
Para obter os tipos de logs de recursos coletados para o Azure Cosmos DB, veja Referência de dados de monitoramento do Azure Cosmos DB.
Consulte os seguintes artigos para obter mais informações sobre como trabalhar com logs do Azure Monitor para o Azure Cosmos DB:
- Monitorar dados usando as configurações de diagnóstico do Azure
- Auditar logs do painel de controle
- Adicionar uma transformação para os dados do workspace
Consultas do Kusto
Analise os dados de monitoramento nos logs do Azure Monitor/no repositório do Log Analytics usando o KQL (Linguagem de Consulta Kusto).
Importante
Quando você seleciona Logs no menu do serviço no portal, o Log Analytics é aberto com o escopo da consulta definido para o serviço atual. Esse escopo significa que as consultas de log incluirão apenas dados desse tipo de recurso. Se você quiser executar uma consulta que inclua dados de outros serviços do Azure, selecione Logs no menu do Azure Monitor. Confira Escopo da consulta de log e intervalo de tempo no Log Analytics do Azure Monitor para obter detalhes.
Para obter uma lista de consultas comuns para qualquer serviço, confira a Interface de consultas do Log Analytics.
Antes de usar o Log Analytics para emitir consultas Kusto, você deve habilitar logs de diagnóstico para operações de plano de controle. Ao habilitar os logs de diagnóstico, você seleciona entre armazenar seus dados em tabelas específicas do recurso ou na única tabela AzureDiagnostics (herdada). O texto exato das consultas Kusto depende do modo de coleta selecionado.
Aqui estão algumas consultas que você pode inserir na barra de pesquisa Pesquisa de logs para ajudar no monitoramento dos recursos do Azure Cosmos DB.
Para consultar todos os logs do plano de controle do Azure Cosmos DB:
CDBControlPlaneRequests
Para consultar todos os logs do plano de dados do Azure Cosmos DB:
CDBDataPlaneRequests
Para consultar uma lista filtrada de logs de plano de dados, específica para um único recurso:
CDBDataPlaneRequests
| where AccountName=="<account-name>"
Para obter uma contagem de logs de plano de dados, agrupados por recurso:
CDBDataPlaneRequests
| summarize count() by AccountName
Para gerar um gráfico de logs de plano de dados, agrupado pelo tipo de operação:
CDBDataPlaneRequests
| summarize count() by OperationName
| render piechart
Para consultas Kusto que você pode usar para solucionar problemas com o Azure Cosmos DB, consulte os seguintes artigos:
- Solucionar problemas usando consultas básicas
- Solucionar problemas usando consultas de diagnóstico avançadas
Esses exemplos são apenas uma pequena amostragem das consultas avançadas que você pode executar no Azure Monitor usando a KQL (Linguagem de Consulta Kusto). Para obter mais exemplos, consulte os exemplos de consultas Kusto.
Alertas
Os alertas do Azure Monitor o notificam proativamente quando condições específicas são encontradas em seus dados de monitoramento. Os alertas permitem que você identifique e resolva problemas no seu sistema antes que os clientes os percebam. Para saber mais, confira Alertas do Azure Monitor.
Existem muitas fontes de alertas comuns para os recursos do Azure. Para obter exemplos de alertas comuns para recursos do Azure, confira Amostra de consultas de alerta de logs. O site Alertas de Linha de Base do Azure Monitor (AMBA) fornece um método semi-automatizado de implementação de importantes alertas, painéis e diretrizes de métricas da plataforma. O site se aplica a um subconjunto de serviços do Azure em contínua expansão, incluindo todos os serviços que fazem parte da Zona de Destino do Azure (ALZ).
O esquema de alerta comum padroniza a consumo do Azure Monitor para notificações de alerta no Azure. Para obter mais informações, confira Esquema de alertas comuns.
Tipos de alertas
Você pode receber alertas sobre qualquer fonte de dados de log ou métrica na plataforma de dados do Azure Monitor. Existem muitos tipos diferentes de alertas dependendo dos serviços que você está monitorando e dos dados de monitoramento que você está coletando. Diferentes tipos de alertas têm diversos benefícios e desvantagens. Para obter mais informações, confira Escolha o tipo de alerta de monitoramento correto para você.
A lista a seguir descreve os tipos de alertas do Azure Monitor que você pode criar:
- Os Alertas de métricas avaliam as métricas de recursos a intervalos regulares. As métricas podem ser métricas de plataforma, métricas personalizadas, logs do Azure Monitor convertidos em métricas ou métricas do Application Insights. Os alertas de métrica também podem aplicar várias condições e limites dinâmicos.
- Os Alertas de logs permitem que os usuários usem uma consulta do Log Analytics para avaliar os logs de recursos com uma frequência predefinida.
- Os Alertas do log de atividades são disparados quando ocorre um novo evento de log de atividades que corresponda às condições definidas. Os alertas do Resource Health e da Integridade do Serviço são alertas do log de atividades que relatam a integridade do serviço e do recurso.
Alguns serviços do Azure também dão suporte a alertas de detecção inteligentes, alertas do Prometheus ou regras de alerta recomendadas.
No caso de alguns serviços, você pode monitorar em larga escala aplicando a mesma regra de alerta de métricas a vários recursos do mesmo tipo que existem na mesma região do Azure. Notificações individuais são enviadas para cada recurso monitorado. Para ver os serviços e as nuvens do Azure com suporte, confira Monitorar vários recursos com uma regra de alerta.
Regras de alerta do Azure Cosmos DB
A tabela a seguir lista algumas regras de alerta comuns e recomendadas para o Azure Cosmos DB.
| Tipo de alerta | Condição | Descrição |
|---|---|---|
| Limitação de taxa em unidades de solicitação (alerta de métrica) | Nome da dimensão: StatusCode, Operador: igual a, Valores de dimensão: 429 | Alerta se o contêiner ou um banco de dados excedeu o limite de taxa de transferência provisionado. |
| Região com failover | Operador: maior que, Tipo de agregação: contagem, Valor do limite: 1 | Quando uma única região faz failover. Este alerta será útil se você não tiver habilitado o failover gerenciado por serviço. |
| Rotação de chaves (alerta do log de atividades) | Nível do evento: informativo, Status: iniciado | Alerta quando as chaves de conta são giradas. Você pode atualizar o aplicativo com as novas chaves. |
Para obter mais informações e instruções sobre como criar alertas para o Azure Cosmos DB, consulte Criar alerta sobre métricas. Para criar um alerta para monitorar se o armazenamento de uma chave de partição lógica está se aproximando de 20 GB, consulte Criar alerta para o tamanho da chave de partição lógica.
Recomendações do Assistente
Para alguns serviços, se ocorrerem condições críticas ou alterações iminentes durante operações de recurso, um alerta será exibido na página de Visão geral do serviço no portal. Você pode encontrar mais informações e correções recomendadas para o alerta nas Recomendações do assistente em Monitoramento no menu à esquerda. Durante as operações normais, nenhuma recomendação do assistente será exibida.
Para obter mais informações sobre o Assistente do Azure, confira Visão geral do Assistente do Azure.
Conteúdo relacionado
- Confira Referência de dados de monitoramento do Azure Cosmos DB para obter uma referência das métricas, logs e outros valores importantes criados para o Azure Cosmos DB.
- Confira Como monitorar recursos do Azure com o Azure Monitor para obter detalhes gerais sobre o monitoramento de recursos do Azure.