Benutzerdefinierte Metriken - AWS IoT Device Defender
So konfigurieren Sie benutzerdefinierte -Metriken auf der Konsole So verwenden Sie benutzerdefinierte Metriken von der CLICLI-Befehle für benutzerdefinierte MetrikenBenutzerdefinierte Metriken-APIs

Benutzerdefinierte Metriken

Mit AWS IoT Device Defender benutzerdefinierten Metriken können Sie Kennzahlen definieren und überwachen, die für Ihre Flotte oder Ihren Anwendungsfall spezifisch sind, z. B. die Anzahl der mit Wi-Fi-Gateways verbundenen Geräte, den Ladezustand von Akkus oder die Anzahl der Netzzyklen für intelligente Steckverbinder. Benutzerdefiniertes metrisches Verhalten wird in Sicherheitsprofilen definiert, die das erwartete Verhalten für eine Gruppe von Geräten (eine Objektgruppe) oder für alle Geräte spezifizieren. Sie können das Verhalten überwachen, indem Sie Alarme einrichten, anhand derer Sie gerätespezifische Probleme erkennen und darauf reagieren können.

So konfigurieren Sie benutzerdefinierte -Metriken auf der Konsole

AWS IoT Device Defender Agent SDK (Python)

Laden Sie zunächst den Beispielagenten des AWS IoT Device Defender Agenten SDK (Python) herunter. Der Agent erfasst die Metriken und veröffentlicht Berichte. Sobald Ihre geräteseitigen Metriken veröffentlicht wurden, können Sie sich die erfassten Messwerte ansehen und Schwellenwerte für die Einrichtung von Alarmen festlegen. Anweisungen zur Einrichtung des Device Agents finden Sie in der Readme-Datei des AWS IoT Device Defender Agent SDK (Python). Weitere Informationen finden Sie unter AWS IoT Device Defender Agent SDK (Python).

Erstellen Sie eine benutzerdefinierte Metrik, und fügen Sie sie einem Sicherheitsprofil hinzu.

Das folgende Verfahren zeigt Ihnen, wie Sie eine benutzerdefinierte Metrik auf der Konsole erstellen können.

  1. Erweitern Sie Verteidigen im Navigationsbereich der AWS IoTKonsole, und wählen Sie dann Detect, Metriken.

  2. Wählen Sie auf der Seite Benutzerdefinierte Metriken die Option Erstellen.

  3. Führen Sie auf der Seite Benutzerdefinierte Metrik erstellen die folgenden Schritte aus:

    1. Geben Sie unter Name einen Namen für Ihre benutzerdefinierte Metrik ein. Sie können diesen Namen nicht mehr ändern, nachdem Sie die benutzerdefinierte Metrik erstellt haben.

    2. Unter Anzeigename (optional) können Sie einen Anzeigenamen für Ihre benutzerdefinierte Metrik eingeben. Er muss nicht eindeutig sein und kann nach der Erstellung geändert werden.

    3. Wählen Sie unter Typ den Typ der Metrik, die Sie überwachen möchten. Zu den Metriktypen gehören string-list, ip-address-list, number-list und number. Der Typ kann nach der Erstellung nicht geändert werden.

      Anmerkung

      ML Detect erlaubt nur den Typ number.

    4. Unter Tags können Sie Tags auswählen, die der Ressource zugeordnet werden sollen.

    Wählen Sie abschließend Bestätigen.

  4. Nachdem Sie Ihre benutzerdefinierte Metrik erstellt haben, wird die Seite Benutzerdefinierte Metrik angezeigt, auf der Sie Ihre neu erstellte benutzerdefinierte Metrik sehen können.

  5. Als Nächstes müssen Sie Ihre benutzerdefinierte Metrik einem Sicherheitsprofil hinzufügen. Erweitern Sie auf der AWS IoT-Konsole im Navigationsbereich die Option Verteidigen, und wählen Sie dann Erkennen, Sicherheitsprofile.

  6. Wählen Sie das Sicherheitsprofil, zu dem Sie Ihre benutzerdefinierte Metrik hinzufügen möchten.

  7. Wählen Sie Aktionen und Bearbeiten.

  8. Wählen Sie Zusätzliche Metriken zum Beibehalten, und wählen Sie dann Ihre benutzerdefinierte Metrik. Wählen Sie auf den folgenden Bildschirmen Weiter, bis Sie zur Seite Bestätigen gelangen. Wählen Sie Speichern und Fortfahren. Nachdem Ihre benutzerdefinierte Metrik erfolgreich hinzugefügt wurde, wird die Sicherheitsprofil-Detailseite angezeigt.

    Anmerkung

    Perzentil-Statistiken für Metriken sind nicht verfügbar, wenn es Metrik-Werte gibt, die negative Zahlen enthalten.

