Exemplos do CloudWatch usando o AWS CLI - AWS Command Line Interface
Ações

Exemplos do CloudWatch usando o AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o CloudWatch.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

O código de exemplo a seguir mostra como usar delete-alarms.

AWS CLI

Como excluir um alarme

O seguinte exemplo usa o comando delete-alarms para excluir o alarme “myalarm” do Amazon CloudWatch:

aws cloudwatch delete-alarms --alarm-names myalarm

Saída:

This command returns to the prompt if successful.

  • Para obter detalhes da API, consulte DeleteAlarms na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-anomaly-detector.

AWS CLI

Para excluir um modelo específico de detecção de anomalias

O exemplo delete-anomaly-detector a seguir exclui um modelo de detector de anomalias na conta específica.

aws cloudwatch delete-anomaly-detector \
    --namespace AWS/Logs \
    --metric-name IncomingBytes \
    --stat SampleCount

Este comando não produz saída.

Para obter mais informações, consulte Excluir um modelo de detecção de anomalias no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar delete-dashboards.

AWS CLI

Para excluir painéis específicos

O exemplo delete-dashboards a seguir exclui dois painéis denominados Dashboard-A e Dashboard-B na conta específica.

aws cloudwatch delete-dashboards \
    --dashboard-names Dashboard-A Dashboard-B

Este comando não produz saída.

Para obter mais informações, consulte Painéis do Amazon CloudWatch no Guiado usuário do Amazon CloudWatch.

  • Para obter detalhes da API, consulte DeleteDashboards na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-insight-rules.

AWS CLI

Como excluir regras específicas do Contributor Insights

O exemplo de delete-insight-rules a seguir exclui duas regras do Contributor Insights chamadas Rule-A e Rule-B na conta específica.

aws cloudwatch delete-insight-rules \
    --rule-names Rule-A Rule-B

Saída:

{
    "Failures": []
}

Consulte mais informações em Usar o Contributor Insights para analisar dados de alta cardinalidade no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar delete-metric-stream.

AWS CLI

Como excluir um fluxo de métricas especificado

O exemplo de delete-metric-stream a seguir exclui o fluxo de métricas chamado QuickPartial-gSCKvO na conta especificada.

aws cloudwatch delete-metric-stream \
    --name QuickPartial-gSCKvO

Este comando não produz saída.

Consulte mais informações em Usar fluxos de métricas no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar describe-alarm-history.

AWS CLI

Para recuperar o histórico de um alarme

O seguinte exemplo usa o comando describe-alarm-history para recuperar o histórico do alarme “myalarm” do Amazon CloudWatch:

aws cloudwatch describe-alarm-history --alarm-name "myalarm" --history-item-type StateUpdate

Saída:

{
    "AlarmHistoryItems": [
        {
            "Timestamp": "2014-04-09T18:59:06.442Z",
            "HistoryItemType": "StateUpdate",
            "AlarmName": "myalarm",
            "HistoryData": "{\"version\":\"1.0\",\"oldState\":{\"stateValue\":\"ALARM\",\"stateReason\":\"testing purposes\"},\"newState\":{\"stateValue\":\"OK\",\"stateReason\":\"Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].\",\"stateReasonData\":{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}}}",
            "HistorySummary": "Alarm updated from ALARM to OK"
        },
        {
            "Timestamp": "2014-04-09T18:59:05.805Z",
            "HistoryItemType": "StateUpdate",
            "AlarmName": "myalarm",
            "HistoryData": "{\"version\":\"1.0\",\"oldState\":{\"stateValue\":\"OK\",\"stateReason\":\"Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.839999999999996, 39.714].\",\"stateReasonData\":{\"version\":\"1.0\",\"queryDate\":\"2014-03-11T22:45:41.569+0000\",\"startDate\":\"2014-03-11T22:30:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.839999999999996,39.714],\"threshold\":70.0}},\"newState\":{\"stateValue\":\"ALARM\",\"stateReason\":\"testing purposes\"}}",
            "HistorySummary": "Alarm updated from OK to ALARM"
        }
    ]
}

O código de exemplo a seguir mostra como usar describe-alarms-for-metric.

AWS CLI

Como exibir informações sobre os alarmes associados a uma métrica

O seguinte exemplo usa o comando describe-alarms-for-metric para exibir informações sobre qualquer alarme associado à métrica CPUUtilization do Amazon EC2 e à instância com o ID i-0c986c72.:

aws cloudwatch describe-alarms-for-metric --metric-name CPUUtilization --namespace AWS/EC2 --dimensions Name=InstanceId,Value=i-0c986c72

Saída:

