REST-API-Connectorquellen für Humio konfigurieren

Verwenden Sie den Connector REST API, um Verbindungen zu REST-konformen Humio-Services in der Humio-Cloud herzustellen. Nur die REST-API Search wird unterstützt.

Vorbereitende Schritte

Wichtig: Der REST-API-Connector wird nur auf Konnektivität zur REST-API Search überprüft. Der Connector wird mit einem begrenzten Zugriff auf Humio-Daten geprüft. Das in diesem Thema bereitgestellte Umsetzungsscript gilt nur für die API Search und wurde für andere Humio-APIs nicht verifiziert. Wenden Sie sich an Ihren Ansprechpartner bei IBM Professional Services, um die Unterstützung für andere Humio-APIs zu aktivieren.
  • Stellen Sie sicher, dass Sie über ein Humio-Konto und über Zugriff auf die Humio-Repositorys Ihres Unternehmens verfügen und dass das API-Token generiert wurde.

    Weitere Informationen finden Sie unter https://docs.humio.com/cloud-organizations/.

  • Stellen Sie sicher, dass der Web-Service, der verbunden werden soll, betriebsbereit ist.
  • Sie können Daten nur für die Search-REST-APIs abrufen.

    Weitere Informationen zu URI-Formaten finden Sie unter https://docs.humio.com/reference/api/.

  • Erstellen Sie eine Umsetzungsscriptdatei. Die Scriptdatei enthält die Logik, die die JSON-Antwort in ein kompatibles Format umsetzt, das im Dashboard angezeigt werden kann.
    Verwenden Sie die folgende Beispieldatei, um eine neue Scriptdatei für die Antwortumsetzung zu erstellen:
    • Beispielscriptdatei: restapi_sample_response_t12n.txt
    • Beispieldateiposition: $installationsverzeichnis/wlp/usr/servers/prdapp/restapi_t12n

    Dabei ist installationsverzeichnis das Verzeichnis, in dem die Anwendung installiert wurde. Wenn Sie bei der Installation kein anderes Installationsverzeichnis angegeben haben, befindet sich die Anwendung standardmäßig im Ordner /opt/icabi.

    Die von Ihnen erstellte Antwortumsetzungsdatei muss die Namenserweiterung .js aufweisen und muss sich an der gleichen Speicherposition wie die Beispieldatei befinden. Der Dateiname darf nicht länger als 100 Zeichen sein. Sie müssen den Namen dieser Antwortumsetzungsdatei im Feld Name des Scripts für die Antwortumwandlung eingeben, wie in den Prozedurschritten im weiteren Verlauf dieses Abschnitts beschrieben.
  • Wenn Sie für die Beispielanforderung angepasste Header bereitstellen müssen, müssen Sie sicherstellen, dass Ihnen diese Informationen zur Verfügung stehen. Angepasste Header sind Anforderungsheader, die zum Abrufen von REST-API-Informationen von einem Web-Service benötigt werden, wie beispielsweise Anforderungsheader für die Autorisierung oder Anforderungsheader 'Accept-Charset'. Anforderungsheader für die Autorisierung enthalten Berechtigungsinformationen, die für den Web-Service erforderlich sind. 'Accept-Charset' gibt die zulässigen Datenzeichen an, die in der Antwort enthalten sein müssen.

Vorgehensweise

Umsetzungsscriptdatei erstellen.

  • Führen Sie die folgenden Schritte aus, um eine Umsetzungsscriptdatei zu erstellen:
    1. Wechseln Sie in das folgende Verzeichnis, in dem sich die Beispielscriptdatei restapi_sample_response_t12n.txt für die Umsetzung befindet:

      $installationsverzeichnis/wlp/usr/servers/prdapp/restapi_t12n

    2. Erstellen Sie eine Kopie dieser Datei, benennen Sie die Datei um und öffnen Sie diese Datei in einem beliebigen Texteditor.
    3. Löschen Sie den Inhalt der Datei, kopieren Sie das folgende Script und fügen Sie es in die Datei ein:
      
      var input;
      var finalJson;
      var output;
      input = JSON.parse(transformationInput);
      var isUnconvertableJSON = false;
      var outArr = []
      count = input['_count']
      var jsonObj = {}
      jsonObj['_count'] = count;
      outArr.push(jsonObj)
      finalJson = outArr;
      output = JSON.stringify(finalJson);
      
      
    4. Speichern Sie die Datei als JavaScript-Datei mit der Dateierweiterung .js.
      Die Scriptdatei für die Umsetzung wurde erstellt.

