As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Monitoramento do Amazon DocumentDB
Monitorar seus AWS serviços é uma parte importante para manter seus sistemas íntegros e funcionando de maneira ideal. Convém coletar dados de monitoramento de todas as partes de sua solução da AWS para que você possa depurar e corrigir mais facilmente as falhas ou degradações caso elas ocorram. Antes de começar a monitorar suas soluções da AWS , recomendamos que você considere e formule respostas para as seguintes perguntas:
+ Quais são seus objetivos de monitoramento?
+ Você fará o monitoramento de quais recursos?
+ Com que frequência você fará o monitoramento desses recursos?
+ Quais ferramentas de monitoramento você usará?
+ Quem é responsável por fazer o monitoramento?
+ Quem deve ser notificado e por quais meios se algo der errado?
Para entender os padrões de desempenho atuais, identificar anomalias de desempenho e elaborar métodos para a solução de problemas, você deverá estabelecer métricas de desempenho de linha de base para vários momentos e sob diferentes condições de carga. Ao monitorar sua solução da AWS , recomendamos que você armazene seus dados históricos de monitoramento para referência futura e para estabelecer as linhas de base.
Em geral, os valores aceitáveis para as métricas de desempenho dependem do aspecto da linha de base e do que a aplicação está fazendo. Investigue variações consistentes ou tendenciais de sua linha de base. Veja a seguir uma instrução sobre os tipos específicos de métricas:
+ **Alto uso de CPU ou RAM**: valores altos de uso de CPU ou RAM podem ser adequados, desde que estejam de acordo com seus objetivos em relação à sua aplicação (como throughput ou simultaneidade) e sejam esperados.
+ **Consumo de volume de armazenamento**: investigue o consumo de armazenamento (`VolumeBytesUsed`) se o espaço utilizado for consistentemente igual ou superior a 85% do espaço total do volume de armazenamento. Determine se você pode excluir dados do volume de armazenamento ou dados de arquivamento em outro sistema para liberar mais espaço. Para obter mais informações, consulte [Armazenamento do Amazon DocumentDB](how-it-works.md#how-it-works.storage) e [Cotas e limites do Amazon DocumentDB](limits.md).
+ **Tráfego de rede** - em relação ao tráfego de rede, fale com o administrador do sistema para entender qual throughput é esperado para sua rede de domínio e conexão com a internet. Inspecione o tráfego de rede caso o throughput seja consistentemente menor do que a esperada.
+ **Conexões do banco de dados** - considere restringir as conexões do banco de dados caso perceba um alto número de conexões de usuários em conjunto com uma diminuição na performance da instância e no tempo de resposta. O melhor número de conexões de usuários para sua instância varia conforme a classe da instância e a complexidade das operações sendo executadas.
+ **Métricas de IOPS** - os valores esperados para as métricas de IOPS dependem da especificação do disco e da configuração do servidor, por isso, use sua linha de base para saber os valores típicos. Inspecione caso os valores sejam consistentemente diferentes da sua linha de base. Para obter a melhor performance de IOPS, confira se o seu conjunto de trabalho típico se adéqua à memória para minimizar as operações de leitura e gravação.
O Amazon DocumentDB (com compatibilidade com o MongoDB) fornece uma variedade de CloudWatch métricas da Amazon que você pode monitorar para determinar a integridade e o desempenho de seus clusters e instâncias do Amazon DocumentDB. Você pode visualizar as métricas do Amazon DocumentDB usando várias ferramentas, incluindo o console do Amazon DocumentDB AWS CLI CloudWatch , a API e o Performance Insights.
**Topics**
+ [Monitorar o status de um cluster](monitoring_docdb-cluster_status.md)
+ [Monitorar o status de uma instância](monitoring_docdb-instance_status.md)
+ [Visualização das recomendações do Amazon DocumentDB](view-docdb-recommendations.md)
+ [Assinaturas de eventos](event-subscriptions.md)
+ [Monitorando o Amazon DocumentDB com CloudWatch](cloud_watch.md)
+ [Log de chamadas de API do Amazon DocumentDB com o CloudTrail](logging-with-cloudtrail.md)
+ [Definir o perfil das operações](profiling.md)
+ [Monitoramento com o Performance Insights](performance-insights.md)
# Monitoramento do status de um cluster do Amazon DocumentDB
O status de um cluster indica a integridade do cluster. Você pode visualizar o status de um cluster usando o console do Amazon DocumentDB ou o AWS CLI `describe-db-clusters` comando.
**Topics**
+ [Valores de status do cluster](#monitoring_docdb-status_values)
+ [Monitorar o status de um cluster](#monitor-cluster-status)
## Valores de status do cluster
A tabela a seguir lista os valores válidos para o status de um cluster.
| Status do cluster | Description |
| --- | --- |
| active | O cluster está ativo. Esse status se aplica somente a clusters elásticos. |
| available | O cluster está íntegro e disponível. Esse status se aplica somente a clusters baseados em instâncias. |
| backing-up | O backup do cluster está sendo executado no momento. |
| creating | O cluster está sendo criado. Ele fica inacessível enquanto está sendo criado. |
| deleting | O cluster está sendo excluído. Ele fica inacessível enquanto está sendo excluído. |
| failing-over | Um failover da instância principal para uma réplica do Amazon DocumentDB está sendo executado. |
| inaccessible-encryption-credentials | A AWS KMS chave usada para criptografar ou descriptografar o cluster não pode ser acessada. |
| maintenance | Uma atualização de manutenção está sendo aplicada ao cluster. Esse status é usado para a manutenção em nível de cluster que o Amazon DocumentDB programa com antecedência. |
| migrating | Um snapshot do cluster está sendo restaurado em um cluster. |
| migration-failed | Ocorreu uma falha na migração. |
| modifying | O cluster está sendo modificado devido a uma solicitação do cliente para modificá-lo. |
| renaming | O cluster está sendo renomeado devido a uma solicitação do cliente para renomeá-lo. |
| resetting-master-credentials | As credenciais principais do cluster estão sendo redefinidas devido a uma solicitação do cliente para redefini-las. |
| upgrading | A versão do mecanismo do cluster está sendo atualizada. |
## Monitorar o status de um cluster
------
#### [ Using the Console de gerenciamento da AWS ]
Ao usar o Console de gerenciamento da AWS para determinar o status de um cluster, use o procedimento a seguir.
1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)
1. No painel de navegação, escolha **Clusters**.
1. Na caixa de navegação Clusters, você verá a coluna **Identificador do cluster**. Suas instâncias estão listadas em clusters, semelhante à captura de tela abaixo.
![\[Tabela de clusters mostrando como uma instância está aninhada sob um cluster.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/choose-clusters.png)
1. Na coluna **Identificador de cluster**, encontre o nome da instância desejada. Em seguida, para localizar o status da instância, leia essa linha para a coluna **Status**, como mostrado a seguir.
![\[Instância do cluster, mostrando o status disponível.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/db-cluster-status-con.png)
------
#### [ Using the AWS CLI ]
Ao usar o AWS CLI para determinar o status de um cluster, use a `describe-db-clusters` operação. O código a seguir descobre o status do cluster `sample-cluster`.
Para Linux, macOS ou Unix:
```
aws docdb describe-db-clusters \
--db-cluster-identifier sample-cluster \
--query 'DBClusters[*].[DBClusterIdentifier,Status]'
```
Para Windows:
```
aws docdb describe-db-clusters ^
--db-cluster-identifier sample-cluster ^
--query 'DBClusters[*].[DBClusterIdentifier,Status]'
```
A saída dessa operação é semelhante à seguinte.
```
[
[
"sample-cluster",
"available"
]
]
```
------
# Monitoramento do status de uma instância do Amazon DocumentDB
O Amazon DocumentDB fornece informações sobre a condição atual de cada instância configurada no banco de dados.
Há três tipos de status que você pode visualizar para uma instância do Amazon DocumentDB:
+ Status da instância: esse status é mostrado na coluna **Status** da tabela de cluster Console de gerenciamento da AWS e mostra a condição atual do ciclo de vida da instância. Os valores mostrados na coluna **Status** são derivados do campo de `Status` da resposta da API `DescribeDBCluster`.
+ Status de integridade da instância: esse status é mostrado na coluna **Integridade da instância** da tabela de cluster no Console de gerenciamento da AWS e mostra se o mecanismo de banco de dados, o componente responsável por gerenciar e recuperar dados, está em execução. Os valores mostrados na coluna **Instance health** são baseados na métrica CloudWatch `EngineUptime` do sistema Amazon.
+ Status de manutenção: esse status é mostrado na coluna **Manutenção** da tabela de cluster Console de gerenciamento da AWS e indica o status de qualquer evento de manutenção que precise ser aplicado a uma instância. O status de manutenção é independente do status da outra instância e derivado da API `PendingMaintenanceAction`. Para obter mais informações sobre o status de manutenção, consulte [Manutenção do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html).
**Topics**
+ [Valores de status de instâncias](#monitoring_docdb-instance_status-values)
+ [Monitorando o status da instância usando o Console de gerenciamento da AWS ou AWS CLI](#monitoring-instance-status)
+ [Status de integridade da instância](#instance-health-status-values)
+ [Monitorando o status de integridade da instância usando o Console de gerenciamento da AWS](#monitoring-instance-health-status)
## Valores de status de instâncias
A tabela a seguir lista os possíveis valores de status de instâncias e como cada status é cobrado. Ela mostra se você será cobrado pela instância e pelo armazenamento, somente pelo armazenamento ou se não será cobrado. Para todos os status de instância, você sempre será cobrado pelo uso de backup.
| status da instância | Faturado | Description |
| --- | --- | --- |
| available | Faturado | A instância está íntegra e disponível. |
| backing-up | Faturado | No momento, está sendo feito o backup da instância. |
| configuring-log-exports | Faturado | A publicação de arquivos de log no Amazon CloudWatch Logs está sendo ativada ou desativada para essa instância. |
| creating | Não faturado | A instância está sendo criada. A instância não fica inacessível enquanto está sendo criada. |
| deleting | Não faturado | A instância está sendo excluída. |
| failed | Não faturado | Houve falha na instância e o Amazon DocumentDB não pôde recuperá-la. Para recuperar os dados, faça uma point-in-time restauração no horário restaurável mais recente da instância. |
| inaccessible-encryption-credentials | Não faturado | A AWS KMS chave usada para criptografar ou descriptografar a instância não pôde ser acessada. |
| incompatible-network | Não faturado | O Amazon DocumentDB está tentando executar uma ação de recuperação em uma instância, mas não consegue fazer isso porque a VPC está em um estado que impede a conclusão da ação. Este status pode ocorrer se, por exemplo, todos os endereços IP disponíveis em uma sub-rede estiverem em uso e o Amazon DocumentDB for incapaz de obter um endereço IP para a instância. |
| maintenance | Faturado | O Amazon DocumentDB está aplicando uma atualização de manutenção na instância de banco de dados. Este status é usado para a manutenção de nível de instância que o Amazon DocumentDB agenda com antecedência. Estamos avaliando maneiras de expor ações adicionais de manutenção para clientes com este status. |
| modifying | Faturado | A instância está sendo alterada devido a uma solicitação. |
| rebooting | Faturado | A instância está sendo reinicializada devido a uma solicitação ou a um processo do Amazon DocumentDB que exige a reinicialização da instância. |
| renaming | Faturado | A instância está sendo renomeada devido a uma solicitação. |
| resetting-master-credentials | Faturado | As credenciais principais da instância estão sendo redefinidas devido a uma solicitação. |
| restore-error | Faturado | A instância encontrou um erro ao tentar restaurar para um point-in-time ou a partir de um snapshot. |
| starting | Faturado para armazenamento | A instância está iniciando. |
| stopped | Faturado para armazenamento | A instância está interrompida. |
| stopping | Faturado para armazenamento | A instância está sendo interrompida. |
| storage-full | Faturado | A instância alcançou sua alocação de capacidade de armazenamento. Este é um status crítico e deve ser resolvido imediatamente. É necessário aumentar o armazenamento verticalmente modificando a instância. Defina CloudWatch os alarmes da Amazon para avisá-lo quando o espaço de armazenamento estiver ficando baixo, para que você não se depare com essa situação. |
## Monitorando o status da instância usando o Console de gerenciamento da AWS ou AWS CLI
Use o Console de gerenciamento da AWS ou AWS CLI para monitorar o status da sua instância.
------
#### [ Using the Console de gerenciamento da AWS ]
Ao usar o Console de gerenciamento da AWS para determinar o status de um cluster, use o procedimento a seguir.
1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)
1. No painel de navegação, escolha **Clusters**.
**nota**
Observe que, na caixa de navegação Clusters, a coluna **Identificador do cluster** mostra tanto os clusters quanto as instâncias. As instâncias estão listadas embaixo dos clusters, semelhante à captura de tela abaixo.
![\[Lista de clusters e instâncias na página Clusters no console do Amazon DocumentDB.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/clusters.png)
1. Encontre o nome da instância de seu interesse. Em seguida, para localizar o status da instância, leia essa linha para a coluna **Status**, como mostrado a seguir.
![\[Coluna Status, mostrando o status disponível para clusters e instâncias na página Clusters.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/instance-status.png)
------
#### [ Using the AWS CLI ]
Ao usar o AWS CLI para determinar o status de um cluster, use a `describe-db-instances` operação. O código a seguir verifica o status da instância `sample-cluster-instance-01`.
Para Linux, macOS ou Unix:
```
aws docdb describe-db-instances \
--db-instance-identifier sample-cluster-instance-01 \
--query 'DBInstances[*].[DBInstanceIdentifier,DBInstanceStatus]'
```
Para Windows:
```
aws docdb describe-db-instances ^
--db-instance-identifier sample-cluster-instance-01 ^
--query 'DBInstances[*].[DBInstanceIdentifier,DBInstanceStatus]'
```
A saída dessa operação é semelhante à seguinte.
```
[
[
"sample-cluster-instance-01",
"available"
]
]
```
------
## Status de integridade da instância
A tabela a seguir lista os valores possíveis do status de integridade das instâncias. A coluna **Integridade da instância**, localizada na tabela **Clusters** no Console de gerenciamento da AWS, mostra se o mecanismo de banco de dados, o componente responsável por armazenar, gerenciar e recuperar dados, está operando normalmente. Essa coluna também indica se a métrica `EngineUptime` do sistema, disponível em CloudWatch, está mostrando o status de saúde de cada instância.
| Status de integridade da instância | Description |
| --- | --- |
| integridade | O mecanismo de banco de dados está sendo executado na instância do Amazon DocumentDB. |
| não íntegro | O mecanismo de banco de dados não está funcionando ou foi reiniciado há menos de um minuto. |
## Monitorando o status de integridade da instância usando o Console de gerenciamento da AWS
Use o Console de gerenciamento da AWS para monitorar o status de saúde da sua instância.
Ao usar Console de gerenciamento da AWS, use as etapas a seguir para entender o status de integridade da instância.
1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)
1. No painel de navegação, escolha **Clusters**.
**nota**
Na caixa de navegação **Clusters**, a coluna **Identificador do cluster** mostra tanto os clusters quanto as instâncias. As instâncias estão listadas embaixo dos clusters, semelhante à captura de tela abaixo.
![\[Lista de clusters e instâncias na página Clusters no console do Amazon DocumentDB.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/clusters.png)
1. Encontre o nome da instância de seu interesse. Em seguida, para localizar o status da instância, leia essa linha cruzando com a coluna **Status**, como mostrado a seguir:
![\[Coluna Integridade da instância, mostrando os estados íntegros e não íntegros das instâncias listadas na página Clusters.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/health-status-1.png)
**nota**
A pesquisa do status de integridade da instância ocorre a cada 60 segundos e é baseada na métrica do CloudWatch `EngineUptime` sistema. Os valores na coluna **Integridade da instância** são atualizados automaticamente.
# Visualização das recomendações do Amazon DocumentDB
O Amazon DocumentDB fornece uma lista de recomendações automatizadas para recursos de banco de dados, como instâncias e clusters. Essas recomendações fornecem orientações de práticas recomendadas, analisando as configurações de seu cluster e instância.
Veja abaixo alguns exemplos dessas recomendações:
| Tipo | Descrição | Recomendação | Informações adicionais |
| --- | --- | --- | --- |
| Uma instância | O cluster contém apenas uma instância | Performance e disponibilidade: recomendamos adicionar outra instância com a mesma classe de instância em uma Zona de disponibilidade diferente. | A[lta disponibilidade e replicação do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/replication.html) |
O Amazon DocumentDB gera recomendações para um recurso quando esse recurso é criado ou modificado. O Amazon DocumentDB também verifica periodicamente seus recursos e gera recomendações.
**Para visualizar e seguir as recomendações do Amazon DocumentDB**
1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)
1. No painel de navegação, selecione **Recomendações**:
![\[Painel de navegação do console Amazon DocumentDB com a opção Recomendações selecionada.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/recommendations-nav-1.png)
1. Na caixa de diálogo **Recomendações**, expanda a seção de interesse e selecione a tarefa recomendada.
No exemplo abaixo, a tarefa recomendada se aplica a um cluster do Amazon DocumentDB com apenas uma instância. A recomendação é adicionar outra instância para melhorar o desempenho e a disponibilidade.
![\[O formulário Recomendações, mostrando uma tarefa recomendada selecionada para um cluster do Amazon DocumentDB.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/recommendations-1.png)
1. Clique em **Aplicar agora**.
Neste exemplo, a caixa de diálogo **Adicionar instâncias** é exibida:
![\[O formulário Adicionar instâncias, com opções para configurações de instância.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/add-instances-1.png)
1. Modifique as configurações da sua nova instância e clique em **Criar**.
# Usar assinaturas de eventos do Amazon DocumentDB
O Amazon DocumentDB usa o Amazon Simple Notification Service (Amazon SNS) para fornecer uma notificação quando um evento do Amazon DocumentDB ocorre. Essas notificações podem estar em qualquer formato compatível com o Amazon SNS para um Região da AWS, como um e-mail, uma mensagem de texto ou uma chamada para um endpoint HTTP.
O Amazon DocumentDB agrupa esses eventos em categorias nas quais é possível inscrever-se para receber notificações quando ocorre um evento dessa categoria. É possível assinar uma categoria de evento para uma instância, cluster, o snapshot, snapshot do cluster, ou para uma grupo de parâmetros. Por exemplo, se você se inscrever na categoria Backup para uma determinada instância, será notificado sempre que ocorrer um evento relacionado ao backup que afete a instância. Você também recebe uma notificação quando uma assinatura de evento é alterada.
Ocorrem eventos tanto no nível do cluster, quanto no nível da instância, portanto, é possível receber eventos assinar em um cluster ou uma instância.
Assinaturas de eventos são enviadas aos endereços que você fornece ao criar a assinatura. Pode ser interessante criar várias assinaturas diferentes, como uma assinatura para receber todas as notificações de eventos e outra que inclua somente eventos críticos para as suas instâncias de produção. É possível facilmente desativar a notificação sem excluir uma assinatura. Para fazer isso, defina o botão **Habilitado** como **Não** no console do Amazon DocumentDB.
**Importante**
O Amazon DocumentDB não garante a ordem dos eventos enviados em um fluxo de eventos. A ordem do evento está sujeita a alterações.
O Amazon DocumentDB usa o nome do recurso da Amazon (ARN) de um tópico do Amazon SNS para identificar cada assinatura. O console do Amazon DocumentDB cria o ARN para você quando você cria a assinatura.
O faturamento das assinaturas de eventos do Amazon DocumentDB é feito por meio do Amazon SNS. As taxas do Amazon SNS se aplicam durante o uso da notificação de eventos. Para obter mais informações, consulte Amazon Simple Notification Service Pricing. Além das cobranças do Amazon SNS, o Amazon DocumentDB não cobra por assinaturas de eventos.
**Topics**
+ [Assinar eventos](event-subscriptions.subscribe.md)
+ [Gerenciar assinaturas do](event-subscriptions.managing.md)
+ [Categorias e mensagens](event-subscriptions.categories-messages.md)
# Tornar-se assinante de eventos do Amazon DocumentDB
É possível usar o console do Amazon DocumentDB para se inscrever em assinaturas de eventos, da seguinte forma:
1. Faça login no Console de gerenciamento da AWS at[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb).
1. No painel de navegação, escolha **Assinaturas de eventos**.
![\[Painel de navegação do console do Amazon DocumentDB com a opção Assinaturas de eventos destacada.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/subscribe-event-subs.png)
1. No painel **Event subscriptions (Assinaturas de eventos)**, escolha **Create event subscription (Criar assinatura de evento)**.
![\[Painel Assinaturas de eventos, destacando o botão Criar assinatura de evento no canto superior direito.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/subscribe-create.png)
1. Na caixa de diálogo **Criar assinatura de evento** faça o seguinte:
+ Em **Name** (Nome), insira um nome para a assinatura de notificação de eventos.
![\[O formulário Criar assinatura de evento, mostrando a seção Detalhes e o campo de entrada Nome.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/subscribe-name.png)
+ Para **Destino**, escolha para onde você deseja enviar notificações. É possível escolher um **ARN** existente ou escolher **Novo tópico de e-mail** para inserir o nome de um tópico e uma lista de destinatários.
![\[A seção Destino, com opções para especificar para onde enviar notificações.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/subscribe-target.png)
+ Em **Origem**, escolha um tipo de origem. Dependendo do tipo de origem que você selecionou, escolha as categorias e origens de eventos para as quais quer receber notificações de eventos.
![\[A seção Origem, para selecionar um tipo de origem para receber notificações de eventos.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/subscribe-source.png)
+ Escolha **Criar**.
![\[A seção Origem com o botão Criar no canto inferior direito.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/subscribe-create-2.png)
# Gerenciar assinaturas de notificação de eventos do Amazon DocumentDB
Se você escolher **Assinaturas de eventos** no painel de navegação do console do Amazon DocumentDB, é possível visualizar categorias de assinatura e uma lista das suas assinaturas atuais. Você também pode modificar ou excluir uma assinatura específica.
## Para listar suas atuais assinaturas de notificações de eventos do Amazon DocumentDB
1. Faça login no Console de gerenciamento da AWS at[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb).
1. No painel de navegação, escolha **Event subscriptions (Assinaturas de eventos)**. O painel **Event subscriptions (Assinaturas de eventos)** exibirá todas as suas assinaturas de notificação de eventos.
![\[Painel de navegação do console do Amazon DocumentDB com a opção Assinaturas de eventos destacada.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/modify-event-subs.png)
1. No painel **Event subscriptions (Assinaturas de eventos)**, escolha a assinatura que deseja modificar e escolha **Edit (Editar)**.
![\[O painel Inscrições de eventos, mostrando uma assinatura selecionada e o botão Editar.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/modify-edit.png)
1. Faça as alterações na assinatura usando as seções **Destino** ou **Origem**. É possível adicionar ou remover identificadores de origem selecionando-os ou desmarcando-os na seção Fonte.
![\[O formulário Modificar assinatura de evento, destacando a seção Destino.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/modify-target.png)
1. Escolha **Modificar**. O console do Amazon DocumentDB indica que a assinatura está sendo modificada.
![\[O final do formulário Modificar assinatura de evento, com o botão Modificar destacado.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/modify-button.png)
## Como excluir uma assinatura de notificação de evento do Amazon DocumentDB
É possível excluir uma assinatura quando não precisar mais dela. Todos os assinantes do tópico não receberão mais notificações de evento especificadas pela assinatura.
1. Faça login no Console de gerenciamento da AWS at[https://console.aws.amazon.com/docdb](https://console.aws.amazon.com/docdb).
1. No painel de navegação, escolha **Assinaturas de eventos**.
![\[Painel de navegação do console do Amazon DocumentDB com a opção Assinaturas de eventos destacada.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/delete-event-subs.png)
1. No painel **Minhas assinaturas de eventos de banco de dados**, escolha a assinatura que deseja excluir.
![\[O ASsinaturas de eventos, mostrando uma assinatura selecionada.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/delete-select.png)
1. Escolha **Excluir**.
![\[O painel Assinaturas de eventos, destacando o botão Excluir.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/delete-delete.png)
1. Uma janela pop-up aparecerá perguntando se você deseja excluir permanentemente essa notificação. Escolha **Excluir**.
![\[Uma caixa de diálogo confirmando a exclusão da assinatura do evento com o botão Excluir destacado no canto inferior direito.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/event-subs/delete-delete-2.png)
# Categorias e mensagens de eventos do Amazon DocumentDB
O Amazon DocumentDB gera um número significativo de eventos em categorias nas quais é possível fazer uma assinatura usando o console. Cada categoria aplica-se a um tipo de origem, que pode ser uma instância, um cluster, um snapshot ou um grupo de parâmetros.
**nota**
O Amazon DocumentDB usa definições de eventos existentes do Amazon RDS e. IDs
## Eventos do Amazon DocumentDB originados de instâncias
| Categoria | Description |
| --- | --- |
| disponibilidade | A instância foi reiniciada. |
| disponibilidade | Desligamento da instância. |
| alteração de configuração | Como aplicar uma modificação à classe de instância. |
| alteração de configuração | Conclusão da aplicação de modificação à classe de instância. |
| alteração de configuração | Redefinir as credenciais principais. |
| criação | Instância criada. |
| exclusão | Instância excluída |
| falha | Houve falha na instância de banco de dados devido a uma configuração incompatível ou a um problema do armazenamento subjacente. Comece um point-in-time-restore para a instância. |
| notificação | A Instância foi interrompida. |
| notificação | A instância foi iniciada. |
| notificação | A instância está sendo iniciada porque excede o tempo máximo permitido para permanecer parada. |
| recuperação | A recuperação da instância começou. O tempo de recuperação variará dependendo da quantidade de dados a serem recuperados. |
| recuperação | A recuperação da instância está completa. |
| patches de segurança | A atualização do sistema operacional está disponível para a sua instância. Para obter informações sobre a aplicação de atualizações, consulte [Manutenção do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html). |
## Eventos do Amazon DocumentDB originados de um cluster
| Categoria | Description |
| --- | --- |
| criação | Cluster criado |
| exclusão | Cluster excluído. |
| failover | Como promover novamente a primária anterior. |
| failover | Failover concluído para a instância. |
| failover | Iniciou o failover para a instância de banco de dados: %s |
| failover | Iniciou o mesmo failover da AZ para a instância de banco de dados: %s |
| failover | Iniciou o failover cruzado da AZ para a instância de banco de dados: %s |
| manutenção | O cluster foi corrigido. |
| manutenção | O cluster do banco de dados está em um estado que não pode ser atualizado: %s |
| notificação | O cluster parou. |
| notificação | O cluster iniciou. |
| notificação | Falha na parada do cluster. |
| notificação | O cluster está sendo iniciado porque excede o tempo máximo permitido para permanecer parado. |
| notificação | Cluster renomeado de %s para %s. |
## Eventos do Amazon DocumentDB originados de um snapshot de cluster
AA tabela a seguir mostra a categoria de evento e uma lista de eventos quando um snapshot de cluster do Amazon DocumentDB é o tipo de origem.
| Categoria | Description |
| --- | --- |
| backup | Criação de um snapshot manual do cluster. |
| backup | Snapshot de cluster manual criado. |
| backup | Criando snapshot de cluster automatizado. |
| backup | Snapshot de cluster automatizado criado. |
## Eventos do Amazon DocumentDB originados de um grupo de parâmetros
A tabela a seguir mostra a categoria de evento e uma lista de eventos quando um parameter group é o tipo de origem.
| Categoria | Description |
| --- | --- |
| alteração de configuração | Parâmetro atualizado de %s para %s com o método de aplicação %s |
# Monitorando o Amazon DocumentDB com CloudWatch
O Amazon DocumentDB (com compatibilidade com o MongoDB) se integra à Amazon CloudWatch para que você possa reunir e analisar métricas operacionais para seus clusters. Você pode monitorar essas métricas usando o CloudWatch console, o console do Amazon DocumentDB, o AWS Command Line Interface (AWS CLI) ou a CloudWatch API.
CloudWatch também permite definir alarmes para que você possa ser notificado se um valor métrico ultrapassar um limite especificado por você. Você pode até mesmo configurar o Amazon CloudWatch Events para tomar medidas corretivas caso ocorra uma violação. Para obter mais informações sobre uso CloudWatch e alarmes, consulte a [ CloudWatch documentação da Amazon](https://docs.aws.amazon.com/cloudwatch/index.html).
**Topics**
+ [Métricas do Amazon DocumentDB](#cloud_watch-metrics_list)
+ [Visualizando CloudWatch dados](#cloud_watch-view_data)
+ [Dimensões do Amazon DocumentDB](#cloud_watch-metrics_dimensions)
+ [Monitorar as métricas do Opcounter](#cloud_watch-monitoring_opcounters)
+ [Monitorar conexões de banco de dados](#cloud_watch-monitoring_connections)
## Métricas do Amazon DocumentDB
Para monitorar a integridade e o desempenho do cluster e das instâncias do Amazon DocumentDB, é possível visualizar as seguintes métricas no console do Amazon DocumentDB.
**nota**
As métricas nas tabelas a seguir se aplicam tanto a clusters elásticos quanto baseados em instâncias.
**Topics**
+ [Métricas de utilização de recursos](#resource-utilization)
+ [Métricas de latência](#latency-metrics)
+ [NVMe- métricas de instância apoiadas](#nvme-metrics)
+ [Métricas operacionais](#operations-metrics)
+ [Métricas de throughput](#throughput-metrics)
+ [Métricas do sistema](#system-metrics)
+ [Métricas de instância T3](#t3-instance-metrics)
### Métricas de utilização de recursos
| Métrica | Description |
| --- | --- |
| BackupRetentionPeriodStorageUsed | A quantidade total de armazenamento de backup em bytes usada para dar suporte ao recurso de point-in-time restauração na janela de retenção do Amazon DocumentDB. Incluído no total relatado pela métrica TotalBackupStorageBilled. Calculado separadamente para cada cluster do Amazon DocumentDB. |
| ChangeStreamLogSize | A quantidade de armazenamento usada pelo cluster para armazenar o log do fluxo de alterações em megabytes. Esse valor é um subconjunto do armazenamento total do cluster (VolumeBytesUsed) e afeta o custo do cluster. Para obter informações sobre preço de armazenamento, consulte a [página de produto do Amazon DocumentDB](https://aws.amazon.com//documentdb/pricing). O tamanho do log do fluxo de alterações dependerá do número de alterações que ocorrerem no cluster e da duração da retenção do log do fluxo de alterações. Para obter mais informações sobre fluxos de alterações, consulte [Usar fluxos de alterações com o Amazon DocumentDB](change_streams.md). |
| CPUUtilization | O percentual de CPU usado por uma instância. |
| DatabaseConnections | O número de conexões (ativas e ociosas) abertas em uma instância tomada com uma frequência de 1 minuto. |
| DatabaseConnectionsMax | O número máximo de conexões de banco de dados abertas (ativas e ociosas) em uma instância em um período de 1 minuto. |
| DatabaseConnectionsLimit | O número máximo de conexões simultâneas de banco de dados (ativas e ociosas) permitidas em uma instância a qualquer momento. |
| DatabaseCursors | O número de cursores abertos em uma instância obtida com uma frequência de 1 minuto. |
| DatabaseCursorsMax | O número máximo de cursores abertos em uma instância em um período de 1 minuto. |
| DatabaseCursorsLimit | O número máximo de cursores permitidos em uma instância em um determinado momento. |
| DatabaseCursorsTimedOut | O número de cursores que atingiram o tempo limite em um período de 1 minuto. |
| FreeableMemory | A quantidade de memória de acesso aleatório disponível, em bytes. |
| FreeLocalStorage | Essa métrica informa a quantidade de armazenamento disponível para cada instância para tabelas temporárias e logs. Esse valor depende da classe da instância. É possível aumentar a quantidade de espaço de armazenamento gratuito de uma instância escolhendo uma classe de instância maior para ela. (Isso não se aplica ao DocumentDB Serverless.) |
| LowMemThrottleQueueDepth | A profundidade da fila para solicitações que são limitadas devido à pouca memória disponível obtida com uma frequência de 1 minuto. |
| LowMemThrottleMaxQueueDepth | A profundidade máxima da fila para solicitações que são limitadas devido à pouca memória disponível em um período de 1 minuto. |
| LowMemNumOperationsThrottled | O número de solicitações que são limitadas devido à pouca memória disponível em um período de 1 minuto. |
| SnapshotStorageUsed | A quantidade total de armazenamento de backup em bytes consumida por todos os snapshots de um determinado cluster do Amazon DocumentDB fora da janela de retenção de backup. Incluído no total relatado pela métrica TotalBackupStorageBilled. Calculado separadamente para cada cluster do Amazon DocumentDB. |
| SwapUsage | A quantidade de troca usada na instância. |
| TotalBackupStorageBilled | A quantidade total de armazenamento de backup em bytes para a qual você é cobrado para determinado cluster do Amazon DocumentDB. Inclui o armazenamento de backup medido pelas métricas BackupRetentionPeriodStorageUsed e SnapshotStorageUsed. Calculado separadamente para cada cluster do Amazon DocumentDB. |
| TransactionsOpen | O número de transações abertas em uma instância realizada com uma frequência de 1 minuto. |
| TransactionsOpenMax | O número máximo de transações abertas em uma instância em um período de 1 minuto. |
| TransactionsOpenLimit | O número máximo de transações simultâneas permitidas em uma instância em um determinado momento. |
| VolumeBytesUsed | A quantidade de armazenamento usada pelo cluster em bytes. Esse valor afeta o custo do cluster. Para obter informações sobre preço, consulte [a página do produto Amazon DocumentDB](https://aws.amazon.com//documentdb/pricing). |
### Métricas de latência
| Métrica | Description |
| --- | --- |
| DBClusterReplicaLagMaximum | A quantidade máxima de atraso, em milissegundos, entre a instância principal e cada instância do Amazon DocumentDB no cluster. |
| DBClusterReplicaLagMinimum | A quantidade mínima de atraso, em milissegundos, entre a instância principal e cada instância de réplica no cluster. |
| DBInstanceReplicaLag | O tempo de atraso, em milissegundos, ao replicar atualizações da instância principal para uma instância de réplica. |
| ReadLatency | O tempo médio gasto por I/O operação de disco. |
| WriteLatency | O tempo médio, em milissegundos, gasto por I/O operação de disco. |
### NVMe- métricas de instância apoiadas
| Métrica | Description |
| --- | --- |
| NVMeStorageCacheHitRatio | O percentual de solicitações atendidas pelo cache hierárquico. |
| FreeNVMeStorage | A quantidade de armazenamento efêmero NVMe disponível. |
| ReadIOPSNVMeStorage | O número médio de I/O operações de leitura de disco para armazenamento NVMe efêmero. |
| ReadLatencyNVMeStorage | O tempo médio gasto por I/O operação de leitura de disco para armazenamento temporário NVMe . |
| ReadThroughputNVMeStorage | O número médio de bytes lidos do disco por segundo para armazenamento temporário NVMe . |
| WriteIOPSNVMeStorage | O número médio de I/O operações de gravação em disco no armazenamento NVMe efêmero. |
| WriteLatencyNVMeStorage | O tempo médio gasto por I/O operação de gravação em disco para armazenamento temporário NVMe . |
| WriteThroughputNVMeStorage | O número médio de bytes gravados em disco por segundo para armazenamento temporário NVMe . |
### Métricas operacionais
| Métrica | Description |
| --- | --- |
| DocumentsDeleted | O número de documentos excluídos em um período de 1 minuto. |
| DocumentsInserted | O número de documentos inseridos em um período de 1 minuto. |
| DocumentsReturned | O número de documentos devolvidos em um período de 1 minuto. |
| DocumentsUpdated | O número de documentos atualizados em um período de 1 minuto. |
| OpcountersCommand | O número de comandos emitidos em um período de 1 minuto. |
| OpcountersDelete | O número de operações de exclusão emitidas em um período de 1 minuto. |
| OpcountersGetmore | O número de getmores emitidos em um período de 1 minuto. |
| OpcountersInsert | O número de operações de inserção emitidas em um período de 1 minuto. |
| OpcountersQuery | O número de consultas emitidas em um período de 1 minuto. |
| OpcountersUpdate | O número de operações de atualização emitidas em um período de 1 minuto. |
| TransactionsStarted | O número de transações iniciadas em uma instância em um período de 1 minuto. |
| TransactionsCommitted | O número de transações confirmadas em uma instância em um período de 1 minuto. |
| TransactionsAborted | O número de transações abortadas em uma instância em um período de 1 minuto. |
| TTLDeletedDocuments | O número de documentos excluídos por um TTLMonitor em um período de 1 minuto. |
### Métricas de throughput
| Métrica | Description |
| --- | --- |
| NetworkReceiveThroughput | A quantidade de throughput de rede, em bytes por segundo, recebida dos clientes por cada instância no cluster. Essa throughput não inclui o tráfego de rede entre instâncias no cluster e o volume do cluster. |
| NetworkThroughput | A quantidade de throughput de rede, em bytes por segundo, recebida e transmitida aos clientes por cada instância no cluster do Amazon DocumentDB. Essa throughput não inclui o tráfego de rede entre instâncias no cluster e o volume do cluster. |
| NetworkTransmitThroughput | A quantidade de throughput de rede, em bytes por segundo, enviada aos clientes por cada instância no cluster. Essa throughput não inclui o tráfego de rede entre instâncias no cluster e o volume do cluster. |
| ReadIOPS | O número médio de I/O operações de leitura de disco por segundo. O Amazon DocumentDB relata as IOPS de leitura e gravação separadamente em intervalos de 1 minuto. |
| ReadThroughput | O número médio de bytes lidos do disco por segundo. |
| StorageNetworkReceiveThroughput | O throughput de rede, em bytes por segundo, recebido do volume de armazenamento do cluster do Amazon DocumentDB por cada instância no cluster. |
| StorageNetworkTransmitThroughput | O throughput de rede, em bytes por segundo, enviado ao volume de armazenamento do cluster do Amazon DocumentDB por cada instância no cluster. |
| StorageNetworkThroughput | O throughput de rede, em bytes por segundo, recebido e transmitido ao volume de armazenamento do cluster do Amazon DocumentDB por cada instância no cluster do Amazon DocumentDB. |
| VolumeReadIOPs | O número médio de I/O operações de leitura cobradas de um volume de cluster, relatado em intervalos de 5 minutos. As operações de leitura faturadas são calculadas no nível de volume do cluster, agregadas a partir de todas as instâncias no cluster de banco de dados e posteriormente relatadas em intervalos de 5 minutos. O valor é calculado tomando o valor da métrica de operações de leitura em um período de 5 minutos. É possível determinar a quantidade de operações de leitura faturadas por segundo, tomando o valor da métrica de operações de leitura faturadas e dividindo por 300 segundos. Por exemplo, se `VolumeReadIOPs` retorna 13.686, então as operações de leitura cobradas por segundo são 45 (13.686/300 = 45,62). Você acumula operações de leitura faturadas para consultas que solicitam páginas de banco de dados que não estão presentes no cache do buffer e, portanto, devem ser carregadas a partir do armazenamento. É possível perceber picos em operações de leitura faturadas, pois os resultados da consulta são lidos a partir do armazenamento e depois são carregados no cache do buffer. |
| VolumeWriteIOPs | O número médio de I/O operações de gravação cobradas de um volume de cluster, relatado em intervalos de 5 minutos. As operações de gravação faturadas são calculadas no nível de volume do cluster, agregadas a partir de todas as instâncias no cluster e posteriormente relatadas em intervalos de 5 minutos. O valor é calculado tomando o valor da métrica de operações de leitura em um período de 5 minutos. É possível determinar a quantidade de operações de gravação faturadas por segundo, tomando o valor da métrica de operações de gravação faturadas e dividindo por 300 segundos. Por exemplo, se `VolumeWriteIOPs` retorna 13.686, então as operações de leitura cobradas por segundo são 45 (13.686/300 = 45,62). Observe que `VolumeReadIOPs` as `VolumeWriteIOPs` métricas são calculadas pela camada de armazenamento do DocumentDB e incluem as IOs executadas pelas instâncias primária e de réplica. Os dados são agregados a cada 20-30 minutos e depois reportados em intervalos de 5 minutos, emitindo assim o mesmo ponto de dados para a métrica no período de tempo. Se você estiver procurando por uma métrica para correlacionar com suas operações de inserção em um intervalo de 1 minuto, é possível usar a métrica WriteIOps em nível de instância. A métrica está disponível na guia de monitoramento da sua instância primária do Amazon DocumentDB. |
| WriteIOPS | O número médio de I/O operações de gravação em disco por segundo. Quando usados em nível de cluster, WriteIOPs são avaliados em todas as instâncias do cluster. As IOPS de leitura e gravação são relatadas separadamente, em intervalos de um minuto. |
| WriteThroughput | O número médio de bytes gravados no disco por segundo. |
### Métricas do sistema
| Métrica | Description |
| --- | --- |
| AvailableMVCCIds | Um contador que mostra o número de operações de gravação restantes disponíveis antes de chegar a zero. Quando esse contador chegar a zero, seu cluster entrará no modo somente leitura até IDs ser recuperado e reciclado. O contador diminui a cada operação de gravação e aumenta à medida que a coleta de lixo recicla o MVCC antigo. IDs |
| BufferCacheHitRatio | O percentual de solicitações atendidas pelo cache de buffer. |
| DiskQueueDepth | O número de I/O operações que estão aguardando para serem gravadas ou lidas do disco. |
| EngineUptime | A quantidade de tempo, em segundos, em que a instância está executando. |
| IndexBufferCacheHitRatio | O percentual de solicitações de índice atendidas pelo cache de buffer. É possível ver um aumento maior que 100 por cento na métrica logo após eliminar um índice, uma coleção ou um banco de dados. Isto será corrigido automaticamente após 60 segundos. Essa limitação será corrigida em uma atualização de patch futura. |
| LongestActiveGCRuntime | Duração em segundos do processo de coleta de resíduos ativo mais longo. Atualiza a cada minuto e rastreia somente as operações ativas, excluindo os processos concluídos dentro da janela de um minuto. |
### Métricas de instância T3
| Métrica | Description |
| --- | --- |
| CPUCreditUsage | O número de créditos de CPU gastos durante o período de medição. |
| CPUCreditBalance | O número de créditos de CPU que uma instância acumulou. Esse saldo é esgotado quando a CPU apresenta expansões e os créditos de CPU são gastos com mais rapidez do que são ganhos. |
| CPUSurplusCreditBalance | O número de créditos de CPU excedentes gastos para manter o desempenho da CPU quando o valor do CPUCredit saldo é zero. |
| CPUSurplusCreditsCharged | O número de créditos de CPU excedentes que ultrapassam o número máximo de créditos de CPU que podem ser ganhos em um período de 24 horas, resultando em uma cobrança adicional. Para obter mais informações, consulte [ Monitoring your CPU credits](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-monitoring-cpu-credits.html). |
## Visualizando CloudWatch dados
Você pode visualizar CloudWatch os dados da Amazon usando o CloudWatch console, o console do Amazon DocumentDB, AWS Command Line Interface (AWS CLI) ou a CloudWatch API.
------
#### [ Using the Console de gerenciamento da AWS ]
Para visualizar CloudWatch métricas usando o console de gerenciamento do Amazon DocumentDB, conclua as etapas a seguir.
1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)
1. No painel de navegação, escolha **Clusters**.
**dica**
Caso não visualize o painel de navegação à esquerda da tela, selecione o ícone do menu (![\[Hamburger menu icon with three horizontal lines.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/docdb-menu-icon.png)) no canto superior esquerdo da página.
1. Na caixa de navegação Clusters, você verá a coluna **Identificador do Cluster**. Suas instâncias estão listadas em clusters, semelhante ao snapshot abaixo.
![\[Tabela de clusters mostrando como uma instância está aninhada sob um cluster.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/choose-clusters.png)
1. Na lista de instâncias, escolha o nome da instância para a qual você deseja métricas.
1. Na página de resumo da instância resultante, escolha a guia **Monitoramento** para visualizar representações gráficas das métricas da sua instância do Amazon DocumentDB. Como um gráfico deve ser gerado para cada métrica, pode levar alguns minutos para que os **CloudWatch**gráficos sejam preenchidos.
A imagem a seguir mostra as representações gráficas de duas CloudWatch métricas no console do Amazon DocumentDB e. `WriteIOPS` `ReadIOPS`
![\[Gráficos de duas linhas representando as métricas WriteIops e CloudWatch ReadIOps no console do Amazon DocumentDB.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/cw-metrics-con.png)
------
#### [ Using the CloudWatch Management Console ]
Para visualizar CloudWatch métricas usando o CloudWatch Management Console, conclua as etapas a seguir.
1. Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em. [https://console.aws.amazon.com/cloudwatch](https://console.aws.amazon.com/cloudwatch)
1. No painel de navegação, selecione **Métricas**. Em seguida, na lista de nomes de serviços, escolha **DocDB**.
1. Escolha uma dimensão de métrica (por exemplo, **Métricas de cluster**).
1. A guia **Todas as métricas** exibe todas as métricas dessa dimensão no **DocDB**.
1. Para classificar a tabela, use o cabeçalho da coluna.
1. Para criar um gráfico de uma métrica, marque a caixa de seleção ao lado da métrica. Para selecionar todas as métricas, marque a caixa de seleção na linha de cabeçalho da tabela.
1. Para filtrar por métrica, passe o mouse sobre o nome da métrica e selecione a seta suspensa ao lado do nome da métrica. Em seguida, escolha **Adicionar para pesquisar**, conforme mostrado na imagem abaixo.
![\[A guia Todas as métricas lista as métricas, com uma lista suspensa aparecendo com o nome de uma métrica.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/cloudwatch-filter-metrics.png)
------
#### [ Using the AWS CLI ]
Para visualizar CloudWatch dados do Amazon DocumentDB, use a CloudWatch `get-metric-statistics` operação com os seguintes parâmetros.
**Parâmetros**
+ **--namespace** — Obrigatório. O namespace de serviço cujas métricas do CloudWatch você deseja ver. Para o Amazon DocumentDB, isto deve ser. `AWS/DocDB`
+ **--metric-name** — Obrigatório. O nome da métrica cujos dados você deseja dados.
+ **--start-time** — Obrigatório. O timestamp que determina o primeiro ponto de dados a ser retornado.
O valor especificado é inclusivo; os resultados incluem pontos de dados com o timestamp especificado. O timestamp deve estar no formato ISO 8601 UTC (por exemplo, 2016-10-03T23:00:00Z).
+ **--end-time** — Obrigatório. O timestamp que determina o último ponto de dados a ser retornado.
O valor especificado é inclusivo; os resultados incluem pontos de dados com o timestamp especificado. O timestamp deve estar no formato ISO 8601 UTC (por exemplo, 2016-10-03T23:00:00Z).
+ **--period** — Obrigatório. A granularidade, em segundos, dos pontos de dados retornados. Para métricas com resolução regular, um período pode ser tão curto quanto um minuto (60 segundos) e deve ser um múltiplo de 60. Para métricas de alta resolução coletadas em intervalos menores que um minuto, o período pode ser 1, 5, 10, 30, 60 ou qualquer múltiplo de 60.
+ **--dimensions** — Opcional. Se a métrica contiver várias dimensões, você deverá incluir um valor para cada dimensão. CloudWatch trata cada combinação exclusiva de dimensões como uma métrica separada. Se uma combinação específica de dimensões não foi publicada, você não poderá recuperar estatísticas para ela. É necessário especificar as mesmas dimensões usadas ao criar as métricas.
+ **--statistics** — Opcional. As estatísticas da métrica, além do percentil. Para estatísticas de percentil, use `ExtendedStatistics`. Ao chamar `GetMetricStatistics`, você deve especificar `Statistics` ou `ExtendedStatistics`, mas não ambos.
**Valores permitidos:**
+ `SampleCount`
+ `Average`
+ `Sum`
+ `Minimum`
+ `Maximum`
+ **--extended-statistics** — Opcional. As estatísticas de `percentile`. Especifique os valores entre p0.0 e p100. Ao chamar `GetMetricStatistics`, você deve especificar `Statistics` ou `ExtendedStatistics`, mas não ambos.
+ **--unit** — Opcional. A unidade para uma determinada métrica. As métricas podem ser relatadas em várias unidades. Não fornecer uma unidade resulta em todas as unidades sendo retornadas. Se você especificar apenas uma unidade que a métrica não reporta, os resultados da chamada serão nulos.
**Possíveis valores:**
+ `Seconds`
+ `Microseconds`
+ `Milliseconds`
+ `Bytes`
+ `Kilobytes`
+ `Megabytes`
+ `Gigabytes`
+ `Terabytes`
+ `Bits`
+ `Kilobytes`
+ `Megabits`
+ `Gigabits`
+ `Terabits`
+ `Percent`
+ `Count`
+ `Bytes/Second`
+ `Kilobytes/Second`
+ `Megabytes/Second`
+ `Gigabytes/Second`
+ `Terabytes/Second`
+ `Bits/Second`
+ `Kilobits/Second`
+ `Megabits/Second`
+ `Gigabits/Second`
+ `Terabits/Second`
+ `Count/Second`
+ `None`
**Example**
O exemplo a seguir localiza o `CPUUtilization` máximo para um período de 2 horas, tirando uma amostra a cada 60 segundos.
Para Linux, macOS ou Unix:
```
aws cloudwatch get-metric-statistics \
--namespace AWS/DocDB \
--dimensions \
Name=DBInstanceIdentifier,Value=docdb-2019-01-09-23-55-38 \
--metric-name CPUUtilization \
--start-time 2019-02-11T05:00:00Z \
--end-time 2019-02-11T07:00:00Z \
--period 60 \
--statistics Maximum
```
Para Windows:
```
aws cloudwatch get-metric-statistics ^
--namespace AWS/DocDB ^
--dimensions ^
Name=DBInstanceIdentifier,Value=docdb-2019-01-09-23-55-38 ^
--metric-name CPUUtilization ^
--start-time 2019-02-11T05:00:00Z ^
--end-time 2019-02-11T07:00:00Z ^
--period 60 ^
--statistics Maximum
```
A saída dessa operação é semelhante à seguinte.
```
{
"Label": "CPUUtilization",
"Datapoints": [
{
"Unit": "Percent",
"Maximum": 4.49152542374361,
"Timestamp": "2019-02-11T05:51:00Z"
},
{
"Unit": "Percent",
"Maximum": 4.25000000000485,
"Timestamp": "2019-02-11T06:44:00Z"
},
********* some output omitted for brevity *********
{
"Unit": "Percent",
"Maximum": 4.33333333331878,
"Timestamp": "2019-02-11T06:07:00Z"
}
]
}
```
------
## Dimensões do Amazon DocumentDB
As métricas para o Amazon DocumentDB são qualificadas de acordo com os valores de conta ou operação. Você pode usar o CloudWatch console para recuperar dados do Amazon DocumentDB filtrados por qualquer uma das dimensões na tabela a seguir.
| Dimensão | Description |
| --- | --- |
| DBClusterIdentifier | Filtra os dados solicitados para um cluster específico do Amazon DocumentDB. |
| DBClusterIdentifier, Role | Filtra os dados solicitados por você para um cluster específico do Amazon DocumentDB, agregando a métrica por função de instância (WRITER/READER). Por exemplo, é possível agregar métricas para todas as instâncias de READER que pertençam a um cluster. |
| DBInstanceIdentifier | Filtra os dados solicitados para uma instância de banco de dados específica. |
## Monitorar as métricas do Opcounter
Métricas do Opcounter têm um valor diferente de zero (geralmente \$1 50) para clusters ociosos. Isto ocorre porque o Amazon DocumentDB realiza verificações de saúde periódicas, operações internas e tarefas de coleta de métricas.
## Monitorar conexões de banco de dados
Quando você visualiza o número de conexões usando comandos do mecanismo de banco de dados`db.runCommand( { serverStatus: 1 })`, como, você pode ver até 10 conexões a mais do que você vê em `DatabaseConnections` CloudWatch. Isto ocorre porque o Amazon DocumentDB realiza verificações de integridade periódicas e tarefas de coleta de métricas que não são contabilizadas no `DatabaseConnections`. `DatabaseConnections` representa apenas conexões iniciadas pelo cliente.
# Log de chamadas de API do Amazon DocumentDB com o AWS CloudTrail
O Amazon DocumentDB (compatível com MongoDB) é integrado ao AWS CloudTrail, um serviço que fornece um registro das ações realizadas por usuários, por funções ou por um serviço da AWS no Amazon DocumentDB (compatível com MongoDB). O CloudTrail captura todas as chamadas de API AWS CLI para o Amazon DocumentDB como eventos, inclusive as chamadas do Amazon DocumentDB e de chamadas de código para o SDK do Amazon DocumentDB. Se você criar uma trilha, poderá habilitar a entrega contínua de eventos do CloudTrail para um bucket do Amazon S3, incluindo eventos para o Amazon DocumentDB. Se você não configurar uma trilha, ainda poderá visualizar os eventos mais recentes no console do CloudTrail em **Histórico de eventos**. Ao usar as informações coletadas pelo CloudTrail, é possível determinar a solicitação que foi feita ao Amazon DocumentDB (compatível com MongoDB), o endereço IP do qual a solicitação foi feita, quem a fez e quando ela foi feita, além de outros detalhes.
**Importante**
Para alguns recursos de gerenciamento, o Amazon DocumentDB usa a tecnologia operacional que é compartilhada com o Amazon Relational Database Service (Amazon RDS). O console Amazon DocumentDB, AWS CLI e chamadas de API são registradas como chamadas feitas para a API do Amazon RDS.
Para saber mais sobre o AWS CloudTrail, consulte o [Guia do usuário do AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/).
## Informações sobre o Amazon DocumentDB no CloudTrail
O CloudTrail é habilitado em sua Conta da AWS quando ela é criada. Quando ocorre uma atividade no Amazon DocumentDB (compatível com MongoDB), essa atividade é registrada em um evento do CloudTrail junto com outros eventos de serviço da AWS no **Histórico de eventos**. É possível visualizar, pesquisar e baixar eventos recentes em sua Conta da AWS. Para obter mais informações, consulte [Visualizar eventos com o histórico de eventos do CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html).
Para ter um registro contínuo dos eventos na sua Conta da AWS, incluindo eventos do Amazon DocumentDB (compatível com MongoDB) crie uma trilha. Uma trilha permite que o CloudTrail entregue arquivos de log a um bucket do Amazon S3. Por padrão, quando você cria uma trilha no console, ela é aplicada a todas as Regiões da AWS. A trilha registra eventos de todas as regiões na partição da AWS e entrega os arquivos de log no bucket do Amazon S3 que você especifica. Além disso, você pode configurar outros produtos da AWS para analisar mais profundamente e agir sobre os dados de eventos coletados nos logs do CloudTrail. Para obter mais informações, consulte os seguintes tópicos no *Manual do usuário do AWS CloudTrail*:
+ [Visão Geral para Criar uma Trilha](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html)
+ [Serviços e integrações com suporte no CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-aws-service-specific-topics.html#cloudtrail-aws-service-specific-topics-integrations)
+ [Configurando Notificações Amazon SNS para CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/configure-sns-notifications-for-cloudtrail.html)
+ [Recebimento de arquivos de log do CloudTrail de várias regiões](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html)
+ [Recebimento de arquivos de log do CloudTrail de várias contas](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html)
Cada entrada de log ou evento inclui informações sobre quem gerou a solicitação. As informações de identidade ajudam a determinar o seguinte:
+ Se a solicitação foi feita com credenciais de usuário da raiz ou do .
+ Se a solicitação foi feita com credenciais de segurança temporárias de uma função ou de um usuário federado.
+ Se a solicitação foi feita por outro AWS serviço.
Para mais informações, consulte [Elemento userIdentity CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html).
# Definir o perfil das operações do Amazon DocumentDB
É possível usar o criador de perfil no Amazon DocumentDB (compativel com MongoDB) para registrar o tempo de execução e os detalhes das operações que foram realizadas no seu cluster. O criador de perfil é útil para monitorar as operações mais lentas em seu cluster para ajudar você a melhorar o desempenho de consultas individuais e o desempenho geral do cluster.
Por padrão, o recurso profiler está desabilitado. Quando ativado, o criador de perfil registra operações que estão demorando mais do que um valor limite definido pelo cliente (por exemplo, 100 ms) no Amazon Logs. CloudWatch Os detalhes registrados incluem o comando perfilado, a hora, o resumo do plano e os metadados do cliente. Depois que as operações forem registradas no CloudWatch Logs, você poderá usar o CloudWatch Logs Insights para analisar, monitorar e arquivar seus dados de perfil do Amazon DocumentDB. Consultas comuns são fornecidas na seção [Consultas comuns](#profiling.common-queries).
Quando habilitado, o profiler usa recursos adicionais em seu cluster. Recomendamos começar com um valor limite alto (por exemplo, 500 ms) e diminuí-lo gradualmente para identificar as operações lentas. Começar com um valor limite de 50 ms pode causar problemas de desempenho no cluster para aplicações de alto throughput. O profiler é habilitado no nível do cluster e funciona em todas as instâncias e bancos de dados em um cluster. O Amazon DocumentDB registra as operações no Amazon CloudWatch Logs com base no melhor esforço.
Embora o Amazon DocumentDB não imponha nenhuma cobrança adicional para habilitar o criador de perfil, você paga as taxas padrão pelo uso de registros. CloudWatch Para obter informações sobre CloudWatch os preços do Logs, consulte os [ CloudWatch preços da Amazon](https://aws.amazon.com/cloudwatch/pricing/).
**Topics**
+ [Operações compatíveis](#profiling.supported-commands)
+ [Limitações](#profiling.limitations)
+ [Ativar o profiler](#profiling.enable-profiling)
+ [Desativar o profiler](#profiling.disable-profiling)
+ [Desativar a exportação de logs do profiler](#profiling.disabling-logs-export)
+ [Acessar seus logs do profiler](#profiling.accessing)
+ [Consultas comuns](#profiling.common-queries)
## Operações compatíveis
O profiler do Amazon DocumentDB suporta as seguintes operações:
+ `aggregate`
+ `count`
+ `delete`
+ `distinct`
+ `find` (OP\$1QUERY e comando)
+ `findAndModify`
+ `insert`
+ `update`
## Limitações
O criador de perfil de consulta lenta só poderá emitir registros do criador de perfil se todo o conjunto de resultados da consulta couber em um lote e se o conjunto de resultados estiver abaixo de 16 MB (tamanho máximo do BSON). Conjuntos de resultados maiores que 16 MB são divididos automaticamente em vários lotes.
A maioria dos drivers ou shells pode definir um tamanho de lote padrão que seja pequeno. Você pode especificar o tamanho do lote como parte da sua consulta. Com o objetivo de capturar registros de consultas lentos, recomendamos um tamanho de lote que exceda o tamanho do conjunto de resultados esperado. Se você não tiver certeza do tamanho do conjunto de resultados ou se ele variar, você também pode definir o tamanho do lote para um número grande (por exemplo, 100k).
No entanto, usar um lote maior significa que mais resultados precisarão ser recuperados do banco de dados antes que uma resposta seja enviada ao cliente. Para algumas consultas, isso pode criar maiores atrasos antes de você obter resultados. Se você não planeja consumir todo o conjunto de resultados, é possível que gaste mais I/Os para processar a consulta e descartar o resultado.
## Ativar o profiler do Amazon DocumentDB
A habilitação do profiler em um cluster é um processo de três etapas. Certifique-se de que todas as etapas foram concluídas, ou os registros de criação de perfil não serão enviados para o CloudWatch Logs. O profiler é definido no nível do cluster e executado em todos os bancos de dados e instâncias do cluster.
**Como habilitar o profiler em um cluster**
1. Como você não pode modificar um grupo de parâmetros de cluster padrão, verifique se tem um grupo de parâmetros de cluster personalizado disponível. Para obter mais informações, consulte [Criando grupos de parâmetros de cluster do Amazon DocumentDB](cluster_parameter_groups-create.md).
1. Ao usar um grupo de parâmetros de cluster personalizado disponível, modifique os seguintes parâmetros: `profiler`, `profiler_threshold_ms` e `profiler_sampling_rate`. Para obter mais informações, consulte [Modificando grupos de parâmetros de cluster do Amazon DocumentDB](cluster_parameter_groups-modify.md).
1. Crie ou modifique seu cluster para usar o grupo de parâmetros de cluster personalizado e para permitir a exportação de `profiler` CloudWatch registros para Logs.
As seções a seguir mostram como implementar essas etapas usando o Console de gerenciamento da AWS e o AWS Command Line Interface (AWS CLI).
------
#### [ Using the Console de gerenciamento da AWS ]
1. Antes de começar, crie um cluster do Amazon DocumentDB e um grupo de parâmetros de cluster personalizado se você ainda não tiver um. Para obter mais informações, consulte [Criando grupos de parâmetros de cluster do Amazon DocumentDB](cluster_parameter_groups-create.md) e [Criar um cluster do Amazon DocumentDB](db-cluster-create.md).
1. Ao usar um grupo de parâmetros de cluster personalizado disponível, modifique os seguintes parâmetros. Para obter mais informações, consulte [Modificando grupos de parâmetros de cluster do Amazon DocumentDB](cluster_parameter_groups-modify.md).
+ `profiler` - Habilita ou desabilita a criação de perfis de consulta. Os valores permitidos são `enabled ` e `disabled`. O valor padrão é `disabled`. Para habilitar a criação de perfis, defina o valor como `enabled`.
+ `profiler_threshold_ms`— Quando `profiler` está definido como`enabled`, todos os comandos que estão demorando mais do que ` profiler_threshold_ms` estão registrados. CloudWatch Os valores permitidos são `[50-INT_MAX]`. O valor padrão é `100`.
+ `profiler_sampling_rate` - a parcela das operações lentas que devem ser perfiladas ou registradas em log. Os valores permitidos são `[0.0-1.0]`. O valor padrão é `1.0`.
1. Modifique seu cluster para usar o grupo de parâmetros de cluster personalizado e defina as exportações de log do profiler para publicação na Amazon CloudWatch.
1. No painel de navegação, escolha **Clusters** para adicionar o grupo de parâmetros personalizado a um cluster.
1. Selecione o botão à esquerda do nome do cluster que deseja associar ao grupo de parâmetros. Selecione **Actions** e **Modify** para modificar seu cluster.
1. Em **Cluster options**, escolha o grupo de parâmetros personalizado na etapa acima para adicioná-lo ao cluster.
1. Em **Exportações de registros**, selecione **Registros do Profiler** para publicar na Amazon CloudWatch.
1. Escolha **Continue ** para exibir um resumo das modificações.
1. Depois de verificar suas alterações, é possível aplicá-las imediatamente ou durante a próxima janela de manutenção em **Scheduling of modifications**.
1. Escolha **Modify cluster ** para atualizar seu cluster com o novo grupo de parâmetros.
------
#### [ Using the AWS CLI ]
O procedimento a seguir habilita o profiler em todas as operações compatíveis para o cluster `sample-cluster`.
1. Antes de começar, verifique se você tem um grupo de parâmetros de cluster personalizado disponível executando o seguinte comando e revisando a saída de um grupo de parâmetros de cluster que não tem `default` no nome e tem `docdb3.6` como família do grupo de parâmetros. Se você não tiver um grupo de parâmetros de cluster não padrão, consulte [Criando grupos de parâmetros de cluster do Amazon DocumentDB](cluster_parameter_groups-create.md).
```
aws docdb describe-db-cluster-parameter-groups \
--query 'DBClusterParameterGroups[*].[DBClusterParameterGroupName,DBParameterGroupFamily]'
```
Na saída a seguir, somente `sample-parameter-group ` atende ambos os critérios.
```
[
[
"default.docdb3.6",
"docdb3.6"
],
[
"sample-parameter-group",
"docdb3.6"
]
]
```
1. Usando seu grupo de parâmetros de cluster personalizado, modifique os seguintes parâmetros:
+ `profiler` - Habilita ou desabilita a criação de perfis de consulta. Os valores permitidos são `enabled ` e `disabled`. O valor padrão é `disabled`. Para habilitar a criação de perfis, defina o valor como `enabled`.
+ `profiler_threshold_ms`— Quando `profiler` está definido como`enabled`, todos os comandos `profiler_threshold_ms` demoram mais do que os CloudWatch registrados. Os valores permitidos são `[50-INT_MAX]`. O valor padrão é `100`.
+ `profiler_sampling_rate` - a parcela das operações lentas que devem ser perfiladas ou registradas em log. Os valores permitidos são `[0.0-1.0]`. O valor padrão é `1.0`.
```
aws docdb modify-db-cluster-parameter-group \
--db-cluster-parameter-group-name sample-parameter-group \
--parameters ParameterName=profiler,ParameterValue=enabled,ApplyMethod=immediate \
ParameterName=profiler_threshold_ms,ParameterValue=100,ApplyMethod=immediate \
ParameterName=profiler_sampling_rate,ParameterValue=0.5,ApplyMethod=immediate
```
1. Modifique o cluster do Amazon DocumentDB para que ele use o grupo de parâmetro de cluster personalizado `sample-parameter-group` da etapa anterior e defina o parâmetro `--enable-cloudwatch-logs-exports` como `profiler`.
O código a seguir modifica o cluster `sample-cluster` para usar o `sample-parameter-group` da etapa anterior e é adicionado `profiler` às exportações de CloudWatch registros ativadas.
```
aws docdb modify-db-cluster \
--db-cluster-identifier sample-cluster \
--db-cluster-parameter-group-name sample-parameter-group \
--cloudwatch-logs-export-configuration '{"EnableLogTypes":["profiler"]}'
```
A saída dessa operação é semelhante à seguinte.
```
{
"DBCluster": {
"AvailabilityZones": [
"us-east-1c",
"us-east-1b",
"us-east-1a"
],
"BackupRetentionPeriod": 1,
"DBClusterIdentifier": "sample-cluster",
"DBClusterParameterGroup": "sample-parameter-group",
"DBSubnetGroup": "default",
"Status": "available",
"EarliestRestorableTime": "2020-04-07T02:05:12.479Z",
"Endpoint": "sample-cluster.node.us-east-1.docdb.amazonaws.com",
"ReaderEndpoint": "sample-cluster.node.us-east-1.docdb.amazonaws.com",
"MultiAZ": false,
"Engine": "docdb",
"EngineVersion": "3.6.0",
"LatestRestorableTime": "2020-04-08T22:08:59.317Z",
"Port": 27017,
"MasterUsername": "test",
"PreferredBackupWindow": "02:00-02:30",
"PreferredMaintenanceWindow": "tue:09:50-tue:10:20",
"DBClusterMembers": [
{
"DBInstanceIdentifier": "sample-instance-1",
"IsClusterWriter": true,
"DBClusterParameterGroupStatus": "in-sync",
"PromotionTier": 1
},
{
"DBInstanceIdentifier": "sample-instance-2",
"IsClusterWriter": true,
"DBClusterParameterGroupStatus": "in-sync",
"PromotionTier": 1
}
],
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-abcd0123",
"Status": "active"
}
],
"HostedZoneId": "ABCDEFGHIJKLM",
"StorageEncrypted": true,
"KmsKeyId": "arn:aws:kms:us-east-1::key/sample-key",
"DbClusterResourceId": "cluster-ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"DBClusterArn": "arn:aws:rds:us-east-1::cluster:sample-cluster",
"AssociatedRoles": [],
"ClusterCreateTime": "2020-01-10T22:13:38.261Z",
"EnabledCloudwatchLogsExports": [
"profiler"
],
"DeletionProtection": true
}
}
```
------
## Desativar o profiler do Amazon DocumentDB
Para desativar o criador de perfil, você desativa o `profiler` parâmetro e a exportação de `profiler` registros para o CloudWatch Logs.
### Desabilitar o profiler
Você pode desativar o `profiler` parâmetro usando o Console de gerenciamento da AWS ou AWS CLI, da seguinte forma.
------
#### [ Using the Console de gerenciamento da AWS ]
O procedimento a seguir usa o Console de gerenciamento da AWS para desativar o Amazon DocumentDB`profiler`.
1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)
1. No painel de navegação, escolha **grupos de parâmetros**. Selecione o nome do grupo de parâmetros de cluster ao qual você deseja desabilitar o profiler.
1. Na página **Parâmetros de cluster** resultante, selecione o botão à esquerda do parâmetro `profiler` e escolha **Editar**.
1. Na caixa de diálogo **Modificar profiler** escolha `disabled` na lista.
1. Escolha **Modificar parâmetro de cluster**.
------
#### [ Using the AWS CLI ]
Para desabilitar o `profiler` em um cluster usando a AWS CLI, modifique o cluster da seguinte forma.
```
aws docdb modify-db-cluster-parameter-group \
--db-cluster-parameter-group-name sample-parameter-group \
--parameters ParameterName=profiler,ParameterValue=disabled,ApplyMethod=immediate
```
------
## Desativar a exportação de logs do profiler
Você pode desativar a exportação de `profiler` registros para o CloudWatch Logs usando o Console de gerenciamento da AWS ou AWS CLI, da seguinte forma.
------
#### [ Using the Console de gerenciamento da AWS ]
O procedimento a seguir usa o Console de gerenciamento da AWS para desativar a exportação de registros do Amazon DocumentDB para o. CloudWatch
1. [Abra o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)
1. No painel de navegação, escolha **Clusters**. Escolha o botão à esquerda do nome do cluster para o qual você deseja desativar a exportação de logs.
1. No menu **Ações**, escolha **Modificar**.
1. Role para baixo até a seção **Log exports** e desmarque **Profiler logs**.
1. Escolha **Continuar**.
1. Analise as alterações e escolha quando você deseja que essa mudança seja aplicada ao seu cluster:
+ **Aplicar durante a próxima janela de manutenção programada**
+ **Aplicar imediatamente**
1. Escolha **Modificar Cluster**.
------
#### [ Using the AWS CLI ]
O código a seguir modifica o cluster `sample-cluster ` e desativa os registros do CloudWatch profiler.
**Example**
Para Linux, macOS ou Unix:
```
aws docdb modify-db-cluster \
--db-cluster-identifier sample-cluster \
--cloudwatch-logs-export-configuration '{"DisableLogTypes":["profiler"]}'
```
Para Windows:
```
aws docdb modify-db-cluster ^
--db-cluster-identifier sample-cluster ^
--cloudwatch-logs-export-configuration '{"DisableLogTypes":["profiler"]}'
```
A saída dessa operação é semelhante à seguinte.
```
{
"DBCluster": {
"AvailabilityZones": [
"us-east-1c",
"us-east-1b",
"us-east-1a"
],
"BackupRetentionPeriod": 1,
"DBClusterIdentifier": "sample-cluster",
"DBClusterParameterGroup": "sample-parameter-group",
"DBSubnetGroup": "default",
"Status": "available",
"EarliestRestorableTime": "2020-04-08T02:05:17.266Z",
"Endpoint": "sample-cluster.node.us-east-1.docdb.amazonaws.com",
"ReaderEndpoint": "sample-cluster.node.us-east-1.docdb.amazonaws.com",
"MultiAZ": false,
"Engine": "docdb",
"EngineVersion": "3.6.0",
"LatestRestorableTime": "2020-04-09T05:14:44.356Z",
"Port": 27017,
"MasterUsername": "test",
"PreferredBackupWindow": "02:00-02:30",
"PreferredMaintenanceWindow": "tue:09:50-tue:10:20",
"DBClusterMembers": [
{
"DBInstanceIdentifier": "sample-instance-1",
"IsClusterWriter": true,
"DBClusterParameterGroupStatus": "in-sync",
"PromotionTier": 1
},
{
"DBInstanceIdentifier": "sample-instance-2",
"IsClusterWriter": true,
"DBClusterParameterGroupStatus": "in-sync",
"PromotionTier": 1
}
],
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sg-abcd0123",
"Status": "active"
}
],
"HostedZoneId": "ABCDEFGHIJKLM",
"StorageEncrypted": true,
"KmsKeyId": "arn:aws:kms:us-east-1::key/sample-key",
"DbClusterResourceId": "cluster-ABCDEFGHIJKLMNOPQRSTUVWXYZ",
"DBClusterArn": "arn:aws:rds:us-east-1::cluster:sample-cluster",
"AssociatedRoles": [],
"ClusterCreateTime": "2020-01-10T22:13:38.261Z",
"DeletionProtection": true
}
}
```
------
## Acessar seus logs do profiler do Amazon DocumentDB
Siga estas etapas para acessar seus registros de perfil na Amazon CloudWatch.
1. Abra o CloudWatch console em [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/).
1. Certifique-se de estar na mesma região que seu cluster do Amazon DocumentDB.
1. No painel de navegação, selecione **Logs**.
1. Para encontrar os logs do profiler do cluster, selecione `/aws/docdb/yourClusterName/profiler` na lista.
Os logs de perfil para cada uma das suas instâncias estão disponíveis em cada um dos respectivos nomes de instância.
## Consultas comuns
Veja as seguintes consultas comuns que você pode usar para analisar seus comandos perfilados. Para obter mais informações sobre o CloudWatch Logs Insights, consulte [Análise de dados de registro com o CloudWatch Logs Insights](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html) e [exemplos de consultas.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax-examples.html)
### Obter as 10 operações mais lentas de uma coleção especificada
```
filter ns="test.foo" | sort millis desc | limit 10
```
### Obter todas as operações de atualização em uma coleção que levou mais de 60ms
```
filter millis > 60 and op = "update"
```
### Obter as 10 operações mais lentas do último mês
```
sort millis desc | limit 10
```
### Obter todas as consultas com um resumo de planos COLLSCAN
```
filter planSummary="COLLSCAN"
```
# Monitoramento com o Performance Insights
O Performance Insights adiciona atributos de monitoramento existentes do Amazon DocumentDB para ilustrar o desempenho do cluster e ajudar você a analisar quaisquer problemas que o afetem. Com o painel do Performance Insights, você pode visualizar a carga do banco de dados e filtrá-la por esperas, instruções de consulta, hosts ou aplicação.
**nota**
O Performance Insights está disponível somente para clusters baseados em instâncias do Amazon DocumentDB 3.6, 4.0, 5.0 e 8.0.
**Como isso é útil?**
+ Visualize a performance do banco de dados — Visualize a carga para determinar quando e onde ela está no banco de dados
+ Determine o que está causando a carga no banco de dados: determine quais consultas, hosts e aplicações estão contribuindo para a carga na sua instância
+ Determine quando há carga em seu banco de dados — amplie o painel Performance Insights para se concentrar em eventos específicos ou diminua o zoom para observar as tendências em um período maior
+ Alerta sobre a carga do banco de dados — Acesse novas métricas de carga do banco de dados automaticamente de CloudWatch onde você pode monitorar as métricas de carga do banco de dados junto com outras métricas do Amazon DocumentDB e definir alertas sobre elas
**Quais são as limitações do Amazon DocumentDB Performance Insights?**
+ Performance Insights nas regiões AWS GovCloud (Leste dos EUA) e AWS GovCloud (Oeste dos EUA) não estão disponíveis
+ O Performance Insights for Amazon DocumentDB retém até 7 dias de dados de performance
+ Consultas com mais de 1.024 bytes não são agregadas nos Insights de performance
**Topics**
+ [Conceitos de Performance Insights](performance-insights-concepts.md)
+ [Ativar e desativar o Performance Insights](performance-insights-enabling.md)
+ [Configurar políticas de acesso para o Performance Insights](performance-insights-policies.md)
+ [Análise de métricas usando o painel do Performance Insights](performance-insights-analyzing.md)
+ [Recuperar métricas com a API do Performance Insights](performance-insights-metrics.md)
+ [CloudWatch Métricas da Amazon para Performance Insights](performance-insights-cloudwatch.md)
+ [Métricas de contadores do Performance Insights](performance-insights-counter-metrics.md)
# Conceitos de Performance Insights
**Topics**
+ [Média de sessões ativas](#performance-insights-concepts-sessions)
+ [Dimensões](#performance-insights-concepts-dimensions)
+ [Máx. vCPU](#performance-insights-concepts-maxvcpu)
## Média de sessões ativas
Database load (DB load) (Carga do banco de dados) mede o nível de atividade no seu banco de dados. A métrica chave do Performance Insights é `DB Load`, que é coletada a cada segundo. A unidade para a métrica `DBLoad` é a *Average Active Sessions (AAS)* para uma instância do Amazon DocumentDB.
Uma sessão *ativa* é uma conexão que enviou trabalho para a instância do Amazon DocumentDB e está aguardando uma resposta. Por exemplo, se você enviar uma consulta a uma instância do Amazon DocumentDB, a sessão do banco de dados estará ativa enquanto a instância estiver processando a consulta.
Para obter a média de sessões ativas, o Performance Insights faz uma amostra do número de sessões executando simultaneamente uma consulta. O AAS é o número total de sessões divididas pelo número total de amostras. A tabela a seguir mostra 5 amostras consecutivas de uma consulta em execução.
| Amostra | Número de sessões que executam a consulta | AAS | Cálculo |
| --- | --- | --- | --- |
| 1 | 2 | 2 | 2 sessões/1 amostra |
| 2 | 0 | 1 | 2 sessões/2 amostras |
| 3 | 4 | 2 | 6 sessões/3 amostras |
| 4 | 0 | 1.5 | 6 sessões/4 amostras |
| 5 | 4 | 2 | 10 sessões/5 amostras |
No exemplo anterior, a carga do banco de dados para o intervalo de tempo 1-5 é 2 AAS. Um aumento na carga do banco de dados significa que, em média, mais sessões estão sendo executadas no banco de dados.
## Dimensões
A métrica `DB Load` é diferente das outras métricas da série temporal, pois você pode fragmentá-la em subcomponentes chamados de dimensões. É possível pensar em dimensões como categorias para as diferentes características da métrica `DB Load`. Quando você está diagnosticando problemas de performance, as dimensões mais úteis são **estados de espera** e **consulta principal**.
**estados de espera**
Um *evento de espera* faz com que uma instrução de consulta aguarde que um evento específico aconteça antes que possa continuar a execução. Por exemplo, a execução da instrução de consulta pode aguardar até que um recurso bloqueado seja desbloqueado. Ao combinar `DB Load` com estados de espera, é possível obter uma imagem completa do estado da sessão. Aqui estão vários estados de espera do Amazon DocumentDB:
| Estado de espera do Amazon DocumentDB | Descrição do estado de espera |
| --- | --- |
| Latch | O estado de espera Latch ocorre quando a sessão está aguardando para paginar o buffer pool. A entrada e saída frequentes do buffer pool podem ocorrer com mais frequência quando há consultas grandes e frequentes sendo processadas pelo sistema, varreduras de coleção ou quando o buffer pool é muito pequeno para lidar com o conjunto de trabalho. |
| CPU | O estado de espera da CPU ocorre quando a sessão está aguardando a CPU. |
| CollectionLock | O estado de CollectionLock espera ocorre quando a sessão está aguardando para adquirir um bloqueio na coleção. Esses eventos ocorrem quando há operações de DDL na coleção. |
| DocumentLock | O estado de DocumentLock espera ocorre quando a sessão está aguardando para obter um bloqueio em um documento. Um alto número de gravações simultâneas no mesmo documento contribuirá para mais estados de DocumentLock espera nesse documento. |
| SystemLock | O estado de SystemLock espera ocorre quando a sessão está aguardando no sistema. Isso pode ocorrer quando há consultas frequentes de longa duração, transações de longa duração ou alta simultaneidade no sistema. |
| IO | O estado de espera IO ocorre quando a sessão está aguardando pela conclusão de IO. |
| BufferLock | O estado de BufferLock espera ocorre quando a sessão está aguardando para adquirir um bloqueio em uma página compartilhada no buffer. BufferLockos estados de espera podem ser prolongados se outros processos mantiverem cursores abertos nas páginas solicitadas. |
| LowMemThrottle | O estado de LowMemThrottle espera ocorre quando a sessão está esperando devido à forte pressão de memória na instância do Amazon DocumentDB. Se esse estado persistir por muito tempo, considere escalar a instância para fornecer memória adicional. Para obter mais informações, consulte [Regulador de recursos](https://docs.aws.amazon.com/documentdb/latest/developerguide/how-it-works.html). |
| BackgroundActivity | O estado de BackgroundActivity espera ocorre quando a sessão está aguardando processos internos do sistema. |
| Outros | O estado de espera Outros é um estado de espera interno. Se esse estado persistir por muito tempo, considere encerrar essa consulta. Para mais informações, consulte [Como faço para localizar e encerrar consultas bloqueadas ou de longa execução?](https://docs.aws.amazon.com/documentdb/latest/developerguide/user_diagnostics.html#user_diagnostics-query_terminating.html) |
**Principais consultas**
Enquanto os eventos de espera mostram gargalos, as principais consultas mostram quais consultas estão contribuindo mais para a carga do banco de dados. Por exemplo, muitas consultas podem estar atualmente em execução no banco de dados, mas uma única consulta pode consumir 99% da carga do banco de dados. Nesse caso, a carga alta pode indicar um problema com a consulta.
## Máx. vCPU
No painel, o gráfico **Carga de banco de dados** coleta, agrega e exibe informações da sessão. Para ver se as sessões ativas estão excedendo o máximo de CPU, observe sua relação com a linha **Máx. vCPU**. O valor de **Máx. vCPU** é determinado pelo número de núcleos de vCPU (CPUs virtuais) da instância do Amazon DocumentDB.
Se a carga de banco de dados estiver com frequência acima da linha **Máx. vCPU** e o estado de espera primário for CPU, isso indicará que a CPU está sobrecarregada. Nesse caso, convém controlar a utilização as conexões com a instância, ajustar todas as consultas com uma alta carga de CPU ou considerar uma classe de instância maior. As instâncias altas e consistentes de qualquer estado de espera indicam que pode haver problemas de gargalos ou de contenção de recursos que você deve resolver. Isso pode ser válido mesmo quando a carga do banco de dados não ultrapassa a linha de **Máx. vCPU**.
# Ativar e desativar o Performance Insights
Para usar o Performance Insights, ative-o em sua instância de banco de dados. É possível desativá-lo mais tarde. Habilitar e desabilitar o Performance Insights não causa tempo de inatividade, reinicialização ou failover.
O agente do Performance Insights consome CPU e memória limitadas no host do banco de dados. Quando a carga do banco de dados é alta, o agente limita o impacto sobre a performance coletando dados com menos frequência.
## Habilitar o Performance Insights ao criar um cluster
No console, você pode habilitar ou desabilitar o Performance Insights ao criar ou modificar uma nova instância de banco de dados.
### Usando o Console de gerenciamento da AWS
No console, você pode ativar o recurso Performance Insights ao criar um cluster do Amazon DocumentDB. Ao criar um novo cluster do Amazon DocumentDB, ative o Performance Insights selecionando **Ativar o Performance Insights** na seção **Performance Insights**.
**Instruções do console**
1. Para criar um cluster, siga as instruções para [Criar um cluster do Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-create.html).
1. Na seção Performance Insights, escolha **Habilitar Performance Insights**.
![\[A seção Insights de performance com Habilitar Insights de performance selecionado.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/select-performance-insights.png)
**nota**
O período de retenção de dados do Performance Insights será de sete dias.
** AWS KMS chave** — Especifique sua chave AWS KMS. O Performance Insights criptografa todos os dados potencialmente confidenciais usando sua AWS KMS chave. Os dados são criptografados em repouso e em trânsito. Para obter mais informações, consulte Configurando uma AWS AWS KMS política para o Performance Insights.
## Habilitar e desabilitar ao modificar uma instância
É possível modificar uma instância de banco de dados para habilitar ou desabilitar o Performance Insights usando o console ou AWS CLI.
------
#### [ Using the Console de gerenciamento da AWS ]
**Instruções do console**
1. [Faça login no e abra Console de gerenciamento da AWS o console do Amazon DocumentDB em https://console.aws.amazon.com /docdb.](https://console.aws.amazon.com/docdb)
1. Escolha **Clusters**.
1. Escolha uma instância de banco de dados e **Modificar**.
1. Na seção Performance Insights, escolha **Habilitar o Performance Insights** ou **Desabilitar o Performance Insights**.
**nota**
Se você escolher **Ativar Performance Insights**, poderá especificar sua AWS AWS KMS chave. O Performance Insights criptografa todos os dados potencialmente confidenciais usando sua AWS KMS chave. Os dados são criptografados em repouso e em trânsito. Para obter mais informações, consulte [Criptografando o Amazon DocumentDB de dados em repouso](https://docs.aws.amazon.com/documentdb/latest/developerguide/encryption-at-rest.html).
1. Escolha **Continue**.
1. Em **Programação das modificações**, selecione **Aplicar imediatamente**. Se você escolher **Aplicar durante a próxima janela de manutenção agendada**, sua instância ignorará essa configuração e habilitará o Performance Insights imediatamente.
1. Escolha **Modificar instância**.
------
#### [ Using the AWS CLI ]
Ao usar os `modify-db-instance` AWS AWS CLI comandos `create-db-instance` ou, você pode ativar o Performance Insights `--enable-performance-insights` especificando ou desativá-lo `--no-enable-performance-insights` especificando.
O procedimento a seguir descreve como habilitar ou desabilitar o Performance Insights para uma instância de banco de dados usando a AWS AWS CLI.
**AWS AWS CLI instruções**
Chame o `modify-db-instance` AWS AWS CLI comando e forneça os seguintes valores:
+ `--db-instance-identifer` — o nome da instância de banco de dados.
+ `--enable-performance-insights` para habilitar ou `--no-enable-performance-insights` para desabilitar
**Example**
O exemplo a seguir habilita o Performance Insights para a `sample-db-instance`.
```
aws docdb modify-db-instance \
--db-instance-identifier sample-db-instance \
--enable-performance-insights
```
```
aws docdb modify-db-instance ^
--db-instance-identifier sample-db-instance ^
--enable-performance-insights
```
------
# Configurar políticas de acesso para o Performance Insights
Para acessar o Performance Insights, é necessário ter as permissões apropriadas do AWS Identity and Access Management (IAM). Você tem as seguintes opções para conceder acesso:
+ Anexe a política gerenciada `AmazonRDSPerformanceInsightsReadOnly` a um conjunto de permissões ou perfil.
+ Crie uma política do IAM personalizada e anexe ela a um conjunto de permissões ou perfil.
Além disso, se você especificou uma chave gerenciada pelo cliente quando ativou o Performance Insights, certifique-se de que os usuários em sua conta têm as permissões `kms:Decrypt` e `kms:GenerateDataKey` na chave do KMS.
**nota**
encryption-at-rest[Com o gerenciamento de AWS KMS chaves e grupos de segurança, o Amazon DocumentDB aproveita a tecnologia operacional que é compartilhada com o Amazon RDS.](https://aws.amazon.com/rds)
## Anexando a RDSPerformance InsightsReadOnly política da Amazon a um diretor do IAM
`AmazonRDSPerformanceInsightsReadOnly`é uma política AWS gerenciada que concede acesso a todas as operações somente para leitura da API Amazon DocumentDB Performance Insights. Atualmente, todas as operações nesta API são somente leitura. Se você anexar `AmazonRDSPerformanceInsightsReadOnly` a um conjunto de permissões ou perfil, o destinatário poderá usar o Performance Insights com outros recursos do console.
## Criação de uma política de IAM personalizada para o Performance Insights
Para usuários que não têm a política `AmazonRDSPerformanceInsightsReadOnly`, é possível conceder acesso ao Performance Insights criando ou modificando uma política do IAM gerenciada pelo usuário. Quando você anexa a política a um conjunto de permissões ou perfil, o destinatário pode usar o Performance Insights.
**Para criar uma política personalizada**
1. Abra o console do IAM em [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/).
1. No painel de navegação, selecione **Políticas**.
1. Selecione **Criar política**.
1. Na página **Create Policy (Criar política)**, escolha a guia JSON.
1. Copie e cole o texto a seguir, *us-east-1* substituindo-o pelo nome da sua AWS região e *111122223333* pelo número da sua conta de cliente.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": "rds:DescribeDBInstances",
"Resource": "*"
},
{
"Effect": "Allow",
"Action": "rds:DescribeDBClusters",
"Resource": "*"
},
{
"Effect": "Allow",
"Action": "pi:DescribeDimensionKeys",
"Resource": "arn:aws:pi:us-east-1:111122223333:metrics/rds/*"
},
{
"Effect": "Allow",
"Action": "pi:GetDimensionKeyDetails",
"Resource": "arn:aws:pi:us-east-1:111122223333:metrics/rds/*"
},
{
"Effect": "Allow",
"Action": "pi:GetResourceMetadata",
"Resource": "arn:aws:pi:us-east-1:111122223333:metrics/rds/*"
},
{
"Effect": "Allow",
"Action": "pi:GetResourceMetrics",
"Resource": "arn:aws:pi:us-east-1:111122223333:metrics/rds/*"
},
{
"Effect": "Allow",
"Action": "pi:ListAvailableResourceDimensions",
"Resource": "arn:aws:pi:us-east-1:111122223333:metrics/rds/*"
},
{
"Effect": "Allow",
"Action": "pi:ListAvailableResourceMetrics",
"Resource": "arn:aws:pi:us-east-1:111122223333:metrics/rds/*"
}
]
}
```
------
1. Escolha **Review policy (Revisar política)**.
1. Forneça um nome para a política e, se preferir, uma descrição. Em seguida, escolha **Criar política**.
Agora você pode anexar a política a um conjunto de permissões ou perfil. O procedimento a seguir pressupõe que você já tem um usuário disponível para essa finalidade.
**Como anexar a política a um usuário**
1. Abra o console do IAM em [https://console.aws.amazon.com/iam/](https://console.aws.amazon.com/iam/).
1. No painel de navegação, escolha **Usuários**.
1. Escolha um usuário existente na lista.
**Importante**
Para usar o Performance Insights, você deve ter acesso ao Amazon DocumentDB e à política personalizada. [Por exemplo, a política **AmazonDocDBReadOnlyAccess**predefinida fornece acesso somente de leitura ao Amazon DocDB. Para obter mais informações, consulte Gerenciando o acesso usando políticas.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAM.html#security_iam_access-manage)
1. Na página **Summary (Resumo)**, escolha **Add permissions (Adicionar permissões)**.
1. Escolha **Anexar políticas existentes diretamente**. Em **Pesquisar**, digite os primeiros caracteres do nome da sua política, conforme mostrado a seguir.
![\[Escolher uma política\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/pi-add-permissions.png)
1. Escolha a política e, em seguida, escolha **Próximo: revisar**.
1. Escolha **Adicionar permissões**.
## Configurando uma AWS KMS política para Performance Insights
O Performance Insights usa um AWS KMS key para criptografar dados confidenciais. Ao habilitar o Performance Insights por meio da API ou do console, você tem as seguintes opções:
+ Escolha o padrão Chave gerenciada pela AWS.
O Amazon DocumentDB usa o Chave gerenciada pela AWS para sua nova instância de banco de dados. O Amazon DocumentDB cria um Chave gerenciada pela AWS para sua AWS conta. Sua AWS conta tem uma conta diferente Chave gerenciada pela AWS para o Amazon DocumentDB para cada AWS região.
+ Escolha uma chave gerenciada pelo cliente.
Se você especificar uma chave gerenciada pelo cliente, os usuários em sua conta que chamam a API do Performance Insights precisarão das permissões `kms:Decrypt` e `kms:GenerateDataKey` na chave do KMS. É possível configurar essas permissões por meio de políticas do IAM. No entanto, recomendamos que você gerencie essas permissões por meio da política de chaves do KMS. Para obter mais informações, consulte o tópico sobre como [Utilizar políticas de chaves no AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html).
**Example**
A política de chave de exemplo a seguir mostra como adicionar instruções à sua política da chaves do KMS. Essas instruções permitem acesso ao Performance Insights. Dependendo de como você usa o AWS KMS, talvez você queira alterar algumas restrições. Antes de adicionar instruções à política, remova todos os comentários.
# Análise de métricas usando o painel do Performance Insights
O painel do Performance Insights contém informações de performance do banco de dados para ajudar você a analisar e solucionar problemas de performance. Na página do painel principal, você pode visualizar informações sobre a carga do banco de dados (DB load). É possível “fatiar” a carga de banco de dados por dimensões como eventos de espera ou consulta.
**Topics**
+ [Visão geral do painel do Performance Insights](performance-insights-dashboard-overview.md)
+ [Abrir o painel do Performance Insights](performance-insights-dashboard-opening.md)
+ [Analisar a carga do banco de dados por estados de espera](performance-insights-analyzing-db-load.md)
+ [Visão geral da guia Principais consultas](performance-insights-top-queries.md)
+ [Ampliar o gráfico de carga de banco de dados](performance-insights-zoom-db-load.md)
# Visão geral do painel do Performance Insights
O painel é a maneira mais fácil de interagir com o Performance Insights. O exemplo a seguir mostra o painel de uma instância de Amazon DocumentDB. Por padrão, o painel do Performance Insights exibe dados da última hora.
![\[Painel dos Insights de performance, mostrando a utilização da CPU e a carga do banco de dados ao longo do tempo para uma instância do Amazon DocumentDB.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/overview-dashboard.png)
O painel é dividido nas seguintes partes:
1. **Counter metrics**: mostra dados das métricas de contador de performance específicas.
1. **Database load**: mostra como a carga de banco de dados se compara à capacidade da instância de banco de dados conforme representada pela linha **Máx. vCPU**.
1. **Dimensões principais** – Mostra as principais dimensões que contribuem para a carga do banco de dados. Essas dimensões incluem `waits`, `queries`, `hosts`, `databases` e `applications`.
**Topics**
+ [Gráfico de métricas de contador](#performance-insights-overview-metrics)
+ [Gráfico de carga do banco de dados](#performance-insights-overview-db-load-chart)
+ [Tabela Top dimensions (Principais dimensões)](#performance-insights-overview-top-dimensions)
## Gráfico de métricas de contador
Com métricas de contador, você pode personalizar o painel do Performance Insights para incluir até 10 gráficos adicionais. Esses gráficos mostram uma seleção de dezenas de métricas de performance do sistema operacional. É possível correlacionar essas informações à carga do banco de dados para ajudar a identificar e analisar problemas de performance.
O gráfico **Métricas de contador** exibe dados dos contadores de performance.
![\[Gráfico Métricas de contadores mostrando a utilização da CPU ao longo do tempo.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/counter-metrics.png)
Para alterar os contadores de performance, escolha **Gerenciar métricas**. É possível selecionar várias **Métricas de SO**, conforme mostrado na captura de tela a seguir. Para ver detalhes de qualquer métrica, passe o mouse sobre o nome da métrica.
![\[Interface de seleção de métricas do painel dos Insights de performance com opções de métricas do sistema operacional.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/overview-os-metrics.png)
## Gráfico de carga do banco de dados
O gráfico **Carga do banco de dados** mostra como a atividade do banco de dados se compara à capacidade da instância de banco de dados representada pela linha **Máximo de vCPU**. Por padrão, o gráfico de linhas empilhadas representa a carga do banco de dados como sessões ativas médias por unidade de tempo. A carga do banco de dados é separada (agrupada) por estados de espera.
![\[Gráfico Carga do banco de dados, mostrando a média de sessões ativas ao longo do tempo, com o aumento do uso da CPU próximo ao fim.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/database-load.png)
**Carga de banco de dados separada por dimensões**
É possível optar por exibir a carga como sessões ativas agrupadas por quaisquer dimensões aceitas. A imagem a seguir mostra as dimensões de uma instância de banco de dados do Amazon DocumentDB.
![\[Gráfico mostrando a carga do banco de dados com várias opções “Fatiar por” exibidas em uma lista suspensa.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/database-load-sliced.png)
**Detalhes de carga de banco de dados para um item de dimensão**
Para ver detalhes sobre um item de carga de banco de dados dentro de uma dimensão, passe o mouse sobre o nome do item. A imagem a seguir mostra detalhes de uma instrução de consulta.
![\[Gráfico de barras mostrando a carga do banco de dados com detalhes adicionais exibidos ao passar o mouse sobre o nome de um item.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/database-load-details.png)
Para ver detalhes de qualquer item do período selecionado na legenda, passe o mouse sobre esse item.
![\[Gráfico de barras mostrando a carga do banco de dados com detalhes adicionais exibidos ao passar o mouse sobre uma barra.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/database-load-hover.png)
## Tabela Top dimensions
A tabela **Principais dimensões** separa a carga do banco de dados com base em diferentes dimensões. Uma dimensão é uma categoria ou “pedaços” de diferentes características de uma carga de banco de dados. Se a dimensão for consulta, **Principais consultas** mostrará as instruções SQL que mais contribuem para a carga do banco de dados.
Escolha qualquer uma das guias de dimensão a seguir.
![\[A guia Dimensões das consultas principais, mostrando as duas consultas principais.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/top-dimensions.png)
A tabela a seguir fornece uma breve descrição de cada guia.
| Tab | Description |
| --- | --- |
| Esperas principais | O evento para o qual o backend do banco de dados está aguardando |
| Principais consultas | As instruções de consulta que estão sendo executadas no momento |
| Hosts principais | O host IP e porta do cliente conectado |
| Principais bancos de dados | O nome do banco de dados ao qual o cliente está conectado |
| Principais aplicações | O nome da aplicação que está conectada ao banco de dados |
Para aprender a analisar consultas utilizando a guia **Principais consultas**, consulte [Visão geral da guia Principais consultas](performance-insights-top-queries.md).
# Abrir o painel do Performance Insights
**Para visualizar o painel do Performance Insights no AWS Management Console, use as seguintes etapas:**
1. Abra o console do Performance Insights em [https://console.aws.amazon.com/docdb/](https://console.aws.amazon.com/docdb/home#performance-insights).
1. Escolha uma instância de banco de dados. O painel do Performance Insights é exibido para essa instância dp Amazon DocumentDB.
Para as instâncias do Amazon DocumentDB com o Performance Insights habilitado, você também pode acessar o painel escolhendo o item **Sessões** na lista de instâncias. Em **Atividade atual**, o item **Sessões** mostra a carga de banco de dados em sessões ativas médias nos últimos cinco minutos. A carga é mostrada graficamente por meio de barras. Quando a barra está vazia, a instância está ociosa. À medida que a carga aumenta, a barra é preenchida com a cor azul. Quando a carga ultrapassa o número de virtual CPUs (vCPUs) na classe da instância, a barra fica vermelha, indicando um possível gargalo.
![\[A página Clusters, mostrando um cluster regional do Amazon DocumentDB e a CPU e a atividade atual de cada instância do cluster.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/opening-clusters.png)
1. (Opcional) Escolha um intervalo de tempo diferente selecionando um botão no canto superior direito. Por exemplo, para alterar o intervalo para 1 hora, selecione **1h**.
![\[Botões de intervalo de tempo, variando de cinco minutos a uma semana.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/opening-time.png)
Na captura de tela a seguir, o intervalo da carga do banco de dados é de 1 hora.
![\[Gráfico de barras mostrando a carga do banco de dados medida na média de sessões ativas.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/opening-db-load.png)
1. Para atualizar seus dados automaticamente, habilite a **Atualização automática**.
![\[O botão de atualização automática habilitado, aparecendo ao lado dos botões de intervalo de tempo.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/opening-auto-refresh.png)
O painel do Performance Insights é atualizado automaticamente com novos dados. A taxa de atualização depende da quantidade de dados exibida:
+ 5 minutos atualiza a cada 5 segundos.
+ 1 hora atualiza a cada minuto.
+ 5 horas atualiza a cada minuto.
+ 24 horas atualiza a cada 5 minutos.
+ Uma semana atualiza a cada hora.
# Analisar a carga do banco de dados por estados de espera
Se o gráfico **Carregamento do banco de dados** mostrar um gargalo, será possível descobrir de onde vem essa carga. Para fazer isso, examine a tabela de principais itens de carga abaixo do gráfico **Carregamento do banco de dados**. Escolha um item específico, como uma consulta ou uma aplicação, para aprofundar neste item e ver detalhes sobre ele.
A carga do banco de dados agrupada por espera e as principais consultas normalmente fornecem mais informações sobre problemas de performance. A carga de banco de dados agrupada por espera mostra se há algum gargalo de recursos ou de concorrências no banco de dados. Nesse caso, a guia **Principais consultas** da tabela Top Load Items mostra quais consultas estão gerando essa carga.
Seu fluxo de trabalho típico para diagnosticar problemas de performance é o seguinte:
1. Analise o gráfico **Carregamento do banco de dados** e veja se há casos de cargas de banco de dados que estejam ultrapassando a linha **Máximo de CPU**.
1. Se houver, examine o gráfico **Carregamento do banco de dados** e identifique quais estados de espera são os principais responsáveis por isso.
1. Identifique as consultas resumidas que estão gerando a carga examinando quais consultas na guia **Top queries** da tabela Top Load Items estão contribuindo mais para aqueles estados de espera. É possível identificar essas consultas na coluna **Carga por espera (AAS)**.
1. Escolha uma dessas consultas resumidas na guia **Top queries** para expandi-la e exibir as consultas secundárias que a compõem.
Você também pode ver quais hosts ou aplicações estão contribuindo com a maior carga selecionando **Principais hosts** ou **Principais aplicações**, respectivamente. Os nomes das aplicações são especificados na cadeia de conexão com a instância Amazon DocumentDB. `Unknown` indica que o campo da aplicação não foi especificado.
Por exemplo, no painel a seguir, as esperas de **CPU** compõem a maior parte da carga de banco de dados. Selecionar a consulta principal em **Principais consultas** definirá o gráfico de carga do banco de dados para se concentrar na maior carga que está sendo contribuída pela consulta selecionada.
![\[Gráfico de carga do banco de dados, mostrando o pico de uso da CPU. Uma guia Principais consultas correspondente mostra as consultas que mais contribuem para os estados de espera.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/db-load-1.png)
![\[Gráfico Carga do banco de dados, mostrando o pico de uso da CPU para a consulta que mais contribui para os estados de espera. Uma guia Principais consultas correspondente mostra as consultas secundárias dessa consulta.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/db-load-2.png)
# Visão geral da guia Principais consultas
Por padrão, a guia **Principais consultas** mostra as consultas que mais estão contribuindo para a carga do banco de dados. É possível analisar o texto da consulta para ajudar a ajustar suas consultas.
**Topics**
+ [Resumos de consultas](#performance-insights-top-queries-digests)
+ [Load by waits (AAS) (Carga por esperas)](#performance-insights-top-queries-aas)
+ [Visualizando informações detalhadas da consulta](#performance-insights-top-queries-query-info)
+ [Acessando o texto da consulta da instrução](#performance-insights-top-queries-accessing-text)
+ [Visualizando e baixando o texto da consulta de instrução](#performance-insights-top-queries-viewing-downloading)
## Resumos de consultas
Um *resumo de consulta* é formado por várias consultas reais com estruturas semelhantes, mas que possivelmente apresentam valores literais diferentes. O resumo substitui valores codificados por um ponto de interrogação. Por exemplo, um resumo de consulta pode ser semelhante a este:
```
{"find":"customerscollection","filter":{"FirstName":"?"},"sort":{"key":{"$numberInt":"?"}},"limit":{"$numberInt":"?"}}
```
Esse resumo pode incluir as seguintes consultas subordinadas:
```
{"find":"customerscollection","filter":{"FirstName":"Karrie"},"sort":{"key":{"$numberInt":"1"}},"limit":{"$numberInt":"3"}}
{"find":"customerscollection","filter":{"FirstName":"Met"},"sort":{"key":{"$numberInt":"1"}},"limit":{"$numberInt":"3"}}
{"find":"customerscollection","filter":{"FirstName":"Rashin"},"sort":{"key":{"$numberInt":"1"}},"limit":{"$numberInt":"3"}}
```
Para ver as instruções consultas literais em um resumo, escolha a consulta e depois o sinal de mais (`+`). Na captura de tela a seguir, a consulta selecionada é um resumo.
![\[A tabela Principais consultas, mostrando um resumo de consultas expandido com uma consulta secundária selecionada.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/top-queries-literal.png)
**nota**
Um resumo de consulta agrupa instruções de consulta semelhantes, mas não edita informações confidenciais.
## Carga por esperas (AAS)
Em **Consultas principais**, a coluna **Carga por esperas (AAS)** mostra o percentual da carga do banco de dados associada a cada item de carga principal. Essa coluna reflete a carga desse item por qualquer agrupamento atualmente selecionado no **Gráfico de carga de banco de dados**. Por exemplo, é possível agrupar o gráfico **Carregamento do banco de dados** com base em estados de espera. Nesse caso, a barra **Carregamento do banco de dados por esperas** é dimensionada, segmentada e codificada por cores para mostrar com quanto de um determinado estado de espera a consulta está contribuindo. Ela também mostra quais estados de espera estão afetando a consulta selecionada.
![\[Gráfico de barras mostrando a carga do banco de dados agrupada por CPU, IO e estados de espera por trava. A tabela correspondente mostra as principais consultas com base na carga por espera.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/top-queries-aas.png)
## Visualizando informações detalhadas da consulta
Na tabela **Principais consultas**, é possível abrir uma *instrução de resumo* para visualizar suas informações. As informações são exibidas no painel inferior.
![\[A tabela Principais consultas, mostrando uma instrução de consulta selecionada e suas informações de consulta abaixo.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/top-queries-detailed.png)
Os seguintes tipos de identificadores (IDs) estão associados às instruções de consulta:
1. **ID da consulta de suporte** — Um valor de hash do ID da consulta. Esse valor serve apenas para fazer referência a um ID de consulta quando você está trabalhando com o AWS Support. AWS O Support não tem acesso à sua consulta real IDs e ao texto da consulta.
1. **ID de arquivo de resumo de suporte**: um valor de hash do ID de arquivo de resumo. Esse valor serve apenas para fazer referência a uma ID de resumo quando você está trabalhando com o Support AWS . AWS O Support não tem acesso ao texto real do resumo IDs e da consulta.
## Acessando o texto da consulta da instrução
Por padrão, cada linha na tabela **Principais consultas** mostra 500 bytes de texto para cada instrução. Quando uma instrução de resumo é maior que 500 bytes, você pode visualizar uma parte maior dela abrindo-a no painel do Performance Insights. Nesse caso, o comprimento máximo para a consulta mostrada é de 1 KB. Se você vir uma instrução de consulta completa, também poderá escolher **Download**.
## Visualizando e baixando o texto da consulta de instrução
No painel do Performance Insights, é possível visualizar ou baixar o texto da consulta.
**Para visualizar mais texto de consulta no painel do Performance Insights**
1. Abra o console do Amazon DocumentDB em: [https://console.aws.amazon.com/docdb/](https://console.aws.amazon.com/docdb/)
1. No painel de navegação, escolha **Performance Insights**.
1. Escolha uma instância de banco de dados. O painel do Performance Insights será exibido nessa instância de banco de dados.
Instruções de consulta com texto maior que 500 bytes serão semelhantes à imagem a seguir.
![\[A tabela Principais consultas com uma consulta secundária selecionada.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/top-queries-statement.png)
1. Examine a seção de informações de consulta para visualizar mais do texto da consulta.
![\[A seção Informações da consulta, mostrando o texto completo da consulta selecionada.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/top-queries-query-text.png)
O painel do Performance Insights pode exibir até 1 KB para cada instrução completa de consulta.
**nota**
Para copiar ou baixar a instrução de consulta, desabilite bloqueadores de pop-up.
# Ampliar o gráfico de carga de banco de dados
Há outros recursos da interface do usuário do Performance Insights para ajudar você a analisar dados de performance.
**Click-and-Drag Ampliar**
Na interface do Performance Insights, escolha uma pequena parte do gráfico de carga e amplie os detalhes.
![\[Gráfico de barras mostrando a carga do banco de dados, com uma parte destacada para ampliação.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/pi-zoom-1.png)
Para ampliar uma parte do gráfico de carga, escolha a hora de início e arraste até o final do período desejado. Quando você faz isso, a área selecionada fica destacada. Ao soltar o mouse, o gráfico de carga amplia a área selecionada e a tabela ***Itens *principais** é recalculada.
![\[Gráfico de barras de carregamento do banco de dados, mostrando a parte ampliada e com a tabela de principais esperas correspondente abaixo.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/pi-zoom-2.png)
# Recuperar métricas com a API do Performance Insights
Quando o Performance Insights está habilitado, a API fornece visibilidade à performance da instância. O Amazon CloudWatch Logs fornece a fonte confiável para métricas de monitoramento de serviços vendidos. AWS
O Performance Insights oferece uma visão específica do domínio da carga do banco de dados medida como sessões ativas médias (AAS). Essa métrica aparece para os consumidores de API como um conjunto de dados bidimensional de séries temporais. A dimensão de tempo dos dados fornece a carga do banco de dados para cada ponto de tempo no intervalo de tempo consultado. Cada ponto de tempo decompõe a carga geral em relação às dimensões solicitadas, como `Query`, `Wait-state`, `Application` ou `Host`, medidas naquele ponto de tempo.
O Performance Insights do Amazon DocumentDB monitora sua instância de banco de dados do Amazon DocumentDB, para que você possa analisar e solucionar problemas relacionados ao desempenho do seu banco de dados. Uma maneira de visualizar os dados do Performance Insights está no Console de gerenciamento da AWS. O Performance Insights também fornece uma API pública para que você possa consultar seus próprios dados. É possível usar a API para fazer o seguinte:
+ Descarregar dados em um banco de dados
+ Adicione dados do Performance Insights aos painéis de monitoramento existentes
+ Criar ferramentas de monitoramento
Para usar a API do Performance Insights, habilite o Performance Insights em uma das suas instâncias do Amazon DocumentDB. Para obter informações sobre como habilitar o Performance Insights, consulte [Ativar e desativar o Performance Insights](performance-insights-enabling.md). Para obter mais informações sobre a API Insights de performance, consulte a [Referência de API dos Insights de performance](https://docs.aws.amazon.com/performance-insights/latest/APIReference/Welcome.html).
A API do Performance Insights fornece as operações a seguir.
****
| Ação do Performance Insights | AWS CLI comando | Description |
| --- | --- | --- |
| [https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_DescribeDimensionKeys.html](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_DescribeDimensionKeys.html) | [https://docs.aws.amazon.com/cli/latest/reference/pi/describe-dimension-keys.html](https://docs.aws.amazon.com/cli/latest/reference/pi/describe-dimension-keys.html) | Recuperar as N principais chaves de dimensão de uma métrica por um período específico. |
| [https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetDimensionKeyDetails.html](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetDimensionKeyDetails.html) | [https://docs.aws.amazon.com/cli/latest/reference/pi/get-dimension-key-details.html](https://docs.aws.amazon.com/cli/latest/reference/pi/get-dimension-key-details.html) | Recupera os atributos do grupo de dimensões especificado para uma instância de banco de dados ou fonte de dados. Por exemplo, se você especificar um ID de consulta e se os detalhes da dimensão estiverem disponíveis, `GetDimensionKeyDetails` recuperará o texto completo da dimensão `db.query.statement` associada a esse ID. Essa operação é útil porque `GetResourceMetrics` e `DescribeDimensionKeys` não oferecem suporte à recuperação de texto grande de instrução da consulta. |
| [GetResourceMetadata](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetadata.html) | [https://docs.aws.amazon.com/cli/latest/reference/pi/get-resource-metadata.html](https://docs.aws.amazon.com/cli/latest/reference/pi/get-resource-metadata.html) | Recupere os metadados para diferentes recursos. Por exemplo, os metadados podem indicar que um recurso está ativado ou desativado em uma instância de banco de dados específica. |
| [https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetrics.html](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_GetResourceMetrics.html) | [https://docs.aws.amazon.com/cli/latest/reference/pi/get-resource-metrics.html](https://docs.aws.amazon.com/cli/latest/reference/pi/get-resource-metrics.html) | Recupera as métricas do Performance Insights para um conjunto de fontes de dados, ao longo de um período. É possível fornecer grupos de dimensão e dimensões específicos e fornecer critérios de filtragem e agregação para cada grupo. |
| [ListAvailableResourceDimensions](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_ListAvailableResourceDimensions.html) | [https://docs.aws.amazon.com/cli/latest/reference/pi/list-available-resource-dimensions.html](https://docs.aws.amazon.com/cli/latest/reference/pi/list-available-resource-dimensions.html) | Recupere as dimensões que podem ser consultadas para cada tipo de métrica especificado em uma instância especificada. |
| [ListAvailableResourceMetrics](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_ListAvailableResourceMetrics.html) | [https://docs.aws.amazon.com/cli/latest/reference/pi/list-available-resource-metrics.html](https://docs.aws.amazon.com/cli/latest/reference/pi/list-available-resource-metrics.html) | Recupere todas as métricas disponíveis dos tipos de métrica especificados que podem ser consultados para uma instância de banco de dados especificada. |
**Topics**
+ [AWS CLI para Performance Insights](#performance-insights-metrics-CLI)
+ [Recuperar métricas de séries temporais](#performance-insights-metrics-time-series)
+ [AWS CLI exemplos de Performance Insights](#performance-insights-metrics-api-examples)
## AWS CLI para Performance Insights
É possível visualizar dados do Performance Insights usando o AWS CLI. É possível visualizar a ajuda dos comandos da AWS CLI para o Performance Insights, inserindo o seguinte na linha de comando.
```
aws pi help
```
Se você não tiver o AWS CLI instalado, consulte [Instalando a interface de linha de AWS comando](https://docs.aws.amazon.com/cli/latest/userguide/installing.html) no *Guia do AWS CLI usuário* para obter informações sobre como instalá-lo.
## Recuperar métricas de séries temporais
A operação `GetResourceMetrics` recupera uma ou mais métricas de séries temporais dos dados do Performance Insights. `GetResourceMetrics` requer uma métrica e um período de tempo e retorna uma resposta com uma lista de pontos de dados.
Por exemplo, os Console de gerenciamento da AWS usos `GetResourceMetrics` para preencher o gráfico **Counter Metrics** e o gráfico **Database Load**, conforme mostrado na imagem a seguir.
![\[Gráficos Counter Metrics e Database Load\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/perf-insights-api-charts.png)
Todas as métricas retornadas por `GetResourceMetrics` são métricas de séries temporais padrão, com exceção de `db.load`. Essa métrica é exibida no gráfico **Carregamento do banco de dados**. A métrica `db.load` é diferente das outras métricas da série temporal, pois você pode fragmentá-la em subcomponentes chamados de *dimensões*. Na imagem anterior, `db.load` é dividido e agrupado pelos estados de espera que compõem o `db.load`.
**nota**
`GetResourceMetrics` também pode retornar a métrica `db.sampleload`, mas a métrica `db.load` é apropriada na maioria dos casos.
Para obter informações sobre as métricas de contador retornadas pelo `GetResourceMetrics`, consulte [Métricas de contadores do Performance Insights](performance-insights-counter-metrics.md).
Os cálculos a seguir são compatíveis com as métricas:
+ Média: o valor médio para a métrica por um período. Adicione `.avg` ao nome da métrica.
+ Mínimo: o valor mínimo para a métrica por um período. Adicione `.min` ao nome da métrica.
+ Máximo: o valor máximo para a métrica por um período. Adicione `.max` ao nome da métrica.
+ Soma: a soma dos valores da métrica por um período. Adicione `.sum` ao nome da métrica.
+ Contagem de amostra: o número de vezes que a métrica foi coletada por um período. Adicione `.sample_count` ao nome da métrica.
Por exemplo, considere que uma métrica é coletada por 300 segundos (5 minutos) e que a métrica seja coletada uma vez por minuto. Os valores de cada minuto são 1, 2, 3, 4 e 5. Nesse caso, os seguintes cálculos são retornados:
+ Média: 3
+ Mínimo: 1
+ Máximo: 5
+ Soma: 15
+ Contagem de amostras: 5
Para obter informações sobre como usar o `get-resource-metrics` AWS CLI comando, consulte [https://docs.aws.amazon.com/cli/latest/reference/pi/get-resource-metrics.html](https://docs.aws.amazon.com/cli/latest/reference/pi/get-resource-metrics.html).
Para a opção `--metric-queries`, especifique uma ou mais consultas para as quais deseja obter resultados. Cada consulta consiste em um parâmetro obrigatório `Metric` e opcional `GroupBy` e em parâmetros `Filter`. Veja a seguir um exemplo de uma especificação de opção `--metric-queries`.
```
{
"Metric": "string",
"GroupBy": {
"Group": "string",
"Dimensions": ["string", ...],
"Limit": integer
},
"Filter": {"string": "string"
...}
```
## AWS CLI exemplos de Performance Insights
Os exemplos a seguir mostram como usar o AWS CLI for Performance Insights.
**Topics**
+ [Recuperar métricas de contador](#performance-insights-metrics-api-examples.CounterMetrics)
+ [Recuperar a média de carga de banco de dados para eventos de espera superior](#performance-insights-metrics-api-examples.DBLoadAverage)
+ [Recuperar a média de carga de banco de dados para consulta principal](#performance-insights-metrics-api-examples.topquery)
+ [Recuperação da média de carga de banco de dados filtrada por Consulta](#performance-insights-metrics-api-examples.DBLoadAverageByQuery)
### Recuperar métricas de contador
A captura de tela a seguir mostra dois gráficos de métricas de contador no Console de gerenciamento da AWS.
![\[Gráficos de métricas de contador.\]](http://docs.aws.amazon.com/pt_br/documentdb/latest/developerguide/images/performance-insights/perf-insights-api-counters-charts.png)
O exemplo a seguir mostra como reunir os mesmos dados que o Console de gerenciamento da AWS usa para gerar os dois gráficos de métricas de contador.
Para Linux, macOS ou Unix:
```
aws pi get-resource-metrics \
--service-type DOCDB \
--identifier db-ID \
--start-time 2022-03-13T8:00:00Z \
--end-time 2022-03-13T9:00:00Z \
--period-in-seconds 60 \
--metric-queries '[{"Metric": "os.cpuUtilization.user.avg" },
{"Metric": "os.cpuUtilization.idle.avg"}]'
```
Para Windows:
```
aws pi get-resource-metrics ^
--service-type DOCDB ^
--identifier db-ID ^
--start-time 2022-03-13T8:00:00Z ^
--end-time 2022-03-13T9:00:00Z ^
--period-in-seconds 60 ^
--metric-queries '[{"Metric": "os.cpuUtilization.user.avg" },
{"Metric": "os.cpuUtilization.idle.avg"}]'
```
Você também pode tornar um comando mais fácil de ler, especificando um arquivo para a opção `--metrics-query`. O exemplo a seguir usa um arquivo chamado query.json para a opção. O arquivo tem o seguinte conteúdo.
```
[
{
"Metric": "os.cpuUtilization.user.avg"
},
{
"Metric": "os.cpuUtilization.idle.avg"
}
]
```
Execute o seguinte comando para usar o arquivo.
Para Linux, macOS ou Unix:
```
aws pi get-resource-metrics \
--service-type DOCDB \
--identifier db-ID \
--start-time 2022-03-13T8:00:00Z \
--end-time 2022-03-13T9:00:00Z \
--period-in-seconds 60 \
--metric-queries file://query.json
```
Para Windows:
```
aws pi get-resource-metrics ^
--service-type DOCDB ^
--identifier db-ID ^
--start-time 2022-03-13T8:00:00Z ^
--end-time 2022-03-13T9:00:00Z ^
--period-in-seconds 60 ^
--metric-queries file://query.json
```
O exemplo anterior especifica os seguintes valores para as opções:
+ `--service-type`— `DOCDB` para Amazon DocumentDB
+ `--identifier` – O ID do recurso para a instância do banco de dados
+ `--start-time` e `--end-time` – Os valores ISO 8601 de `DateTime` para o período a consultar, com vários formatos compatíveis
Ele consulta um intervalo de tempo de uma hora:
+ `--period-in-seconds` – `60` para uma consulta por minuto
+ `--metric-queries` – uma matriz de duas consultas, cada uma apenas para uma métrica.
O nome da métrica usa pontos para classificar a métrica em uma categoria útil, com o elemento final sendo uma função. No exemplo, a função é `avg` para cada consulta. Assim como na Amazon CloudWatch, as funções suportadas são `min` `max``total`,, `avg` e.
A resposta é semelhante à seguinte.
```
{
"AlignedStartTime": "2022-03-13T08:00:00+00:00",
"AlignedEndTime": "2022-03-13T09:00:00+00:00",
"Identifier": "db-NQF3TTMFQ3GTOKIMJODMC3KQQ4",
"MetricList": [
{
"Key": {
"Metric": "os.cpuUtilization.user.avg"
},
"DataPoints": [
{
"Timestamp": "2022-03-13T08:01:00+00:00", //Minute1
"Value": 3.6
},
{
"Timestamp": "2022-03-13T08:02:00+00:00", //Minute2
"Value": 2.6
},
//.... 60 datapoints for the os.cpuUtilization.user.avg metric
{
"Key": {
"Metric": "os.cpuUtilization.idle.avg"
},
"DataPoints": [
{
"Timestamp": "2022-03-13T08:01:00+00:00",
"Value": 92.7
},
{
"Timestamp": "2022-03-13T08:02:00+00:00",
"Value": 93.7
},
//.... 60 datapoints for the os.cpuUtilization.user.avg metric
]
}
] //end of MetricList
} //end of response
```
A resposta tem `Identifier`, `AlignedStartTime` e `AlignedEndTime`. Se o valor de `--period-in-seconds` fosse `60`, as horas de início e término seriam alinhadas ao minuto. Se `--period-in-seconds` fosse `3600`, as horas de início e término teriam sido alinhadas à hora.
O `MetricList` na resposta tem um número de entradas, cada uma com uma entrada `Key` e `DataPoints`. Cada `DataPoint` tem um `Timestamp` e um `Value`. Cada lista `Datapoints` tem 60 pontos de dados, pois as consultas são para dados por minuto ao longo de uma hora, com `Timestamp1/Minute1`, `Timestamp2/Minute2` e assim por diante, até `Timestamp60/Minute60`.
Como a consulta é para duas métricas de contador diferentes, há dois elementos na resposta `MetricList`.
### Recuperar a média de carga de banco de dados para eventos de espera superior
O exemplo a seguir é a mesma consulta Console de gerenciamento da AWS usada para gerar um gráfico de linha de área empilhada. Este exemplo recupera o `db.load.avg` para a última hora com carga dividida de acordo com os sete principais eventos de espera. O comando é o mesmo que o comando em [Recuperar métricas de contador](#performance-insights-metrics-api-examples.CounterMetrics). No entanto, o arquivo query.json tem o seguinte conteúdo.
```
[
{
"Metric": "db.load.avg",
"GroupBy": { "Group": "db.wait_state", "Limit": 7 }
}
]
```
Execute o seguinte comando.
Para Linux, macOS ou Unix:
```
aws pi get-resource-metrics \
--service-type DOCDB \
--identifier db-ID \
--start-time 2022-03-13T8:00:00Z \
--end-time 2022-03-13T9:00:00Z \
--period-in-seconds 60 \
--metric-queries file://query.json
```
Para Windows:
```
aws pi get-resource-metrics ^
--service-type DOCDB ^
--identifier db-ID ^
--start-time 2022-03-13T8:00:00Z ^
--end-time 2022-03-13T9:00:00Z ^
--period-in-seconds 60 ^
--metric-queries file://query.json
```
O exemplo especifica a métrica de `db.load.avg` e um `GroupBy` dos sete principais estados de espera. Para obter detalhes sobre valores válidos para esse exemplo, consulte [DimensionGroup](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_DimensionGroup.html)a *Referência da API Performance Insights.*
A resposta é semelhante à seguinte.
```
{
"AlignedStartTime": "2022-04-04T06:00:00+00:00",
"AlignedEndTime": "2022-04-04T06:15:00+00:00",
"Identifier": "db-NQF3TTMFQ3GTOKIMJODMC3KQQ4",
"MetricList": [
{//A list of key/datapoints
"Key": {
//A Metric with no dimensions. This is the total db.load.avg
"Metric": "db.load.avg"
},
"DataPoints": [
//Each list of datapoints has the same timestamps and same number of items
{
"Timestamp": "2022-04-04T06:01:00+00:00",//Minute1
"Value": 0.0
},
{
"Timestamp": "2022-04-04T06:02:00+00:00",//Minute2
"Value": 0.0
},
//... 60 datapoints for the total db.load.avg key
]
},
{
"Key": {
//Another key. This is db.load.avg broken down by CPU
"Metric": "db.load.avg",
"Dimensions": {
"db.wait_state.name": "CPU"
}
},
"DataPoints": [
{
"Timestamp": "2022-04-04T06:01:00+00:00",//Minute1
"Value": 0.0
},
{
"Timestamp": "2022-04-04T06:02:00+00:00",//Minute2
"Value": 0.0
},
//... 60 datapoints for the CPU key
]
},//... In total we have 3 key/datapoints entries, 1) total, 2-3) Top Wait States
] //end of MetricList
} //end of response
```
Nessa resposta, há três entradas no `MetricList`. Há uma entrada para o `db.load.avg` total, e três entradas cada para o `db.load.avg`, divididas de acordo com um dos três principais eventos de espera. Ao contrário do primeiro exemplo, como havia uma dimensão de agrupamento, deve haver uma chave para cada agrupamento da métrica. Não pode haver apenas uma chave para cada métrica, como no caso de uso de métricas de contador.
### Recuperar a média de carga de banco de dados para consulta principal
O exemplo a seguir agrupa `db.wait_state` pelas 10 principais instruções de consulta. Existem dois grupos diferentes para instruções de consulta:
+ `db.query` – a instrução de consulta completa, como `{"find":"customers","filter":{"FirstName":"Jesse"},"sort":{"key":{"$numberInt":"1"}}}`
+ `db.query_tokenized` – a instrução de consulta tokenizada, como `{"find":"customers","filter":{"FirstName":"?"},"sort":{"key":{"$numberInt":"?"}},"limit":{"$numberInt":"?"}}`
Ao analisar a performance do banco de dados, pode ser útil considerar instruções de consulta que diferem apenas por seus parâmetros como um item lógico. Então, você pode usar `db.query_tokenized` ao consultar. No entanto, especialmente quando você está interessado em `explain()`, às vezes é mais útil examinar instruções de consulta completas com parâmetros. Existe um relacionamento pai-filho entre as consultas tokenizadas e completas, com várias consultas completas (filhos) agrupadas sob a mesma consulta tokenizada (pai).
O comando neste exemplo é semelhante ao comando em [Recuperar a média de carga de banco de dados para eventos de espera superior](#performance-insights-metrics-api-examples.DBLoadAverage). No entanto, o arquivo query.json tem o seguinte conteúdo.
```
[
{
"Metric": "db.load.avg",
"GroupBy": { "Group": "db.query_tokenized", "Limit": 10 }
}
]
```
O exemplo a seguir usa `db.query_tokenized`.
Para Linux, macOS ou Unix:
```
aws pi get-resource-metrics \
--service-type DOCDB \
--identifier db-ID \
--start-time 2022-03-13T8:00:00Z \
--end-time 2022-03-13T9:00:00Z \
--period-in-seconds 3600 \
--metric-queries file://query.json
```
Para Windows:
```
aws pi get-resource-metrics ^
--service-type DOCDB ^
--identifier db-ID ^
--start-time 2022-03-13T8:00:00Z ^
--end-time 2022-03-13T9:00:00Z ^
--period-in-seconds 3600 ^
--metric-queries file://query.json
```
Este exemplo faz consultas em mais de 1 hora, com um minuto period-in-seconds.
O exemplo especifica a métrica de `db.load.avg` e um `GroupBy` dos sete principais estados de espera. Para obter detalhes sobre valores válidos para esse exemplo, consulte [DimensionGroup](https://docs.aws.amazon.com/performance-insights/latest/APIReference/API_DimensionGroup.html)a *Referência da API Performance Insights.*
A resposta é semelhante à seguinte.
```
{
"AlignedStartTime": "2022-04-04T06:00:00+00:00",
"AlignedEndTime": "2022-04-04T06:15:00+00:00",
"Identifier": "db-NQF3TTMFQ3GTOKIMJODMC3KQQ4",
"MetricList": [
{//A list of key/datapoints
"Key": {
"Metric": "db.load.avg"
},
"DataPoints": [
//... 60 datapoints for the total db.load.avg key
]
},
{
"Key": {//Next key are the top tokenized queries
"Metric": "db.load.avg",
"Dimensions": {
"db.query_tokenized.db_id": "pi-1064184600",
"db.query_tokenized.id": "77DE8364594EXAMPLE",
"db.query_tokenized.statement": "{\"find\":\"customers\",\"filter\":{\"FirstName\":\"?\"},\"sort\":{\"key\":{\"$numberInt\":\"?\"}},\"limit\"
:{\"$numberInt\":\"?\"},\"$db\":\"myDB\",\"$readPreference\":{\"mode\":\"primary\"}}"
}
},
"DataPoints": [
//... 60 datapoints
]
},
// In total 11 entries, 10 Keys of top tokenized queries, 1 total key
] //End of MetricList
} //End of response
```
Essa resposta tem 11 entradas no `MetricList` (1 total, 10 principais consultas tokenizadas), e cada entrada com 24 `DataPoints` por hora.
Para consultas tokenizadas, existem três entradas em cada lista de dimensões:
+ `db.query_tokenized.statement` – a instrução de consulta tokenizada.
+ `db.query_tokenized.db_id `— O ID sintético que o Performance Insights gera para você. Este exemplo retorna o ID sintético `pi-1064184600`.
+ `db.query_tokenized.id` – o ID da consulta dentro do Performance Insights.
No Console de gerenciamento da AWS, esse ID é chamado de Support ID. Tem esse nome porque o ID é um dado que o AWS Support pode examinar para ajudá-lo a solucionar um problema com seu banco de dados. AWS leva a segurança e a privacidade de seus dados extremamente a sério, e quase todos os dados são armazenados criptografados com você AWS KMS key. Portanto, ninguém lá dentro AWS pode ver esses dados. No exemplo precedente, `tokenized.statement` e `tokenized.db_id` são armazenados em formato criptografado. Se você tiver um problema com seu banco de dados, o AWS Support pode ajudá-lo referenciando o Support ID.
Ao consultar, pode ser conveniente especificar `Group` em `GroupBy`. No entanto, para um controle mais refinado sobre os dados retornados, especifique a lista de dimensões. Por exemplo, se tudo o que for necessário for o `db.query_tokenized.statement`, um atributo `Dimensions` poderá ser adicionado ao arquivo query.json.
```
[
{
"Metric": "db.load.avg",
"GroupBy": {
"Group": "db.query_tokenized",
"Dimensions":["db.query_tokenized.statement"],
"Limit": 10
}
}
]
```
### Recuperação da média de carga de banco de dados filtrada por Consulta
A consulta da API correspondente neste exemplo é semelhante ao comando em [Recuperar a média de carga de banco de dados para consulta principal](#performance-insights-metrics-api-examples.topquery). No entanto, o arquivo query.json tem o seguinte conteúdo.
```
[
{
"Metric": "db.load.avg",
"GroupBy": { "Group": "db.wait_state", "Limit": 5 },
"Filter": { "db.query_tokenized.id": "AKIAIOSFODNN7EXAMPLE" }
}
]
```
Nessa resposta, todos os valores são filtrados de acordo com a contribuição da consulta tokenizada AKIAIOSFODNN7 EXAMPLE especificada no arquivo query.json. As chaves também podem seguir uma ordem diferente de uma consulta sem um filtro, porque são os cinco principais estados de espera que afetaram a consulta filtrada.
# CloudWatch Métricas da Amazon para Performance Insights
O Performance Insights publica automaticamente métricas na Amazon CloudWatch. Os mesmos dados podem ser consultados no Performance Insights, mas ter as métricas inseridas CloudWatch facilita a adição de CloudWatch alarmes. Também facilita a adição de métricas aos painéis do CloudWatch existentes.
| Métrica | Description |
| --- | --- |
| DBLoad | O número de sessões ativas do Amazon DocumentDB. Normalmente, você deseja os dados para o número médio de sessões ativas. No Performance Insights, esses dados são consultados como `db.load.avg`. |
| DBLoadCPU | O número de sessões ativas em que o tipo do estado de espera é CPU. No Performance Insights, esses dados são consultados como `db.load.avg`, filtrados pelo tipo de estado de espera `CPU`. |
| DBLoadSem CPU | O número de sessões ativas em que o tipo do estado de espera não é CPU. |
**nota**
Essas métricas são publicadas CloudWatch somente se houver carga na instância de banco de dados.
Você pode examinar essas métricas usando o CloudWatch console AWS CLI, o ou a CloudWatch API.
Por exemplo, você pode obter as estatísticas da `DBLoad` métrica executando o [get-metric-statistics](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/get-metric-statistics.html)comando.
```
aws cloudwatch get-metric-statistics \
--region ap-south-1 \
--namespace AWS/DocDB \
--metric-name DBLoad \
--period 360 \
--statistics Average \
--start-time 2022-03-14T8:00:00Z \
--end-time 2022-03-14T9:00:00Z \
--dimensions Name=DBInstanceIdentifier,Value=documentdbinstance
```
Este exemplo gera uma saída semelhante à seguinte.
```
{
"Datapoints": [
{
"Timestamp": "2022-03-14T08:42:00Z",
"Average": 1.0,
"Unit": "None"
},
{
"Timestamp": "2022-03-14T08:24:00Z",
"Average": 2.0,
"Unit": "None"
},
{
"Timestamp": "2022-03-14T08:54:00Z",
"Average": 6.0,
"Unit": "None"
},
{
"Timestamp": "2022-03-14T08:36:00Z",
"Average": 5.7,
"Unit": "None"
},
{
"Timestamp": "2022-03-14T08:06:00Z",
"Average": 4.0,
"Unit": "None"
},
{
"Timestamp": "2022-03-14T08:00:00Z",
"Average": 5.2,
"Unit": "None"
}
],
"Label": "DBLoad"
}
```
Você pode usar a função matemática `DB_PERF_INSIGHTS` métrica no CloudWatch console para consultar as métricas do contador do Amazon DocumentDB Performance Insights. A função `DB_PERF_INSIGHTS` também inclui a métrica `DBLoad` em intervalos de menos de um minuto. Você pode definir CloudWatch alarmes para essas métricas. Para obter mais detalhes sobre como criar um alarme, consulte [Criar um alarme nas métricas de contador do Performance Insights de um AWS banco de dados](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_alarm_database_performance_insights.html).
Para obter mais informações sobre CloudWatch, consulte [O que é a Amazon CloudWatch?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) no *Guia do CloudWatch usuário da Amazon*.
# Métricas de contadores do Performance Insights
Métricas de contador são métricas de performance do sistema operacional no painel do Performance Insights. Para ajudar a identificar e analisar problemas de performance, é possível correlacionar métricas de contadores com a carga de banco de dados.
## Contadores de sistema operacional do Performance Insights
Os contadores de sistema operacional a seguir estão disponíveis no Performance Insights para o Amazon DocumentDB.
| Contador | Type | Métrica |
| --- | --- | --- |
| ativo | memory | os.memory.active |
| buffers | memory | os.memory.buffers |
| cached | memory | os.memory.cached |
| dirty | memory | os.memory.dirty |
| free | memory | os.memory.free |
| inactive | memory | os.memory.inactive |
| mapped | memory | os.memory.mapped |
| pageTables | memory | os.memory.pageTables |
| slab | memory | os.memory.slab |
| total | memory | os.memory.total |
| writeback | memory | os.memory.writeback |
| idle | cpuUtilization | os.cpuUtilization.idle |
| system | cpuUtilization | os.cpuUtilization.system |
| total | cpuUtilization | os.cpuUtilization.total |
| user | cpuUtilization | os.cpuUtilization.user |
| wait | cpuUtilization | os.cpuUtilization.wait |
| one | loadAverageMinute | então. loadAverageMinute.um |
| fifteen | loadAverageMinute | então. loadAverageMinute.quinze |
| cinco | loadAverageMinute | então. loadAverageMinute.cinco |
| cached | swap | os.swap.cached |
| free | swap | os.swap.free |
| em | swap | os.swap.in |
| out | swap | os.swap.out |
| total | swap | os.swap.total |
| rx | network | os.network.rx |
| tx | network | os.network.tx |
| núm VCPUs | general | os.general.num VCPUs |