{
    "MetricAlarms": [
        {
            "EvaluationPeriods": 10,
            "AlarmArn": "arn:aws:cloudwatch:us-east-1:111122223333:alarm:myHighCpuAlarm2",
            "StateUpdatedTimestamp": "2013-10-30T03:03:51.479Z",
            "AlarmConfigurationUpdatedTimestamp": "2013-10-30T03:03:50.865Z",
            "ComparisonOperator": "GreaterThanOrEqualToThreshold",
            "AlarmActions": [
                "arn:aws:sns:us-east-1:111122223333:NotifyMe"
            ],
            "Namespace": "AWS/EC2",
            "AlarmDescription": "CPU usage exceeds 70 percent",
            "StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2013-10-30T03:03:51.479+0000\",\"startDate\":\"2013-10-30T02:08:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[40.698,39.612,42.432,39.796,38.816,42.28,42.854,40.088,40.760000000000005,41.316],\"threshold\":70.0}",
            "Period": 300,
            "StateValue": "OK",
            "Threshold": 70.0,
            "AlarmName": "myHighCpuAlarm2",
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "i-0c986c72"
                }
            ],
            "Statistic": "Average",
            "StateReason": "Threshold Crossed: 10 datapoints were not greater than or equal to the threshold (70.0). The most recent datapoints: [40.760000000000005, 41.316].",
            "InsufficientDataActions": [],
            "OKActions": [],
            "ActionsEnabled": true,
            "MetricName": "CPUUtilization"
        },
        {
            "EvaluationPeriods": 2,
            "AlarmArn": "arn:aws:cloudwatch:us-east-1:111122223333:alarm:myHighCpuAlarm",
            "StateUpdatedTimestamp": "2014-04-09T18:59:06.442Z",
            "AlarmConfigurationUpdatedTimestamp": "2014-04-09T22:26:05.958Z",
            "ComparisonOperator": "GreaterThanThreshold",
            "AlarmActions": [
                "arn:aws:sns:us-east-1:111122223333:HighCPUAlarm"
            ],
            "Namespace": "AWS/EC2",
            "AlarmDescription": "CPU usage exceeds 70 percent",
            "StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}",
            "Period": 300,
            "StateValue": "OK",
            "Threshold": 70.0,
            "AlarmName": "myHighCpuAlarm",
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "i-0c986c72"
                }
            ],
            "Statistic": "Average",
            "StateReason": "Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].",
            "InsufficientDataActions": [],
            "OKActions": [],
            "ActionsEnabled": false,
            "MetricName": "CPUUtilization"
        }
    ]
}

O código de exemplo a seguir mostra como usar describe-alarms.

AWS CLI

Para listar informações sobre um alarme

O seguinte exemplo usa o comando describe-alarms para fornecer informações sobre o alarme chamado “myalarm”:

aws cloudwatch describe-alarms --alarm-names "myalarm"

Saída:

{
    "MetricAlarms": [
        {
            "EvaluationPeriods": 2,
            "AlarmArn": "arn:aws:cloudwatch:us-east-1:123456789012:alarm:myalarm",
            "StateUpdatedTimestamp": "2014-04-09T18:59:06.442Z",
            "AlarmConfigurationUpdatedTimestamp": "2012-12-27T00:49:54.032Z",
            "ComparisonOperator": "GreaterThanThreshold",
            "AlarmActions": [
                "arn:aws:sns:us-east-1:123456789012:myHighCpuAlarm"
            ],
            "Namespace": "AWS/EC2",
            "AlarmDescription": "CPU usage exceeds 70 percent",
            "StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}",
            "Period": 300,
            "StateValue": "OK",
            "Threshold": 70.0,
            "AlarmName": "myalarm",
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "i-0c986c72"
                }
            ],
            "Statistic": "Average",
            "StateReason": "Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].",
            "InsufficientDataActions": [],
            "OKActions": [],
            "ActionsEnabled": true,
            "MetricName": "CPUUtilization"
        }
    ]
}

  • Para obter detalhes da API, consulte DescribeAlarms na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-anomaly-detectors.

AWS CLI

Para recuperar uma lista de modelos de detecção de anomalias

O exemplo describe-anomaly-detectors a seguir exibe informações sobre modelos de detectores de anomalias associados ao namespace AWS/Logs na conta específica.

aws cloudwatch describe-anomaly-detectors \
    --namespace AWS/Logs

Saída:

