CloudWatch Exemplos de monitoramento de rede usando 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 Monitoramento CloudWatch de Rede.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções 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, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.

Tópicos

Ações

Ações

O código de exemplo a seguir mostra como usar create-monitor.

AWS CLI

Exemplo 1: Para criar um monitor de rede com um período de agregação

O create-monitor exemplo a seguir cria um monitor chamado Example_NetworkMonitor com um aggregationPeriod conjunto de 30 segundos. A inicial state do monitor será INACTIVE porque não há sondas associadas a ele. O estado muda para ACTIVE somente quando as sondas são adicionadas. Você pode usar os comandos update-monitor ou create-probe para adicionar sondas a esse monitor.


aws networkmonitor create-monitor \
     --monitor-name Example_NetworkMonitor \
     --aggregation-period 30

Saída:


{
    "monitorArn": "arn:aws:networkmonitor:region:111122223333:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "INACTIVE",
    "aggregationPeriod": 30,
    "tags": {}
}

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Exemplo 2: Para criar um monitor de rede com uma sonda usando TCP e também incluindo tags

O create-monitor exemplo a seguir cria um monitor chamadoExample_NetworkMonitor. O comando também cria uma sonda que usa o ICMP protocolo e inclui tags. Como não aggregationPeriod é passado na solicitação, 60 segundos são definidos como padrão. O state do monitor com a sonda permanecerá PENDING até que o monitor estejaACTIVE. Isso pode levar alguns minutos, momento em que state mudará paraACTIVE, e você poderá começar a visualizar CloudWatch as métricas.


aws networkmonitor create-monitor \
    --monitor-name Example_NetworkMonitor \
    --probes sourceArn=arn:aws:ec2:region:111122223333:subnet/subnet-id,destination=10.0.0.100,destinationPort=80,protocol=TCP,packetSize=56,probeTags={Name=Probe1} \
    --tags Monitor=Monitor1

Saída:


{
    "monitorArn": "arn:aws:networkmonitor:region111122223333:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "PENDING",
    "aggregationPeriod": 60,
    "tags": {
        "Monitor": "Monitor1"
    }
}

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Exemplo 3: Para criar um monitor de rede com uma sonda usando ICMP e também incluindo tags

O create-monitor exemplo a seguir cria um monitor chamado Example_NetworkMonitor com um aggregationPeriod de 30 segundos. O comando também cria uma sonda que usa o ICMP protocolo e inclui tags. Como não aggregationPeriod é passado na solicitação, 60 segundos são definidos como padrão. O state do monitor com a sonda permanecerá PENDING até que o monitor estejaACTIVE. Isso pode levar alguns minutos, momento em que state mudará paraACTIVE, e você poderá começar a visualizar CloudWatch as métricas.


aws networkmonitor create-monitor \
     --monitor-name Example_NetworkMonitor \
     --aggregation-period 30 \
     --probes sourceArn=arn:aws:ec2:region111122223333:subnet/subnet-id,destination=10.0.0.100,protocol=ICMP,packetSize=56,probeTags={Name=Probe1} \
     --tags Monitor=Monitor1

Saída:


{
    "monitorArn": "arn:aws:networkmonitor:region:111122223333:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "PENDING",
    "aggregationPeriod": 30,
    "tags": {
        "Monitor": "Monitor1"
    }
}

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Para API obter detalhes, consulte CreateMonitorna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-probe.

AWS CLI

Exemplo 1: Para criar uma sonda que a usa TCP e a adiciona a um monitor de rede

O create-probe exemplo a seguir cria uma sonda que usa TCP protocol e adiciona a sonda a um monitor chamado. Example_NetworkMonitor Uma vez criado, o state monitor com a sonda permanecerá PENDING até que o monitor estejaACTIVE. Isso pode levar alguns minutos, momento em que o estado mudará paraACTIVE, e você poderá começar a visualizar CloudWatch as métricas.


aws networkmonitor create-probe \
    --monitor-name Example_NetworkMonitor \
    --probe sourceArn=arn:aws:ec2:region:111122223333:subnet/subnet-id,destination=10.0.0.100,destinationPort=80,protocol=TCP,packetSize=56,tags={Name=Probe1}

Saída:


{
    "probeId": "probe-12345",
    "probeArn": "arn:aws:networkmonitor:region:111122223333:probe/probe-12345",
    "destination": "10.0.0.100",
    "destinationPort": 80,
    "packetSize": 56,
    "addressFamily": "IPV4",
    "vpcId": "vpc-12345",
    "state": "PENDING",
    "createdAt": "2024-03-29T12:41:57.314000-04:00",
    "modifiedAt": "2024-03-29T12:41:57.314000-04:00",
    "tags": {
        "Name": "Probe1"
    }
}

