Erstellen Sie eine benutzerdefinierte Metrik

Zusätzlich zur Analyse der integrierten Protokollmetriken im ExtraHop-System können Sie Ihre eigenen benutzerdefinierten Metriken erstellen, um spezifische Informationen über Ihre Umgebung zu sammeln. Die Erstellung einer benutzerdefinierten Metrik erfordert zwei Teile: die Angabe von Metrikparametern im Metrikkatalog und die Erstellung eines Auslöser zum Ermitteln, Sammeln und Speichern von benutzerdefinierten Metrikdaten. In diesem Thema erfahren Sie, wie Sie eine benutzerdefinierte Metrik aus dem Metrikkatalog erstellen.

Wenn Sie zuerst eine benutzerdefinierte Metrik aus dem Metrikkatalog erstellen, können Sie die neue Metrik einem Dashboard oder Diagramm hinzufügen, bevor benutzerdefinierte Metrikdaten erfasst werden. Wenn Sie zuerst einen Auslöser für eine benutzerdefinierte Metrik erstellen, ohne Metrikparameter anzugeben, können Sie möglicherweise nicht auf die benutzerdefinierte Metrik zugreifen, bis die Daten vom ExtraHop-System beobachtet und erfasst wurden.

Hinweis:Benutzerdefinierte Metriken sind nur verfügbar in Fortgeschrittene Analyse.

Die folgenden Schritte zeigen Ihnen, wie Sie mit dem Metrikkatalog eine benutzerdefinierte Metrik erstellen.

Before you begin