{
    "AnomalyDetectors": [
        {
            "Namespace": "AWS/Logs",
            "MetricName": "IncomingBytes",
            "Dimensions": [],
            "Stat": "SampleCount",
            "Configuration": {
                "ExcludedTimeRanges": []
            },
            "StateValue": "TRAINED",
            "SingleMetricAnomalyDetector": {
                "AccountId": "123456789012",
                "Namespace": "AWS/Logs",
                "MetricName": "IncomingBytes",
                "Dimensions": [],
                "Stat": "SampleCount"
            }
        },
        {
            "Namespace": "AWS/Logs",
            "MetricName": "IncomingBytes",
            "Dimensions": [
                {
                    "Name": "LogGroupName",
                    "Value": "demo"
                }
            ],
            "Stat": "Average",
            "Configuration": {
                "ExcludedTimeRanges": []
            },
            "StateValue": "PENDING_TRAINING",
            "SingleMetricAnomalyDetector": {
                "AccountId": "123456789012",
                "Namespace": "AWS/Logs",
                "MetricName": "IncomingBytes",
                "Dimensions": [
                    {
                        "Name": "LogGroupName",
                        "Value": "demo"
                    }
                ],
                "Stat": "Average"
            }
        }
    ]
}

Para obter mais informações, consulte Usar a detecção de anomalias do CloudWatch no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar describe-insight-rules.

AWS CLI

Como recuperar uma lista de regras do Contributor Insights

O exemplo de describe-insight-rules a seguir mostra todas as regras do Contributor Insights na conta especificada.

aws cloudwatch describe-insight-rules

Saída:

{
    "InsightRules": [
        {
            "Name": "Rule-A",
            "State": "ENABLED",
            "Schema": "CloudWatchLogRule/1",
            "Definition": "{\n\t\"AggregateOn\": \"Count\",\n\t\"Contribution\": {\n\t\t\"Filters\": [],\n\t\t\"Keys\": [\n\t\t\t\"$.requestId\"\n\t\t]\n\t},\n\t\"LogFormat\": \"JSON\",\n\t\"Schema\": {\n\t\t\"Name\": \"CloudWatchLogRule\",\n\t\t\"Version\": 1\n\t},\n\t\"LogGroupARNs\": [\n\t\t\"arn:aws:logs:us-east-1:123456789012:log-group:demo\"\n\t]\n}",
            "ManagedRule": false
        },
        {
            "Name": "Rule-B",
            "State": "ENABLED",
            "Schema": "CloudWatchLogRule/1",
            "Definition": "{\n\t\"AggregateOn\": \"Count\",\n\t\"Contribution\": {\n\t\t\"Filters\": [],\n\t\t\"Keys\": [\n\t\t\t\"$.requestId\"\n\t\t]\n\t},\n\t\"LogFormat\": \"JSON\",\n\t\"Schema\": {\n\t\t\"Name\": \"CloudWatchLogRule\",\n\t\t\"Version\": 1\n\t},\n\t\"LogGroupARNs\": [\n\t\t\"arn:aws:logs:us-east-1:123456789012:log-group:demo-1\"\n\t]\n}",
            "ManagedRule": false
        }
    ]
}

Consulte mais informações em Usar o Contributor Insights para analisar dados de alta cardinalidade no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar disable-alarm-actions.

AWS CLI

Como desativar ações de um alarme

O seguinte exemplo usa o comando disable-alarm-actions para desabilitar todas as ações do alarme “myalarm”:

aws cloudwatch disable-alarm-actions --alarm-names myalarm

Esse comando retornará ao prompt, se houver êxito.

  • Para obter detalhes da API, consulte DisableAlarmActions na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar disable-insight-rules.

AWS CLI

Como desabilitar regras especificadas do Contributor Insights

O exemplo de disable-insight-rules a seguir desabilita duas regras do Contributor Insights chamadas Rule-A e Rule-B na conta especificada.

aws cloudwatch disable-insight-rules \
    --rule-names Rule-A Rule-B

Saída:

{
    "Failures": []
}

Consulte mais informações em Usar o Contributor Insights para analisar dados de alta cardinalidade no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar enable-alarm-actions.

AWS CLI

Para habilitar todas as ações de um alarme

O seguinte exemplo usa o comando enable-alarm-actions para habilitar todas as ações para o alarme “myalarm”:

aws cloudwatch enable-alarm-actions --alarm-names myalarm

Esse comando retornará ao prompt, se tiver êxito.

  • Para obter detalhes da API, consulte EnableAlarmActions na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar enable-insight-rules.

AWS CLI

Como habilitar regras especificadas do Contributor Insights

O exemplo de enable-insight-rules a seguir habilita duas regras do Contributor Insights chamadas Rule-A e Rule-B na conta especificada.

aws cloudwatch enable-insight-rules \
    --rule-names Rule-A Rule-B

Saída:

{
    "Failures": []
}

Consulte mais informações em Usar o Contributor Insights para analisar dados de alta cardinalidade no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar get-dashboard.

AWS CLI

Para recuperar informações sobre um painel

O exemplo get-dashboard a seguir exibe as informações sobre o painel denominado Dashboard-A na conta específica.

aws cloudwatch get-dashboard \
    --dashboard-name Dashboard-A

Saída:

{
    "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-A",
    "DashboardBody": "{\"widgets\":[{\"type\":\"metric\",\"x\":0,\"y\":0,\"width\":6,\"height\":6,\"properties\":{\"view\":\"timeSeries\",\"stacked\":false,\"metrics\":[[\"AWS/EC2\",\"NetworkIn\",\"InstanceId\",\"i-0131f062232ade043\"],[\".\",\"NetworkOut\",\".\",\".\"]],\"region\":\"us-east-1\"}}]}",
    "DashboardName": "Dashboard-A"
}

Para obter mais informações, consulte Painéis do Amazon CloudWatch no Guiado usuário do Amazon CloudWatch.

  • Para obter detalhes da API, consulte GetDashboard na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-insight-rule-report.

AWS CLI

Como recuperar os dados de séries temporais coletados por uma regra do Contributor Insights

O exemplo de get-insight-rule-report a seguir retorna os dados de séries temporais coletados por uma regra do Contributor Insights.

aws cloudwatch get-insight-rule-report \
    --rule-name Rule-A \
    --start-time 2024-10-13T20:15:00Z \
    --end-time 2024-10-13T20:30:00Z \
    --period 300

Saída:

{
    "KeyLabels": [
        "PartitionKey"
    ],
    "AggregationStatistic": "Sum",
    "AggregateValue": 0.5,
    "ApproximateUniqueCount": 1,
    "Contributors": [
        {
            "Keys": [
                "RequestID"
            ],
            "ApproximateAggregateValue": 0.5,
            "Datapoints": [
                {
                    "Timestamp": "2024-10-13T21:00:00+00:00",
                    "ApproximateValue": 0.5
                }
            ]
        }
    ],
    "RuleAttributes": []
}

Consulte mais informações em Usar o Contributor Insights para analisar dados de alta cardinalidade no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar get-metric-data.

AWS CLI

Exemplo 1: para obter a média total de IOPS para o EC2 especificado usando a expressão matemática

O exemplo get-metric-data a seguir recupera os valores de métricas do CloudWatch para a instância do EC2 com InstanceID i-abcdef usando uma expressão matemática métrica que combina as métricas EBSReadOps e EBSWriteOps.

aws cloudwatch get-metric-data \
    --metric-data-queries file://file.json \
    --start-time 2024-09-29T22:10:00Z \
    --end-time 2024-09-29T22:15:00Z

Conteúdo de file.json:

[
    {
        "Id": "m3",
        "Expression": "(m1+m2)/300",
        "Label": "Avg Total IOPS"
    },
    {
        "Id": "m1",
        "MetricStat": {
            "Metric": {
                "Namespace": "AWS/EC2",
                "MetricName": "EBSReadOps",
                "Dimensions": [
                    {
                        "Name": "InstanceId",
                        "Value": "i-abcdef"
                    }
                ]
            },
            "Period": 300,
            "Stat": "Sum",
            "Unit": "Count"
        },
        "ReturnData": false
    },
    {
        "Id": "m2",
        "MetricStat": {
            "Metric": {
                "Namespace": "AWS/EC2",
                "MetricName": "EBSWriteOps",
                "Dimensions": [
                    {
                        "Name": "InstanceId",
                        "Value": "i-abcdef"
                    }
                ]
            },
            "Period": 300,
            "Stat": "Sum",
            "Unit": "Count"
        },
        "ReturnData": false
    }
]

Saída:

{
    "MetricDataResults": [
        {
            "Id": "m3",
            "Label": "Avg Total IOPS",
            "Timestamps": [
                "2024-09-29T22:10:00+00:00"
            ],
            "Values": [
                96.85
            ],
            "StatusCode": "Complete"
        }
    ],
    "Messages": []
}

Exemplo 2: para monitorar as cobranças estimadas da AWS usando as métricas de faturamento do CloudWatch

O exemplo get-metric-data a seguir recupera a métrica EstimatedCharges do CloudWatch do namespace AWS/Faturamento.

aws cloudwatch get-metric-data \
    --metric-data-queries '[{"Id":"m1","MetricStat":{"Metric":{"Namespace":"AWS/Billing","MetricName":"EstimatedCharges","Dimensions":[{"Name":"Currency","Value":"USD"}]},"Period":21600,"Stat":"Maximum"}}]' \
    --start-time 2024-09-26T12:00:00Z \
    --end-time 2024-09-26T18:00:00Z \
    --region us-east-1

Saída:

{
    "MetricDataResults": [
        {
            "Id": "m1",
            "Label": "EstimatedCharges",
            "Timestamps": [
                "2024-09-26T12:00:00+00:00"
            ],
            "Values": [
                542.38
            ],
            "StatusCode": "Complete"
        }
    ],
    "Messages": []
}