Anzeigen der Details von benutzerdefinierten Metriken

Das folgende Verfahren zeigt Ihnen, wie Sie eine benutzerdefinierte Metrik auf der Konsole anzeigen können.

  1. Erweitern Sie Verteidigen im Navigationsbereich der AWS IoTKonsole, und wählen Sie dann Detect, Metriken.

  2. Wählen Sie den Metriknamen der benutzerdefinierten Metrik, deren Details Sie anzeigen möchten.

Aktualisieren einer benutzerdefinierten Metrik

Das folgende Verfahren zeigt Ihnen, wie Sie eine benutzerdefinierte Metrik auf der Konsole aktualisieren können.

  1. Erweitern Sie Verteidigen im Navigationsbereich der AWS IoTKonsole, und wählen Sie dann Detect, Metriken.

  2. Wählen Sie das Optionsfeld neben der benutzerdefinierten Metrik, die Sie aktualisieren möchten. Wählen Sie dann unter Aktionen die Option Bearbeiten.

  3. Auf der Seite Benutzerdefinierte Metrik aktualisieren können Sie den Anzeigenamen bearbeiten und Tags entfernen oder hinzufügen.

  4. Klicken Sie abschließend auf Aktualisieren. Die Seite Benutzerdefinierte Metriken.

Löschen einer benutzerdefinierten Metrik

Das folgende Verfahren zeigt Ihnen, wie Sie eine benutzerdefinierte Metrik von der Konsole löschen können.

  1. Entfernen Sie zunächst Ihre benutzerdefinierte Metrik aus allen Sicherheitsprofilen, die darauf verweisen. Sie können auf der Detailseite Ihrer benutzerdefinierten Metrik sehen, welche Sicherheitsprofile Ihre benutzerdefinierte Metrik enthalten. Erweitern Sie Verteidigen im Navigationsbereich der AWS IoTKonsole, und wählen Sie dann Detect, Metriken.

  2. Wählen Sie die benutzerdefinierte Metrik, die Sie entfernen möchten. Entfernen Sie die benutzerdefinierte Metrik aus allen Sicherheitsprofilen, die auf der Detailseite der benutzerdefinierten Metrik unter Sicherheitsprofile aufgeführt sind.

  3. Erweitern Sie Verteidigen im Navigationsbereich der AWS IoTKonsole, und wählen Sie dann Detect, Metriken.

  4. Wählen Sie das Optionsfeld neben der benutzerdefinierten Metrik, die Sie löschen möchten. Wählen Sie dann unter Aktionen die Option Löschen.

  5. Wählen Sie in der Nachricht Soll die benutzerdefinierte Metrik wirklich gelöscht werden? die Option Benutzerdefinierte Metrik löschen.

    Warnung

    Nachdem Sie eine benutzerdefinierte Metrik gelöscht haben, verlieren Sie alle mit der Metrik verknüpften Daten. Diese Aktion kann nicht mehr rückgängig gemacht werden.

So verwenden Sie benutzerdefinierte Metriken von der CLI

AWS IoT Device Defender Agent SDK (Python)

Laden Sie zunächst den Beispielagenten des AWS IoT Device Defender Agenten SDK (Python) herunter. Der Agent erfasst die Metriken und veröffentlicht Berichte. Sobald Ihre geräteseitigen Metriken veröffentlicht wurden, können Sie sich die erfassten Metriken ansehen und Schwellenwerte für die Einrichtung von Alarmen festlegen. Anweisungen zur Einrichtung des Device Agents finden Sie in der Readme-Datei des AWS IoT Device Defender Agent SDK (Python). Weitere Informationen finden Sie unter AWS IoT Device Defender Agent SDK (Python).