Exemplo 2: Para criar uma sonda que usa a sonda usando ICMP e adicioná-la a um monitor de rede

O create-probe exemplo a seguir cria uma sonda que usa ICMP protocol e adiciona a sonda a um monitor chamado. Example_NetworkMonitor Uma vez criado, o state monitor com a sonda permanecerá PENDING até que o monitor estejaACTIVE. Isso pode levar alguns minutos, momento em que o estado mudará paraACTIVE, e você poderá começar a visualizar CloudWatch as métricas.


aws networkmonitor create-probe \
    --monitor-name Example_NetworkMonitor \
    --probe sourceArn=arn:aws:ec2:region:012345678910:subnet/subnet-id,destination=10.0.0.100,protocol=ICMP,packetSize=56,tags={Name=Probe1}

Saída:


{
    "probeId": "probe-12345",
    "probeArn": "arn:aws:networkmonitor:region:111122223333:probe/probe-12345",
    "destination": "10.0.0.100",
    "packetSize": 56,
    "addressFamily": "IPV4",
    "vpcId": "vpc-12345",
    "state": "PENDING",
    "createdAt": "2024-03-29T12:44:02.452000-04:00",
    "modifiedAt": "2024-03-29T12:44:02.452000-04:00",
    "tags": {
        "Name": "Probe1"
    }
}

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Para API obter detalhes, consulte CreateProbena Referência de AWS CLI Comandos.

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

AWS CLI

Para excluir um monitor

O delete-monitor exemplo a seguir exclui um monitor chamadoExample_NetworkMonitor.


aws networkmonitor delete-monitor \
    --monitor-name Example_NetworkMonitor

Este comando não produz saída.

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Para API obter detalhes, consulte DeleteMonitorna Referência de AWS CLI Comandos.

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

AWS CLI

Para excluir uma sonda

O delete-probe exemplo a seguir exclui uma sonda com o ID probe-12345 de um monitor de rede chamado. Example_NetworkMonitor


aws networkmonitor delete-probe \
    --monitor-name Example_NetworkMonitor \
    --probe-id probe-12345

Este comando não produz saída.

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Para API obter detalhes, consulte DeleteProbena Referência de AWS CLI Comandos.

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

AWS CLI

Para obter informações sobre o monitor

O get-monitor exemplo a seguir obtém informações sobre um monitor chamadoExample_NetworkMonitor.


aws networkmonitor get-monitor \
    --monitor-name Example_NetworkMonitor

Saída:


{
    "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "ACTIVE",
    "aggregationPeriod": 60,
    "tags": {},
    "probes": [],
    "createdAt": "2024-04-01T17:58:07.211000-04:00",
    "modifiedAt": "2024-04-01T17:58:07.211000-04:00"
}

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Para API obter detalhes, consulte GetMonitorna Referência de AWS CLI Comandos.

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

AWS CLI

Para visualizar os detalhes da sonda

O get-probe exemplo a seguir retorna detalhes sobre uma sonda associada a probeID probe-12345 um monitor chamadoExample_NetworkMonitor.


aws networkmonitor get-probe \
    --monitor-name Example_NetworkMonitor \
    --probe-id probe-12345

Saída:


{
    "probeId": "probe-12345",
    "probeArn": "arn:aws:networkmonitor:region:012345678910:probe/probe-12345",
    "sourceArn": "arn:aws:ec2:region:012345678910:subnet/subnet-12345",
    "destination": "10.0.0.100",
    "destinationPort": 80,
    "protocol": "TCP",
    "packetSize": 56,
    "addressFamily": "IPV4",
    "vpcId": "vpc-12345",
    "state": "ACTIVE",
    "createdAt": "2024-03-29T12:41:57.314000-04:00",
    "modifiedAt": "2024-03-29T12:42:28.610000-04:00",
    "tags": {
        "Name": "Probe1"
    }
}

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Para API obter detalhes, consulte GetProbena Referência de AWS CLI Comandos.

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

AWS CLI

Exemplo 1: Para listar todos os monitores (monitor único)

O list-monitors exemplo a seguir retorna uma lista de apenas um único monitor. O monitor state é ACTIVE e tem um aggregationPeriod de 60 segundos.


aws networkmonitor list-monitors

Saída:


{
    "monitors": [{
            "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor",
            "monitorName": "Example_NetworkMonitor",
            "state": "ACTIVE",
            "aggregationPeriod": 60,
            "tags": {
                "Monitor": "Monitor1"
            }
        }
    ]
}

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Exemplo 2: Para listar todos os monitores (vários monitores)