Para obter mais informações, consulte Uso de expressões matemáticas com as métricas do CloudWatch no Guia do usuário do Amazon CloudWatch.

  • Para obter detalhes da API, consulte GetMetricData na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-metric-statistics.

AWS CLI

Como obter a utilização da CPU por instância do EC2

O exemplo a seguir usa o comando get-metric-statistics para obter a utilização da CPU de uma instância do EC2 com o ID i-abcdef.

aws cloudwatch get-metric-statistics --metric-name CPUUtilization --start-time 2014-04-08T23:18:00Z --end-time 2014-04-09T23:18:00Z --period 3600 --namespace AWS/EC2 --statistics Maximum --dimensions Name=InstanceId,Value=i-abcdef

Saída:

{
    "Datapoints": [
        {
            "Timestamp": "2014-04-09T11:18:00Z",
            "Maximum": 44.79,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T20:18:00Z",
            "Maximum": 47.92,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T19:18:00Z",
            "Maximum": 50.85,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T09:18:00Z",
            "Maximum": 47.92,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T03:18:00Z",
            "Maximum": 76.84,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T21:18:00Z",
            "Maximum": 48.96,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T14:18:00Z",
            "Maximum": 47.92,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T08:18:00Z",
            "Maximum": 47.92,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T16:18:00Z",
            "Maximum": 45.55,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T06:18:00Z",
            "Maximum": 47.92,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T13:18:00Z",
            "Maximum": 45.08,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T05:18:00Z",
            "Maximum": 47.92,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T18:18:00Z",
            "Maximum": 46.88,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T17:18:00Z",
            "Maximum": 52.08,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T07:18:00Z",
            "Maximum": 47.92,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T02:18:00Z",
            "Maximum": 51.23,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T12:18:00Z",
            "Maximum": 47.67,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-08T23:18:00Z",
            "Maximum": 46.88,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T10:18:00Z",
            "Maximum": 51.91,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T04:18:00Z",
            "Maximum": 47.13,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T15:18:00Z",
            "Maximum": 48.96,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T00:18:00Z",
            "Maximum": 48.16,
            "Unit": "Percent"
        },
        {
            "Timestamp": "2014-04-09T01:18:00Z",
            "Maximum": 49.18,
            "Unit": "Percent"
        }
    ],
    "Label": "CPUUtilization"
}

Especificar várias dimensões

O exemplo a seguir ilustra como especificar diversas dimensões. Cada dimensão é especificada como um par de nome/valor, com uma vírgula entre o nome e o valor. As diversas dimensões são separadas por um espaço. Se uma única métrica incluir diversas dimensões, você deverá especificar um valor para cada dimensão definida.

Para obter mais exemplos relacionados ao uso do comando get-metric-statistics, consulte Obter estatísticas de uma métrica no Guia do desenvolvedor do Amazon CloudWatch.

aws cloudwatch get-metric-statistics --metric-name Buffers --namespace MyNameSpace --dimensions Name=InstanceID,Value=i-abcdef Name=InstanceType,Value=m1.small --start-time 2016-10-15T04:00:00Z --end-time 2016-10-19T07:00:00Z --statistics Average --period 60

  • Para obter detalhes da API, consulte GetMetricStatistics na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-metric-stream.

AWS CLI

Como recuperar informações sobre um fluxo de métricas

O exemplo de get-metric-stream a seguir exibe as informações sobre o fluxo de métricas chamado QuickFull-GuaFbs na conta especificada.

aws cloudwatch get-metric-stream \
    --name QuickFull-GuaFbs

Saída:

{
    "Arn": "arn:aws:cloudwatch:us-east-1:123456789012:metric-stream/QuickFull-GuaFbs",
    "Name": "QuickFull-GuaFbs",
    "FirehoseArn": "arn:aws:firehose:us-east-1:123456789012:deliverystream/MetricStreams-QuickFull-GuaFbs-WnySbECG",
    "RoleArn": "arn:aws:iam::123456789012:role/service-role/MetricStreams-FirehosePutRecords-JN10W9B3",
    "State": "running",
    "CreationDate": "2024-10-11T18:48:59.187000+00:00",
    "LastUpdateDate": "2024-10-11T18:48:59.187000+00:00",
    "OutputFormat": "json",
    "IncludeLinkedAccountsMetrics": false
}

Consulte mais informações em Usar fluxos de métricas no Guia do usuário do Amazon CloudWatch.

  • Consulte detalhes da API em GetMetricStream na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-metric-widget-image.

AWS CLI

Para recuperar um grafo de snapshot de CPUUtilization

O exemplo get-metric-widget-image a seguir recupera o grafo de snapshot da métrica CPUUtilization da instância do EC2 com o ID i-abcde e salva a imagem recuperada como um arquivo denominado "image.png" na máquina local.

