Métricas personalizadas

No console da AWS IoT, no painel de navegação, expanda Defend, escolha Detect e, em seguida, Métricas.

Na página Métricas personalizadas, escolha Criar.

Na página Criar métrica personalizada, faça o seguinte.

Quando terminar, escolha Confirmar.

Depois de criar sua métrica personalizada, a página Métricas personalizadas será exibida, onde você pode ver sua métrica personalizada recém-criada.

Em seguida, você precisa adicionar sua métrica personalizada a um Perfil de segurança. No console da AWS IoT, no painel de navegação, expanda Defend, escolha Detect e, em seguida, Perfis de segurança.

Escolha o Perfil de segurança ao qual você gostaria de adicionar a métrica personalizada.

Selecione Ações, Editar.

Escolha Métricas adicionais a serem retidas e, em seguida, escolha sua métrica personalizada. Escolha Próximo nas telas seguintes até chegar à página Confirmar. Escolha Salvar e Continuar. Depois que sua métrica personalizada for adicionada com sucesso, a página de detalhes do Perfil de segurança será exibida.

No console da AWS IoT, no painel de navegação, expanda Defend, escolha Detect e, em seguida, Métricas.

Escolha o Nome da métrica personalizada da qual você gostaria de ver os detalhes.

No console da AWS IoT, no painel de navegação, expanda Defend, escolha Detect e, em seguida, Métricas.

Selecione o botão de opção ao lado da métrica personalizada que você deseja atualizar. Então, em Ações, escolha Editar.

Na página Atualizar métrica personalizada, você pode editar o nome de exibição e remover ou adicionar tags.

Quando tiver terminado, escolha Atualizar. A página de Métricas personalizadas.

Primeiro, remova sua métrica personalizada de qualquer Perfil de segurança em que ela esteja referenciada. Você pode ver quais Perfis de segurança contêm a métrica personalizada, na página de detalhes da métrica personalizada. No console da AWS IoT, no painel de navegação, expanda Defend, escolha Detect e, em seguida, Métricas.

Escolha a métrica personalizada que você gostaria de remover. Remova a métrica personalizada de qualquer Perfil de segurança listado em Perfis de Segurança, na página de detalhes da métrica personalizada.

No console da AWS IoT, no painel de navegação, expanda Defend, escolha Detect e, em seguida, Métricas.

Selecione o botão de opção ao lado da métrica personalizada que você deseja excluir. Então, em Ações, escolha Excluir.

Na mensagem Tem certeza de que deseja excluir a métrica personalizada?, escolha Excluir métrica personalizada.

Use o comando create-custom-metric para criar sua métrica personalizada. O exemplo a seguir cria uma métrica personalizada que mede a porcentagem da bateria.

aws iot create-custom-metric \
    --metric-name "batteryPercentage" \
    --metric-type "number" \
    --display-name "Remaining battery percentage." \
    --region us-east-1
    --client-request-token "02ccb92b-33e8-4dfa-a0c1-35b181ed26b0" \

Saída:

{
    "metricName": "batteryPercentage",
    "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/batteryPercentage"
}

Depois de criar sua métrica personalizada, você pode adicioná-la a um perfil de segurança existente usando update-security-profile ou criar um novo para usando o create-security-profile. Aqui estamos criando um perfil de segurança novo chamado batteryUsage a que adicionaremos nossa nova métrica personalizada batteryPercentage. Também adicionamos uma métrica de regras do Detect chamada cellularBandwidth.

aws iot create-security-profile \
    --security-profile-name batteryUsage \
    --security-profile-description "Shows how much battery is left in percentile."  \
    --behaviors "[{\"name\":\"great-than-75\",\"metric\":\"batteryPercentage\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"number\":75},\"consecutiveDatapointsToAlarm\":5,\"consecutiveDatapointsToClear\":1}},{\"name\":\"cellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]" \
    --region us-east-1

Saída:

{
    "securityProfileArn": "arn:aws:iot:us-east-1:1234564789012:securityprofile/batteryUsage",
    "securityProfileName": "batteryUsage"
}

Para excluir uma métrica personalizada, primeiro remova-a de todos os Perfis de segurança aos quais ela está anexada. Use o comando list-security-profiles para visualizar Perfis de segurança com uma determinada métrica personalizada.

Para remover uma métrica personalizada de um Perfil de segurança, use o comando update-security-profiles. Insira todas as informações que deseja manter, mas exclua a métrica personalizada:

aws iot update-security-profile \
  --security-profile-name batteryUsage \
  --behaviors "[{\"name\":\"cellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]"

A saída deste comando é semelhante à apresentada a seguir.

{
  "behaviors": [{\"name\":\"cellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}],
  "securityProfileName": "batteryUsage",
  "lastModifiedDate": 2020-11-17T23:02:12.879000-09:00,
  "securityProfileDescription": "Shows how much battery is left in percentile.",
  "version": 2,
  "securityProfileArn": "arn:aws:iot:us-east-1:1234564789012:securityprofile/batteryUsage",  
  "creationDate": 2020-11-17T23:02:12.879000-09:00
}

Depois que a métrica personalizada for desanexada, use o comando delete-custom-metric para excluir a métrica personalizada.

aws iot delete-custom-metric  \
  --metric-name batteryPercentage \
  --region us-east-1

A saída do comando é semelhante à seguinte

HTTP 200