

# Conceitos básicos do CloudWatch Contributor Insights para DynamoDB
<a name="contributorinsights_tutorial"></a>

Esta seção descreve como habilitar e usar o Amazon CloudWatch Contributor Insights em diferentes modos por meio do console do Amazon DynamoDB ou da AWS Command Line Interface (AWS CLI) para atender às suas necessidades de monitoramento. 

Nos exemplos a seguir, você usará a tabela do DynamoDB definida no tutorial [Conceitos básicos do DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GettingStartedDynamoDB.html).

**Topics**
+ [Escolher um modo do Contributor Insights](#contributorinsights_tutorial.modes)
+ [Usar o Contributor Insights (console)](#usecontributorinsights_console)
+ [Uso do Contributor Insights (AWS CLI)](#usecontributorinsights_cli)

## Escolher um modo do Contributor Insights
<a name="contributorinsights_tutorial.modes"></a>

Antes de habilitar o Contributor Insights, você deve entender como funcionam os dois modos disponíveis. Analise a comparação de modos para selecionar a opção mais adequada aos seus requisitos específicos.


| Aspecto | Modo de chaves acessadas e limitadas | modo de chaves limitadas | 
| --- | --- | --- | 
| Monitores | Todas as solicitações (bem-sucedidas e limitadas) | Somente solicitações limitadas | 
| Grafos | Itens mais acessados \$1 itens com utilização mais limitada | Somente itens com utilização mais limitada | 
| Melhor para | Análise e otimização direcionadas | Monitoramento do controle de utilização | 
| Use quando | Precisar de visibilidade completa dos padrões de acesso. Estiver realizando análises ou depurações de curto prazo. | Sua principal preocupação for identificar e resolver problemas de controle de utilização. Desejar manter o Contributor Insights habilitado continuamente para detecção de controle de utilização em tempo real. | 

## Usar o Contributor Insights (console)
<a name="usecontributorinsights_console"></a>

O console oferece uma maneira intuitiva de habilitar o Contributor Insights e selecionar o modo apropriado para suas necessidades de monitoramento.

**Como usar o Contributor Insights no console**

1. Faça login no Console de gerenciamento da AWS e abra o console do DynamoDB em [https://console.aws.amazon.com/dynamodb/](https://console.aws.amazon.com/dynamodb/).

1. No painel de navegação, no lado esquerdo do console, selecione **Tables** (Tabelas).

1. Escolha a tabela `Music`.

1. Escolha a guia **Monitor** (Monitorar).

1. Escolha **Gerenciar o CloudWatch Contributor Insights**.  
![\[Captura de tela do console mostrando o botão e a guia do monitor.\]](http://docs.aws.amazon.com/pt_br/amazondynamodb/latest/developerguide/images/CI_ChooseAndManageNew.PNG)

1. Na caixa de diálogo **Gerenciar configurações do CloudWatch Contributor Insights**, marque **Ativar** para a tabela base `Music` e o índice secundário global `AlbumTitle-index`.

1. Deixe a opção **Apenas modo de chaves limitadas** na posição desativada para ambos e escolha **Salvar alterações.**  
![\[Captura de tela do console mostrando as opções da lista de status do Contributor Insights.\]](http://docs.aws.amazon.com/pt_br/amazondynamodb/latest/developerguide/images/CI_Enable.png)

   Isso habilita o modo padrão de *chaves acessadas e limitadas* para a tabela e o GSI, que oferece o monitoramento de itens acessados e limitados. Alternar **Apenas modo de chaves limitadas** para a posição ativada habilita o modo de *chaves limitadas*.

   Se a operação falhar, consulte [DescribeContributorInsights FailureException](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeContributorInsights.html#DDB-DescribeContributorInsights-response-FailureException) na *Referência da API do Amazon DynamoDB* em busca de possíveis razões.

1. Os grafos do CloudWatch Contributor Insights agora estão visíveis na guia **Monitor** para a tabela `Music`. Como você habilitou o modo de *chaves acessadas e limitadas*, é possível ver grafos de itens acessados e limitados.  
![\[Captura de tela do console mostrando a guia Contributor Insights com vários gráficos para a tabela de música.\]](http://docs.aws.amazon.com/pt_br/amazondynamodb/latest/developerguide/images/CI_Graphs.png)

### Alternar entre os modos
<a name="usecontributorinsights_console.switching-modes"></a>

É possível alternar entre os modos a qualquer momento sem desabilitar o Contributor Insights.

**Como alternar entre os modos do Contributor Insights**

1. Na guia **Monitor** da tabela, escolha **Gerenciar o CloudWatch Contributor Insights**.

1. Na caixa de diálogo **Gerenciar configurações do CloudWatch Contributor Insights**, para cada tabela base ou GSI:
   + Ative ou desative **Apenas modo de chaves limitadas** para habilitar o modo de *chaves limitadas* ou volte para o modo padrão de *chaves acessadas e limitadas*.
   + Marque ou desmarque **Ativar** para desabilitar o CloudWatch Contributor Insights para uma tabela ou GSI.

1. Escolha **Salvar alterações**.

   Depois de concluído, os grafos mostrarão o novo modo.

### Criar alarmes do CloudWatch
<a name="usecontributorinsights_console_alarms"></a>

Siga as etapas abaixo para criar um alarme do CloudWatch e receber notificação quando uma chave de partição consumir mais de 50 mil [ConsumedThroughputUnits](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights_HowItWorks.html#contributorinsights_HowItWorks.Graphs.most-accessed) ou sofrer controle de utilização.

1. Faça login no Console de gerenciamento da AWS e abra o console do CloudWatch em [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/).

1. No painel de navegação à esquerda do console, escolha **Contributor Insights**.

1. Escolha a regra apropriada com base no modo escolhido e no que você deseja monitorar:
   + Para monitoramento de itens acessados (apenas modo de chaves acessadas e limitadas): escolha **DynamoDBContributorInsights-PKC-Music**.
   + Para monitoramento de itens limitados (ambos os modos): escolha **DynamoDBContributorInsights-PKT-Music**.

1. Selecione a lista suspensa **Actions** (Ações).

1. Escolha **View in metrics** (Exibir nas métricas).

1. Escolha **Max Contributor Value** (Valor máximo do colaborador).
**nota**  
Somente `Max Contributor Value` e `Maximum` retornam estatísticas úteis. As outras estatísticas dessa lista não retornam valores significativos.  
![\[Captura de tela do console mostrando a guia Contributor Insights e botão.\]](http://docs.aws.amazon.com/pt_br/amazondynamodb/latest/developerguide/images/CI_AlarmsViewinMetrics.png)

1. Na coluna **Actions** (Ações), escolha **Create Alarm** (Criar alarme).  
![\[Captura de tela do console mostrando as opções da lista de status do Contributor Insights.\]](http://docs.aws.amazon.com/pt_br/amazondynamodb/latest/developerguide/images/CI_AlarmsSetAlarm.png)

1. Insira um valor limite apropriado e escolha **Próximo**:
   + Para itens acessados (regras PKC): insira 50 mil para `ConsumedThroughputUnits`.
   + Para itens limitados (regras PKT): insira 1 para `ThrottleCount` para receber alertas sobre qualquer controle de utilização.  
![\[Captura de tela do console mostrando a guia Contributor Insights e botão.\]](http://docs.aws.amazon.com/pt_br/amazondynamodb/latest/developerguide/images/CI_AlarmsSetAlarmThreashold.png)

1.  Consulte [Usar os alarmes do Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html) para obter detalhes sobre como configurar a notificação para o alarme.

## Uso do Contributor Insights (AWS CLI)
<a name="usecontributorinsights_cli"></a>

A AWS CLI oferece acesso programático ao Contributor Insights com compatibilidade total para os dois modos. Você pode especificar o modo ao habilitar o Contributor Insights ou alternar de modo posteriormente.

### Operações básicas com o modo padrão
<a name="usecontributorinsights_cli.basic"></a>

**Como usar o Contributor Insights com as configurações padrão**

1. Habilite o CloudWatch Contributor Insights para DynamoDB na tabela base `Music` com o modo de *chaves acessadas e limitadas*. Como `ACCESSED_AND_THROTTLED_KEYS` é o modo padrão, é possível omitir o parâmetro `--contributor-insights-mode=ACCESSED_AND_THROTTLED_KEYS`.

   ```
   aws dynamodb update-contributor-insights \
                       --table-name Music \
                       --contributor-insights-action=ENABLE
   ```

1. Habilite o Contributor Insights para DynamoDB no índice secundário global `AlbumTitle-index`.

   ```
   aws dynamodb update-contributor-insights \
                       --table-name Music \
                       --index-name AlbumTitle-index \
                       --contributor-insights-action=ENABLE
   ```

1. Obtenha o status e as regras da tabela `Music` e todos os seus índices.

   ```
   aws dynamodb describe-contributor-insights 
                       --table-name Music
   ```

   A resposta incluirá o campo `ContributorInsightsMode` mostrando `ACCESSED_AND_THROTTLED_KEYS`.

1. Obtenha o status da tabela `Music` e de todos os respectivos índices.

   ```
   aws dynamodb list-contributor-insights --table-name Music
   ```

### Habilitar o modo de chaves limitadas
<a name="usecontributorinsights_cli.throttled-mode"></a>

**Como usar o Contributor Insights no modo de chaves limitadas**

1. Habilite o CloudWatch Contributor Insights para DynamoDB na tabela base `Music` com o modo de *chaves limitadas*.

   ```
   aws dynamodb update-contributor-insights \
       --table-name Music \
       --contributor-insights-action=ENABLE \
       --contributor-insights-mode=THROTTLED_KEYS
   ```

1. Habilite o Contributor Insights no modo de *chaves limitadas* para o índice secundário global `AlbumTitle-index`.

   ```
   aws dynamodb update-contributor-insights \
       --table-name Music \
       --index-name AlbumTitle-index \
       --contributor-insights-action=ENABLE \
       --contributor-insights-mode=THROTTLED_KEYS
   ```

1. Descreva a configuração do Contributor Insights para verificar o modo.

   ```
   aws dynamodb describe-contributor-insights --table-name Music
   ```

   A resposta exibirá `ContributorInsightsMode` como `THROTTLED_KEYS` e menos regras em comparação com o modo padrão.

### Alternar entre os modos
<a name="usecontributorinsights_cli.switching-modes"></a>

**Como alternar entre os modos do Contributor Insights**

1. Alterne do modo de *chaves limitadas* para o modo de *chaves acessadas e limitadas*.

   ```
   aws dynamodb update-contributor-insights \
       --table-name Music \
       --contributor-insights-action=ENABLE \
       --contributor-insights-mode=ACCESSED_AND_THROTTLED_KEYS
   ```

1. Alterne do modo de *chaves acessadas e limitadas* para o modo de *chaves limitadas*.

   ```
   aws dynamodb update-contributor-insights \
       --table-name Music \
       --contributor-insights-action=ENABLE \
       --contributor-insights-mode=THROTTLED_KEYS
   ```

1. Verifique o status durante a transição.

   ```
   aws dynamodb describe-contributor-insights --table-name Music
   ```

   Durante a mudança de modo, `ContributorInsightsStatus` será exibido como `ENABLING`. Assim que concluída, o status será exibido como `ENABLED` no novo modo.

### Gerenciar relatórios do Contributor Insights
<a name="usecontributorinsights_cli.management"></a>

**Como gerenciar as configurações do Contributor Insights**

1. Desabilite o CloudWatch Contributor Insights para DynamoDB no índice secundário global `AlbumTitle-index`.

   ```
   aws dynamodb update-contributor-insights \
                       --table-name Music --index-name AlbumTitle-index \
                       --contributor-insights-action=DISABLE
   ```

1. Liste todas as configurações do Contributor Insights em sua conta.

   ```
   aws dynamodb list-contributor-insights
   ```

   Isso mostra todos os índices e tabelas com o Contributor Insights habilitado, bem como os respectivos modos.

1. Obtenha informações detalhadas sobre uma configuração específica.

   ```
   aws dynamodb describe-contributor-insights \
                       --table-name Music \
                       --index-name AlbumTitle-index
   ```

### Exemplos de resposta
<a name="usecontributorinsights_cli.examples"></a>

Veja abaixo exemplos de resposta que mostram as diferenças entre os modos:

#### Resposta no modo de chaves acessadas e limitadas
<a name="usecontributorinsights_cli.examples.accessed-throttled"></a>

```
{
    "TableName": "Music",
    "ContributorInsightsRuleList": [
        "DynamoDBContributorInsights-PKC-Music-1234567890123",
        "DynamoDBContributorInsights-PKT-Music-1234567890123",
        "DynamoDBContributorInsights-SKC-Music-1234567890123",
        "DynamoDBContributorInsights-SKT-Music-1234567890123"
    ],
    "ContributorInsightsStatus": "ENABLED",
    "ContributorInsightsMode": "ACCESSED_AND_THROTTLED_KEYS",
    "LastUpdateDateTime": "2024-01-15T10:30:00.000Z"
}
```

#### Resposta no modo de chaves limitadas
<a name="usecontributorinsights_cli.examples.throttled-only"></a>

```
{
    "TableName": "Music",
    "ContributorInsightsRuleList": [
        "DynamoDBContributorInsights-PKT-Music-1234567890123",
        "DynamoDBContributorInsights-SKT-Music-1234567890123"
    ],
    "ContributorInsightsStatus": "ENABLED",
    "ContributorInsightsMode": "THROTTLED_KEYS",
    "LastUpdateDateTime": "2024-01-15T10:35:00.000Z"
}
```

Observe que o modo de chaves limitadas tem menos regras (apenas PKT e SKT), o que corresponde a um monitoramento mais direcionado.