aws cloudwatch get-metric-widget-image \
    --metric-widget '{"metrics":[["AWS/EC2","CPUUtilization","InstanceId","i-abcde"]]}' \
    --output-format png \
    --output text | base64 --decode > image.png

Este comando não produz saída.

O código de exemplo a seguir mostra como usar list-dashboards.

AWS CLI

Para recuperar uma lista de painéis

O exemplo list-dashboards a seguir lista todos os painéis na conta especificada.

aws cloudwatch list-dashboards

Saída:

{
    "DashboardEntries": [
        {
            "DashboardName": "Dashboard-A",
            "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-A",
            "LastModified": "2024-10-11T18:40:11+00:00",
            "Size": 271
        },
        {
            "DashboardName": "Dashboard-B",
            "DashboardArn": "arn:aws:cloudwatch::123456789012:dashboard/Dashboard-B",
            "LastModified": "2024-10-11T18:44:41+00:00",
            "Size": 522
        }
    ]
}

Para obter mais informações, consulte Painéis do Amazon CloudWatch no Guiado usuário do Amazon CloudWatch.

  • Para ver detalhes da API, consulte ListDashboards na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-metric-streams.

AWS CLI

Como recuperar uma lista de fluxos de métricas

O exemplo de list-metric-streams a seguir lista todos os fluxos de métricas na conta especificada.

aws cloudwatch list-metric-streams

Saída:

{
    "Entries": [
        {
            "Arn": "arn:aws:cloudwatch:us-east-1:123456789012:metric-stream/QuickFull-GuaFbs",
            "CreationDate": "2024-10-11T18:48:59.187000+00:00",
            "LastUpdateDate": "2024-10-11T18:48:59.187000+00:00",
            "Name": "QuickFull-GuaFbs",
            "FirehoseArn": "arn:aws:firehose:us-east-1:123456789012:deliverystream/MetricStreams-QuickFull-GuaFbs-WnySbECG",
            "State": "running",
            "OutputFormat": "json"
        }
    ]
}

Consulte mais informações em Usar fluxos de métricas no Guia do usuário do Amazon CloudWatch.

  • Consulte detalhes da API em ListMetricStreams na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-metrics.

AWS CLI

Para listar as métricas do Amazon SNS

O exemplo apresentado a seguir para list-metrics exibe as métricas do Amazon SNS.

aws cloudwatch list-metrics \
    --namespace "AWS/SNS"

Saída:

{
    "Metrics": [
        {
            "Namespace": "AWS/SNS",
            "Dimensions": [
                {
                    "Name": "TopicName",
                    "Value": "NotifyMe"
                }
            ],
            "MetricName": "PublishSize"
        },
        {
            "Namespace": "AWS/SNS",
            "Dimensions": [
                {
                    "Name": "TopicName",
                    "Value": "CFO"
                }
            ],
            "MetricName": "PublishSize"
        },
        {
            "Namespace": "AWS/SNS",
            "Dimensions": [
                {
                    "Name": "TopicName",
                    "Value": "NotifyMe"
                }
            ],
            "MetricName": "NumberOfNotificationsFailed"
        },
        {
            "Namespace": "AWS/SNS",
            "Dimensions": [
                {
                    "Name": "TopicName",
                    "Value": "NotifyMe"
                }
            ],
            "MetricName": "NumberOfNotificationsDelivered"
        },
        {
            "Namespace": "AWS/SNS",
            "Dimensions": [
                {
                    "Name": "TopicName",
                    "Value": "NotifyMe"
                }
            ],
            "MetricName": "NumberOfMessagesPublished"
        },
        {
            "Namespace": "AWS/SNS",
            "Dimensions": [
                {
                    "Name": "TopicName",
                    "Value": "CFO"
                }
            ],
            "MetricName": "NumberOfMessagesPublished"
        },
        {
            "Namespace": "AWS/SNS",
            "Dimensions": [
                {
                    "Name": "TopicName",
                    "Value": "CFO"
                }
            ],
            "MetricName": "NumberOfNotificationsDelivered"
        },
        {
            "Namespace": "AWS/SNS",
            "Dimensions": [
                {
                    "Name": "TopicName",
                    "Value": "CFO"
                }
            ],
            "MetricName": "NumberOfNotificationsFailed"
        }
    ]
}

  • Para obter detalhes da API, consulte ListMetrics na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Como listar as tags associadas a um alarme existente*

O exemplo de list-tags-for-resource a seguir lista todas as tags associadas a um alarme chamado demo na conta especificada.

aws cloudwatch list-tags-for-resource \
    --resource-arn arn:aws:cloudwatch:us-east-1:123456789012:alarm:demo

Saída:

{
    "Tags": [
        {
            "Key": "stack",
            "Value": "Production"
        },
        {
            "Key": "team",
            "Value": "Devops"
        }
    ]
}