Beachten Sie, dass die Parameter, die Sie im Metrikkatalog angeben, Teil des Codes werden, auf den ein Auslöser verweist. Parameter wie der Metrikname und der Metriktyp können nach der Erstellung der benutzerdefinierten Metrik im Metrikkatalog nicht geändert werden. Bevor Sie eine benutzerdefinierte Metrik erstellen oder einen Auslöser schreiben, sollten Sie ermitteln, welche Ereignisse und Geräte zum Extrahieren der benötigten Daten erforderlich sind, und stellen Sie fest, ob bereits eine Lösung vorhanden ist. Weitere Informationen finden Sie unter Auslöser.
  1. Loggen Sie sich in das ExtraHop-System ein über https://<extrahop-hostname-or-IP-address>.
  2. Klicken Sie auf das Symbol Systemeinstellungen und dann klicken Metrischer Katalog.
  3. Klicken Sie auf das Befehlsmenü und wähle Metrik manuell erstellen.
  4. In der Parameter Führen Sie in diesem Abschnitt die folgenden Schritte aus, um den Code zu erstellen, auf den ein Auslöser verweist:
    1. Geben Sie im Feld Metrik einen eindeutigen Namen für Ihre Metrik ein. Die Trigger-Methode, die Daten für Ihre benutzerdefinierte Metrik sammelt, muss auf den exakten Metriknamen verweisen, den Sie im Feld Metrik angeben. Vermeiden Sie Leerzeichen zwischen Wörtern, indem Sie Unterstriche eingeben. Wenn Sie einen Detail-Metrik Metriknamen definieren, geben Sie den Detailschlüssel im Namen an, indem Sie den Metriknamen mit anhängen .by_<key_name_without_spaces>, wo <key_name_without_spaces> ist der Name der Schlüsselmetrik.
      Eine benutzerdefinierte Metrik, die die maximale Anzahl von HTTP-Antworten pro Client erfasst, könnte beispielsweise wie folgt angegeben werden: max_http_responses.by_client.
    2. Wählen Sie im Feld Quelltyp eine Quelle oder Klasse aus der Dropdownliste aus, aus der Sie Daten abrufen möchten. Weitere Informationen zu diesen Klassen finden Sie unter Kurse für allgemeine Zwecke in der Trigger-API-Referenz.
    3. Wählen Sie im Feld Metriktyp eine Option aus der Drop-down-Liste aus, die angibt, wie Daten im ExtraHop-System gespeichert und angezeigt werden. Die Auswahl des Metriktyps wird in Triggern als Teil des Methodennamens angezeigt, z. B. metricAddCount oder metricAddDataset. Weitere Informationen finden Sie unter ExtraHop-Datentypen in der Trigger-API-Referenz.
    4. Wählen Sie im Feld Typ eine der folgenden Optionen aus:
    • Wählen Basismetrik. Eine Basismetrik oder Top-Level-Metrik umfasst die Metriktypen Anzahl und Datensatz. Die Typauswahl wird in Triggern als Teil des Methodennamens angezeigt, zum Beispiel metricAddDataset.
    • Wählen Detail: Metrik. Eine Detail-Metrik besteht aus Schlüssel-Wert-Paaren, wobei der Schlüssel eine Zeichenfolge oder IP-Adresse und der Wert ein Metriktyp der obersten Ebene ist, z. B. eine Zähl- oder Datensatzmetrik. Die Typauswahl wird in Triggern als Teil des Methodennamens angezeigt, zum Beispiel metricAddDetailDataset.
    Wichtig:Die im Abschnitt Parameter getroffenen Auswahlen können nicht geändert werden, nachdem Sie die benutzerdefinierte Metrik erstellt haben.
  5. Gehen Sie im Bereich Anzeige wie folgt vor, um Metrikinformationen anzugeben, nach denen Benutzer im ExtraHop-System suchen können:
    1. Geben Sie im Feld Name einen benutzerfreundlichen Anzeigenamen für Ihre Metrik ein , der in Suchergebnissen und Diagrammen im ExtraHop-System angezeigt wird. Sie können Leerzeichen in den Anzeigenamen aufnehmen.
    2. Optional: Wählen Sie im Feld Einheiten eine Option aus der Dropdownliste aus, wenn Sie die Maßeinheit kennen, die in einem Diagramm für Ihre Metrik Daten angezeigt werden soll.
    3. Optional: Geben Sie im Feld Beschreibung Informationen ein, die zusammen mit den Suchergebnissen für Ihre Metrik im ExtraHop-System angezeigt werden. Die Beschreibung der benutzerdefinierten Basismetrik wird automatisch für die Detail-Metrik in den Suchergebnissen angezeigt.
    4. Optional: (Nur für Detailmetriken) Geben Sie im Feld Key Label einen Anzeigenamen für den Schlüsselsatz in Ihrer Metrik ein. Sie können beispielsweise das Schlüssellabel erstellen, Benutzeragent, für eine benutzerdefinierte Metrik, die Anfragen pro HTTP-Benutzeragent sammelt. Tastenbeschriftungen müssen nicht eindeutig sein.
  6. Optional: Führen Sie im Abschnitt Detailbeziehungen einen der folgenden Schritte aus, wenn Sie eine benutzerdefinierte Basismetrik mit einer benutzerdefinierten Detail-Metrik verknüpfen möchten:
    • (Für Basiskennzahlen) Klicken Sie im Feld Detailkennzahlen auf das Feld und suchen Sie nach einer benutzerdefinierten Metrik, die Benutzer anzeigen sollen, indem Sie von der benutzerdefinierten Metrik aus einen Drilldown durchführen. Sie können dieses Feld leer lassen, wenn Sie keine Drilldown-Daten für Ihre benutzerdefinierte Metrik bereitstellen möchten.
    • (Für Detailmetriken) Wählen Sie im Feld Basismetrik eine Top-Level-Metrik aus der Dropdownliste aus, die Sie Ihrer benutzerdefinierten Detailmetrik zuordnen möchten. Sie können dieses Feld leer lassen, wenn Sie Ihrer benutzerdefinierten Metrik keine zusätzlichen Metriken zuordnen möchten.
  7. Optional: Klicken Sie im Abschnitt Datensatzbeziehungen auf die Dropdownliste DATENSATZTYP, klicken Sie auf einen oder mehrere Datensatztypen, und klicken Sie dann auf eine Stelle außerhalb der Liste. Optional können Sie die Abfrageergebnisse filtern, wenn Sie Datensätze für die benutzerdefinierte Metrik mit den folgenden Feldern aufschlüsseln.
    1. Optional: Aktivieren Sie im Abschnitt QUELLFILTER das Kontrollkästchen neben der Quelle für diese benutzerdefinierte Metrik. Dieser Filter fragt automatisch nach der Quelle ab, von der aus Sie einen Drilldown durchführen. Wenn Sie beispielsweise ein Kontrollkästchen neben Server aktivieren, wenn Sie Datensätze für diese benutzerdefinierte Metrik von einem Webserver mit dem Namen abfragen example-web-sea, Ihrer Abfrage wird automatisch ein Filter hinzugefügt, der nur Ergebnisse für Transaktionen zurückgibt, bei denen example-web-sea fungiert als Server.
    2. Optional: Im Abschnitt ZUSÄTZLICHE FILTER können Sie erweiterte Filter erstellen die Datensätze auf der Grundlage der angegebenen Kriterien abfragen, oder geben Sie einen ein regulärer Ausdruck (Regex) um Datensätze nach benutzerdefinierten Detailmetriken zu filtern.
    Hinweis:Weitere Informationen finden Sie unter Datensatzabfragen für benutzerdefinierte Metriken aktivieren.
  8. Wenn Sie mit den Parametern zufrieden sind, klicken Sie auf Erstellen. Ihre benutzerdefinierten Metrik Parameter werden dem ExtraHop-System hinzugefügt. Die REST-API-Parameter für Ihre Metrik werden im Metrikkatalog angezeigt. Sie können jetzt nach Ihrer Metrik suchen und Ihre Metrik zu Diagrammen hinzufügen.
    Wichtig:Sie müssen einen Auslöser erstellen, um benutzerdefinierte Metrikdaten zu ermitteln, zu sammeln und zu speichern.

Nächste Maßnahme

Last modified 2024-04-10