Erstellen Sie eine benutzerdefinierte Metrik, und fügen Sie sie einem Sicherheitsprofil hinzu.

Das folgende Verfahren zeigt Ihnen, wie Sie eine benutzerdefinierte Metrik erstellen und sie über die CLI zu einem Sicherheitsprofil hinzufügen können.

  1. Verwenden Sie den Befehl create-custom-metric, um Ihre benutzerdefinierte Metrik zu erstellen. Im folgenden Beispiel wird eine benutzerdefinierte Metrik erstellt, die den Akkuladestand misst.

    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" \

    Ausgabe:

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

  2. Nachdem Sie Ihre benutzerdefinierte Metrik erstellt haben, können Sie die benutzerdefinierte Metrik entweder mit update-security-profile zu einem vorhandenen Profil hinzufügen oder mit create-security-profile ein neues Sicherheitsprofil erstellen, um die benutzerdefinierte Metrik hinzuzufügen. Hier erstellen wir ein neues Sicherheitsprofil namens BatteryUsage, zu dem wir unsere neue benutzerdefinierte BatteryPercentage-Metrik hinzufügen können. Wir fügen ferner eine Rules Detect-Metrik namens CellularBandwidth hinzu.

    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

    Ausgabe:

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

Perzentil-Statistiken für Metriken sind nicht verfügbar, wenn es Metrik-Werte gibt, die negative Zahlen enthalten.

Anzeigen der Details von benutzerdefinierten Metriken

Das folgende Verfahren zeigt Ihnen, wie Sie die Details einer benutzerdefinierten Metrik in der CLI anzeigen können.

  • Verwenden Sie den Befehl list-custom-metrics, um alle Ihre benutzerdefinierten Metriken anzuzeigen.

    aws iot list-custom-metrics \
    --region us-east-1

    Die Ausgabe dieses Befehls sieht wie folgt aus:

    {
    "metricNames": [
        "batteryPercentage"
    ]
}

Aktualisieren einer benutzerdefinierten Metrik

Das folgende Verfahren zeigt Ihnen, wie Sie eine benutzerdefinierte Metrik in der CLI aktualisieren können.

  • Verwenden Sie den Befehl update-custom-metric, um eine benutzerdefinierte Metrik zu aktualisieren. Im folgenden Beispiel wird der display-name aktualisiert.

    aws iot update-custom-metric \
    --metric-name batteryPercentage \
    --display-name 'remaining battery percentage on device' \
    --region us-east-1

    Die Ausgabe dieses Befehls sieht wie folgt aus:

    {
    "metricName": "batteryPercentage",
    "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/batteryPercentage",
    "metricType": "number",
    "displayName": "remaining battery percentage on device",
    "creationDate": "2020-11-17T23:01:35.110000-08:00",
    "lastModifiedDate": "2020-11-17T23:02:12.879000-08:00"
}

Löschen einer benutzerdefinierten Metrik

Das folgende Verfahren zeigt Ihnen, wie Sie eine benutzerdefinierte Metrik aus der CLI löschen können.

  1. Um eine benutzerdefinierte Metrik zu löschen, entfernen Sie sie zunächst aus allen Sicherheitsprofilen, denen sie angefügt ist. Mit dem Befehl list-security-profiles können Sie Sicherheitsprofile mit einer bestimmten Dimension anzeigen.

  2. Mit dem Befehl update-security-profiles können Sie eine Dimension aus einem Sicherheitsprofil entfernen. Geben Sie alle Informationen ein, die Sie behalten möchten, jedoch nicht die Dimension.

    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}}]"

    Die Ausgabe dieses Befehls sieht wie folgt aus:

    {
  "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
}

  3. Nachdem die benutzerdefinierte Metrik getrennt wurde, verwenden Sie den Befehl delete-custom-metric, um die benutzerdefinierte Metrik zu löschen.

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

    Die Ausgabe dieses Befehls sieht wie folgt aus:

    HTTP 200

CLI-Befehle für benutzerdefinierte Metriken

Mit den folgenden CLI-Befehlen können Sie benutzerdefinierte Metriken erstellen und verwalten.

Benutzerdefinierte Metriken-APIs

Die folgenden APIs können verwendet werden, um benutzerdefinierte Metriken zu erstellen und zu verwalten.