O list-monitors exemplo a seguir retorna uma lista de três monitores. O state único monitor é ACTIVE e gera CloudWatch métricas. Os estados dos outros dois monitores estão INACTIVE gerando CloudWatch métricas. Todos os três monitores usam um aggregationPeriod de 60 segundos.


aws networkmonitor list-monitors

Saída:


{
    "monitors": [
        {
            "monitorArn": "arn:aws:networkmonitor:us-east-1:111122223333:monitor/Example_NetworkMonitor",
            "monitorName": "Example_NetworkMonitor",
            "state": "INACTIVE",
            "aggregationPeriod": 60,
            "tags": {}
        },
        {
            "monitorArn": "arn:aws:networkmonitor:us-east-1:111122223333:monitor/Example_NetworkMonitor2",
            "monitorName": "Example_NetworkMonitor2",
            "state": "ACTIVE",
            "aggregationPeriod": 60,
            "tags": {
                "Monitor": "Monitor1"
            }
        },
        {
            "monitorArn": "arn:aws:networkmonitor:us-east-1:111122223333:monitor/TestNetworkMonitor_CLI",
            "monitorName": "TestNetworkMonitor_CLI",
            "state": "INACTIVE",
            "aggregationPeriod": 60,
            "tags": {}
        }
    ]
}

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Para API obter detalhes, consulte ListMonitorsna Referência de AWS CLI Comandos.

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

AWS CLI

Para listar as tags de um recurso

O list-tags-for-resource exemplo a seguir retorna uma lista das tags de um monitor chamadoExample_NetworkMonitor.


aws networkmonitor list-tags-for-resource \
    --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor

Saída:


{
    "tags": {
        "Environment": "Dev",
        "Application": "PetStore"
    }
}

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Para API obter detalhes, consulte ListTagsForResourcena Referência de AWS CLI Comandos.

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

AWS CLI

Para marcar um recurso

O tag-resource exemplo a seguir marca um monitor chamado Example_NetworkMonitor com Environment=Dev e Application=PetStore tags.


aws networkmonitor tag-resource \
    --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor \
    --tags Environment=Dev,Application=PetStore

Este comando não produz saída.

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Para API obter detalhes, consulte TagResourcena Referência de AWS CLI Comandos.

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

AWS CLI

Para desmarcar um recurso

O untag-resource exemplo a seguir remove um tag-keys parâmetro com o par de valores-chave Environment Application de sua associação com um monitor chamado. Example_NetworkMonitor


aws networkmonitor untag-resource \
    --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor \
    --tag-keys Environment Application

Este comando não produz saída.

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Para API obter detalhes, consulte UntagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-monitor.

AWS CLI

Para atualizar um monitor

O update-monitor exemplo a seguir altera o monitor aggregationPeriod de 60 segundos para 30 segundos.


aws networkmonitor update-monitor \
    --monitor-name Example_NetworkMonitor \
    --aggregation-period 30

Saída:


{
    "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor",
    "monitorName": "Example_NetworkMonitor",
    "state": "PENDING",
    "aggregationPeriod": 30,
    "tags": {
        "Monitor": "Monitor1"
    }
}

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Para API obter detalhes, consulte UpdateMonitorna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-probe.

AWS CLI

Para atualizar uma sonda

O update-probe exemplo a seguir atualiza o endereço destination IP original de uma sonda e também atualiza o packetSize para60.


aws networkmonitor update-probe \
    --monitor-name Example_NetworkMonitor \
    --probe-id probe-12345 \
    --destination 10.0.0.150 \
    --packet-size 60

Saída:


{
    "probeId": "probe-12345",
    "probeArn": "arn:aws:networkmonitor:region:012345678910:probe/probe-12345",
    "sourceArn": "arn:aws:ec2:region:012345678910:subnet/subnet-12345",
    "destination": "10.0.0.150",
    "destinationPort": 80,
    "protocol": "TCP",
    "packetSize": 60,
    "addressFamily": "IPV4",
    "vpcId": "vpc-12345",
    "state": "PENDING",
    "createdAt": "2024-03-29T12:41:57.314000-04:00",
    "modifiedAt": "2024-03-29T13:52:23.115000-04:00",
    "tags": {
        "Name": "Probe1"
    }
}

Para obter mais informações, consulte Como o Amazon CloudWatch Network Monitor funciona no Guia CloudWatch do usuário da Amazon.

Para API obter detalhes, consulte UpdateProbena Referência de AWS CLI Comandos.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

CloudWatch Registros

CodeArtifact