REST-konforme Humio-Web-Services mithilfe des Connectors REST API hinzufügen

  • Führen Sie die folgenden Schritte aus, um REST-konforme Humio-Web-Services mithilfe des Connectors REST API hinzuzufügen:
    1. Öffnen Sie Dashboard Designer.
    2. Rufen Sie im Navigationsbereich Connectors & Quellen > Connectorquellen auf.
    3. Klicken Sie auf der Seite 'Alle Connectorquellen' auf Quelle hinzufügen.

      Das Fenster Connectorquelle hinzufügen wird angezeigt.

    4. Wählen Sie in der Liste Connectortyp den Connector REST-API aus.
    5. Geben Sie in das Feld Name der Connectorquelle einen Namen für die Quelle ein.

      Der Quellenname kann alphanumerische Zeichen und Unterstreichungszeichen enthalten.

    6. Geben Sie in das Feld Endpunkt-URL die folgende URL ein:

      https://cloud.humio.com

    7. Wählen Sie in der Liste Authentifizierungstyp die Option Keiner aus.
    8. Geben Sie den Namen der Umsetzungsscriptdatei im Feld Name des Scripts für die Antwortumwandlung ein, wenn Sie die Antwort umsetzen wollen.
    9. Klicken Sie auf Weiter.
    10. Wählen Sie in der Liste Methode eine Methode aus und führen Sie basierend auf der ausgewählten Methode einen der folgenden Schritte aus:
      • Geben Sie für die Methode GET im Feld URI den URI (Uniform Resource Identifier) für die Quelle ein.
      • Geben Sie für die Methode POST im Feld URI den URI für die Quelle ein und im Feld Anforderungshauptteil die POST-Anforderung.

      Beispiel-URI für die Methode GET:

      https://cloud.humio.com/api/v1/repositories/sandbox/queryjobs/<id>

      Dabei ist <id> die ID des abzurufenden Jobs.

      Beispiel für URI und Anforderungshauptteil für die Methode POST:

      URI:

      /api/v1/repositories/sandbox/query

      Anforderungshauptteil:

      {"queryString":"count)","start":"12h","end":"now","isLive":false}
    11. Geben Sie unter Angepasste Header folgende Header und Werte ein:
      Tabelle 1. Name und Wert des angepassten Headers
      Name des angepassten Headers Wert
      Authorization Geben Sie das API-Token ein, das Sie mithilfe des Humio-Kontos generiert haben.
      Content-Type application/json
      Accept application/x-ndjson
    12. Klicken Sie auf Verbindung testen, um sicherzustellen, dass die Verbindung zur Datenquelle erfolgreich war.
      Wenn die Quellendetails und die Beispielanforderung gültig und vollständig sind, wird eine Nachricht angezeigt, die besagt, dass die Verbindung erfolgreich hergestellt wurde. Wird eine Nachricht ausgegeben, die besagt, dass ein Verbindungsfehler aufgetreten ist, müssen Sie die in der Nachricht beschriebenen Fehler beheben und die Verbindung erneut testen.
      Anmerkung: Auch wenn die Quellendetails gültig sind, kann es vorkommen, dass eine Verbindungsfehlernachricht angezeigt wird. Dies ist der Fall, wenn für die Beispielanforderung eine ungültige Antwort empfangen wird.
    13. Klicken Sie auf Speichern.

Ergebnisse

Auf der Seite Alle Connectorquellen werden die folgenden Details für jede Connectorquelle angezeigt:
  • Name der Connectorquelle
  • Connectortyp
  • Datum und Uhrzeit der erstmaligen Erstellung der Connectorquelle sowie der Benutzername des Benutzers, der die Quelle anfänglich erstellt hat.
  • Datum und Uhrzeit der letzten Änderung der Connectorquelle sowie der Benutzername des Benutzers, der die Connectorquelle zuletzt geändert hat. Es wird nur der neueste Datensatz angezeigt.
Der REST-API-Service wird hinzugefügt und kann verwendet werden, um angepasste Datendefinitionen zu erstellen.