Consulte mais informações em Alarmes e marcação no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar put-anomaly-detector.

AWS CLI

Para criar um modelo de detecção de anomalias

O exemplo put-anomaly-detector a seguir cria um modelo de detecção de anomalias de uma métrica do CloudWatch.

aws cloudwatch put-anomaly-detector \
    --namespace AWS/Logs \
    --metric-name IncomingBytes \
    --stat SampleCount

Este comando não produz saída.

Para obter mais informações, consulte Usar a detecção de anomalias do CloudWatch no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar put-composite-alarm.

AWS CLI

Como criar um alarme composto no CloudWatch

O exemplo de put-composite-alarm a seguir cria um alarme composto chamado ProdAlarm na conta especificada.

aws cloudwatch put-composite-alarm \
    --alarm-name ProdAlarm \
    --alarm-rule "ALARM(CPUUtilizationTooHigh) AND ALARM(MemUsageTooHigh)" \
    --alarm-actions arn:aws:sns:us-east-1:123456789012:demo \
    --actions-enabled

Este comando não produz saída.

Consulte mais informações em Criar um alarme composto no Guia do usuário do Amazon CloudWatch.

  • Consulte detalhes da API em PutCompositeAlarm na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar put-dashboard.

AWS CLI

Para criar um painel

O exemplo put-dashboard a seguir cria um painel denominado Dashboard-A na conta especificada.

aws cloudwatch put-dashboard \
    --dashboard-name Dashboard-A \
    --dashboard-body '{"widgets":[{"height":6,"width":6,"y":0,"x":0,"type":"metric","properties":{"view":"timeSeries","stacked":false,"metrics":[["Namespace","CPUUtilization","Environment","Prod","Type","App"]],"region":"us-east-1"}}]}'

Saída:

{
    "DashboardValidationMessages": []
}

Para obter mais informações, consulte Criar um painel do CloudWatch no Guia do usuário do Amazon CloudWatch.

  • Para obter detalhes da API, consulte PutDashboard na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar put-insight-rule.

AWS CLI

Como criar uma regra do Contributor Insights

O exemplo de put-insight-rule a seguir cria uma regra do Contributor Insights chamada VPCFlowLogsContributorInsights na conta especificada.

aws cloudwatch put-insight-rule \
    --rule-name VPCFlowLogsContributorInsights \
    --rule-definition file://insight-rule.json \
    --rule-state ENABLED

Conteúdo de insight-rule.json:

{
    "Schema": {
        "Name": "CloudWatchLogRule",
        "Version": 1
    },
    "AggregateOn": "Count",
    "Contribution": {
        "Filters": [],
        "Keys": [
            "tcp-flag"
        ]
    },
    "LogFormat": "CLF",
    "LogGroupNames": [
        "/vpc/flowlogs/*"
    ],
    "Fields": {
        "23": "tcp-flag"
    }
}

Este comando não produz saída.

Consulte mais informações em Criação de uma regra do Contributor Insights no CloudWatch no Guia do usuário do Amazon CloudWatch.

  • Consulte detalhes da API em PutInsightRule na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar put-metric-alarm.

AWS CLI

Como enviar uma mensagem de e-mail do Amazon Simple Notification Service quando a utilização da CPU exceder 70%

O seguinte exemplo usa o comando put-metric-alarm para enviar uma mensagem de e-mail do Amazon Simple Notification Service quando a utilização da CPU excede 70%:

aws cloudwatch put-metric-alarm --alarm-name cpu-mon --alarm-description "Alarm when CPU exceeds 70 percent" --metric-name CPUUtilization --namespace AWS/EC2 --statistic Average --period 300 --threshold 70 --comparison-operator GreaterThanThreshold  --dimensions "Name=InstanceId,Value=i-12345678" --evaluation-periods 2 --alarm-actions arn:aws:sns:us-east-1:111122223333:MyTopic --unit Percent

Esse comando retornará ao prompt, se houver êxito. Se já existir um alarme com o mesmo nome, ele será substituído pelo novo alarme.

Como especificar diversas dimensões

O exemplo a seguir ilustra como especificar diversas dimensões. Cada dimensão é especificada como um par de nome/valor, com uma vírgula entre o nome e o valor. As diversas dimensões são separadas por um espaço:

aws cloudwatch put-metric-alarm --alarm-name "Default_Test_Alarm3" --alarm-description "The default example alarm" --namespace "CW EXAMPLE METRICS" --metric-name Default_Test --statistic Average --period 60 --evaluation-periods 3 --threshold 50 --comparison-operator GreaterThanOrEqualToThreshold --dimensions Name=key1,Value=value1 Name=key2,Value=value2

  • Para obter detalhes da API, consulte PutMetricAlarm na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar put-metric-data.

AWS CLI

Como publicar uma métrica personalizada no Amazon CloudWatch

O seguinte exemplo usa o comando put-metric-data para publicar uma métrica personalizada no Amazon CloudWatch:

aws cloudwatch put-metric-data --namespace "Usage Metrics" --metric-data file://metric.json

Os valores da própria métrica estão armazenados no arquivo em JSON, metric.json.

Veja o conteúdo desse arquivo:

[
  {
    "MetricName": "New Posts",
    "Timestamp": "Wednesday, June 12, 2013 8:28:20 PM",
    "Value": 0.50,
    "Unit": "Count"
  }
]

Para obter mais informações, consulte Publicar métricas personalizadas no Guia do desenvolvedor do Amazon CloudWatch.

Como especificar diversas dimensões

O exemplo a seguir ilustra como especificar diversas dimensões. Cada dimensão é especificada como um par de nome/valor. As diversas dimensões são separadas por uma vírgula.

aws cloudwatch put-metric-data --metric-name Buffers --namespace MyNameSpace --unit Bytes --value 231434333 --dimensions InstanceID=1-23456789,InstanceType=m1.small

  • Para obter detalhes da API, consulte PutMetricData na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar put-metric-stream.

AWS CLI

Como criar um fluxo de métricas

O exemplo de put-metric-stream a seguir cria um fluxo de métricas chamado QuickFull-GuaFb na conta especificada.

aws cloudwatch put-metric-stream \
    --name QuickFull-GuaFbs \
    --firehose-arn arn:aws:firehose:us-east-1:123456789012:deliverystream/MetricStreams-QuickFull-GuaFbs-WnySbECG \
    --role-arn arn:aws:iam::123456789012:role/service-role/MetricStreams-FirehosePutRecords-JN10W9B3 \
    --output-format json \
    --no-include-linked-accounts-metrics

Saída:

{
    "Arn": "arn:aws:cloudwatch:us-east-1:123456789012:metric-stream/QuickFull-GuaFbs"
}

Consulte mais informações em Configurar um fluxo de métricas no Guia do usuário do Amazon CloudWatch.

  • Consulte detalhes da API em PutMetricStream na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar set-alarm-state.

AWS CLI

Para alterar temporariamente o estado de um alarme

O seguinte exemplo usa o comando set-alarm-state para alterar temporariamente o estado de um alarme do Amazon CloudWatch chamado “myalarm” e definir seu estado como ALARM para fins de teste:

aws cloudwatch set-alarm-state --alarm-name "myalarm" --state-value ALARM --state-reason "testing purposes"

Esse comando retornará ao prompt, se houver êxito.

  • Para ver detalhes da API, consulte SetAlarmState na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar start-metric-streams.

AWS CLI

Como iniciar um fluxo de métricas especificado

O exemplo de start-metric-streams a seguir inicia o fluxo de métricas chamado QuickFull-GuaFbs na conta especificada.

aws cloudwatch start-metric-streams \
    --names QuickFull-GuaFbs

Este comando não produz saída.

Consulte mais informações em Usar fluxos de métricas no Guia do usuário do Amazon CloudWatch.

O código de exemplo a seguir mostra como usar stop-metric-streams.

AWS CLI

Como interromper um fluxo de métricas especificado

O exemplo de stop-metric-streams a seguir interrompe o fluxo de métricas chamado QuickFull-GuaFbs na conta especificada.

aws cloudwatch stop-metric-streams \
    --names QuickFull-GuaFbs

Este comando não produz saída.

Consulte mais informações em Usar fluxos de métricas no Guia do usuário do Amazon CloudWatch.

  • Consulte detalhes da API em StopMetricStreams na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Como adicionar uma ou mais tags ao recurso especificado

O exemplo de tag-resource a seguir adiciona duas tags ao alarme do CloudWatch chamado demo na conta especificada.

aws cloudwatch tag-resource \
    --resource-arn arn:aws:cloudwatch:us-east-1:123456789012:alarm:demo \
    --tags Key=stack,Value=Production Key=team,Value=Devops

Este comando não produz saída.

Consulte mais informações em Etiquetar recursos do Amazon CloudWatch no Guia do usuário do Amazon CloudWatch.

  • Para obter detalhes da API, consulte TagResource na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Como remover uma ou mais tags do recurso especificado

O exemplo de untag-resource a seguir remove duas tags do alarme do CloudWatch chamado demo na conta especificada.

aws cloudwatch untag-resource \
    --resource-arn arn:aws:cloudwatch:us-east-1:123456789012:alarm:demo \
    --tag-keys stack team

Este comando não produz saída.

Consulte mais informações em Etiquetar recursos do Amazon CloudWatch no Guia do usuário do Amazon CloudWatch.

  • Para obter detalhes sobre a API, consulte UntagResource na Referência de comandos da AWS CLI.