Erstellen Sie Ihre erste Telemetry Router-Instanz, verbinden Sie diese mit Logs und fragen Sie Ihre Audit-Daten ab

Voraussetzungen

• Sie haben ein STACKIT Kundenkonto: Kundenkonto erstellen
• Sie haben ein STACKIT Benutzerkonto: Benutzerkonto erstellen
• Sie haben ein STACKIT Projekt: Projekt erstellen

Vorbereiten, Bestellen und Erstellen einer Instanz

In diesem Leitfaden erstellen Sie eine Instanz des STACKIT Telemetry Router selbst und eine STACKIT Logs-Instanz. Letztere verwenden Sie als OLTP-Ziel. Dieser Leitfaden zeigt die gängigsten Einstellungen für den Einstieg. Für eine produktive Umgebung müssen Sie eventuell einige Einstellungen anpassen. Während Sie diesen Leitfaden durcharbeiten, bleiben Sie im STACKIT Portal. Es gibt viele andere Möglichkeiten, Instanzen zu verwalten. Für ein tieferes Verständnis lesen Sie Instanzen von Telemetry Router erstellen und verwalten.

Erstellen und Konfigurieren einer STACKIT Logs-Instanz

Um ein Ziel für Ihren Log-Stream zu haben, erstellen wir eine STACKIT Logs-Instanz. In einem realen Szenario können Sie jedes beliebige Ziel wählen. Lesen Sie Ziele von Telemetry Router erstellen und verwalten, um weitere Informationen über mögliche Ziele, unterstützte Protokolle und deren Konfiguration zu erhalten.

1. Besuchen Sie das STACKIT Portal.

2. Klicken Sie in der Seitenleiste auf Logs.

3. Klicken Sie in der Leiste oben auf Logs erstellen.

4. Geben Sie im Overlay einfach einen Datenbanknamen ein und klicken Sie auf Kostenpflichtig bestellen. Sie müssen die anderen Einstellungen nicht ändern, um das Ziel dieses Tutorials zu erreichen.

5. Nachdem die Instanz ihren Active-Status erreicht hat, öffnen Sie diese durch Klicken auf ihren Eintrag, um in den Bereich Übersicht zu gelangen.

6. Kopieren Sie die Instanz-ID an einen sicheren Ort. Sie benötigen diese später. Sie finden die Instanz-ID im Bereich „Allgemeine Informationen“.

7. Kopieren Sie die URLs für Ingest und den Abfragezeitraum an einen sicheren Ort. Sie finden beide Informationen, indem Sie im linken Bereich auf API klicken.

8. Erstellen Sie ein Zugriffstoken und kopieren Sie es an einen sicheren Ort. Klicken Sie in der Leiste links auf Zugriffstoken. Klicken Sie auf der neuen Seite auf Zugriffstoken erstellen.

   Geben Sie im Bereich einen Namen für Ihr Token ein. Diesen können Sie frei wählen. Wählen Sie im Dropdown-Menü Rolle „Read and Write“ aus und klicken Sie auf Erstellen. Kopieren Sie nach dem Klicken auf „Erstellen“ das Token an einen sicheren Ort. Wenn Sie es verlieren, müssen Sie ein neues Token erstellen.

Nun haben Sie eine laufende STACKIT Logs-Instanz mit allen Zugangsdaten und Informationen, die Sie benötigen, um sie in Kombination mit Telemetry Router zu verwenden.

Erstellen und Konfigurieren Ihrer STACKIT Telemetry Router-Instanz

In diesem Unterkapitel erstellen und konfigurieren Sie die eigentliche Telemetry Router-Instanz und fügen eine Verknüpfung auf Projektebene hinzu.

Erstellen Sie Ihre Instanz und generieren Sie ein Zugriffstoken.

1. Besuchen Sie das STACKIT Portal.

2. Klicken Sie in der Seitenleiste auf Telemetry Router.

3. Klicken Sie in der Leiste oben auf Telemetry Router erstellen.

4. Geben Sie im Overlay einen Router-Namen ein und klicken Sie auf Erstellen.

5. Wenn der Status Ihrer Instanz AKTIV ist, klicken Sie in der Seitenleiste auf Zugriffstoken.

6. Klicken Sie auf Zugriffstoken erstellen.

7. Füllen Sie im neuen Bereich alle erforderlichen Informationen aus: Geben Sie einen aussagekräftigen Namen ein und klicken Sie auf unbegrenzte Lebensdauer. Klicken Sie dann auf „Erstellen“. Kopieren Sie Ihr Token an einen sicheren Ort. Speichern Sie auch die ID Ihres Telemetry Router an einem sicheren Ort.

   Für dieses Tutorial erstellen wir ein Token mit einer unbegrenzten Lebensdauer. Aus Sicherheitsgründen kann es sinnvoll sein, eine begrenzte Lebensdauer zu definieren.

Erstellen Sie eine Verknüpfung zu Ihrer Instanz

1. Klicken Sie in der oberen linken Ecke auf das STACKIT Logo, um auf die oberste Ebene des Portals zu gelangen.

2. Klicken Sie in der Seitenleiste auf Telemetry Links.

3. Klicken Sie auf Telemetry Link erstellen.

4. Füllen Sie im Bereich alle erforderlichen Informationen aus: Geben Sie die ID und das Zugriffstoken aus der Erstellung der Telemetry Router-Instanz ein. Klicken Sie dann auf Erstellen.

   Warten Sie nach diesem Schritt sorgfältig, bis Ihre Verknüpfung bereit ist. Andernfalls müssen Sie nach Abschluss des nächsten Schritts möglicherweise ein neues Audit-Ereignis auslösen.

Konfigurieren Sie Ihre STACKIT Telemetry Router-Instanz

Um Änderungen an Ihrer Instanz vorzunehmen, müssen Sie diese auswählen. Klicken Sie in der Seitenleiste auf Telemetry Router und dann auf Ihre neu erstellte Instanz. Dann wird die Übersichtsseite Ihrer Instanz angezeigt.

Erstellen Sie ein Ziel und verweisen Sie auf Ihre STACKIT Logs-Instanz

1. Klicken Sie in der Seitenleiste auf Ziele.

2. Klicken Sie auf Ziel erstellen.

3. Im Popup müssen Sie einen Namen eingeben.

4. Wählen Sie als Typ OpenTelemetry aus.

5. Klicken Sie auf Weiter, um den zweiten Schritt zu erreichen.

6. Bleiben Sie bei der vordefinierten Einstellung Bearer token, geben Sie die URI und das eigentliche Bearer-Token ein.

   Die URI ist die Ingest-URI, die Sie von Ihrer STACKIT Logs-Instanz kopiert haben. Das Bearer-Token ist das Zugriffstoken, das Sie einen Schritt zuvor erstellt haben.

7. Klicken Sie auf Erstellen.

Ein auditierbares Ereignis auslösen

Man könnte meinen, dass Sie ein auditierbares Ereignis auslösen müssen, das dann abgefragt werden kann. Aber mit der Erstellung eines Ziels für Ihre Telemetry Router-Instanz haben Sie bereits ein Ereignis ausgelöst.

Falls Sie diesen Leitfaden nicht in der vorgesehenen Reihenfolge durchlaufen haben, insbesondere wenn Sie die Verknüpfung nach dem Ziel erstellt haben, müssen Sie möglicherweise manuell ein auditierbares Ereignis auslösen. In diesem Fall können Sie beispielsweise eine weitere STACKIT Logs-Instanz erstellen und diese direkt nach der Erstellung wieder entfernen.

Fragen Sie Ihre STACKIT Logs-Instanz ab, um die gespeicherten Audit-Logs zu erhalten

Um Ihre Audit-Logs abzufragen, benötigen Sie einen Client, der GET-Anfragen mit konfigurierbaren Headern durchführen kann. In diesem Leitfaden verwenden wir Postman.

Verwenden Sie die zuvor gespeicherte URI für den Abfragezeitraum als Startpunkt. In diesem Leitfaden zeigen wir das Prinzip anhand einer Beispiel-Instanz. Sie hat die ID 851585dd-bbeb-42ad-afa1-e42e18ff72d8. Daraus ergibt sich die folgende Basis-URI: https://851585dd-bbeb-42ad-afa1-e42e18ff72d8.logs.eu01.onstackit.cloud/loki/api/v1/query_range.

Abfragen an STACKIT Logs benötigen immer einen nicht leeren Abfrageparameter. Da alle Audit-Objekte einen service_name-Schlüssel haben, filtern wir nach jedem möglichen Vorkommen davon. Der Ausdruck lautet: {service_name=~".+"}. Um Probleme mit der Kodierung zu vermeiden, stellen wir eine kodierte Version bereit: %7Bservice_name%3D~%22.%2B%22%7D. Die endgültige URI zur Abfrage Ihrer Audit-Objekte lautet:

https://851585dd-bbeb-42ad-afa1-e42e18ff72d8.logs.eu01.onstackit.cloud/loki/api/v1/query?range?query=%7Bservice_name%3D~%22.%2B%22%7D

Ihre Instanz-ID unterscheidet sich von unserem Beispiel. Verwenden Sie die gespeicherte URI aus dem STACKIT Logs-Teil dieses Leitfadens und hängen Sie ?query=%7Bservice_name%3D~%22.%2B%22%7D an.

Um Postman für die Abfrage gegenüber STACKIT Logs zu authentifizieren, müssen Sie das Bearer-Token zum Header hinzufügen. Klicken Sie in Postman auf den Reiter Authorization und wählen Sie im Dropdown-Menü Auth Type Bearer Token aus. Fügen Sie das zuvor gespeicherte STACKIT Logs-Zugriffstoken in das Feld auf der rechten Seite ein.

Verwenden Sie für den Produktivbetrieb ein dediziertes Read-only-Token für diese Aufgabe. Speichern Sie es außerdem als Environment Secret in Postman, anstatt es im Klartext einzufügen.

Der Server antwortet mit einem JSON-Objekt. Es sieht ähnlich aus wie auf dem Screenshot:

Sie finden die eigentlichen Audit-Log-Einträge in einem Array namens result. Hier finden Sie einen Beispiel-Eintrag in diesem Array, der ein Audit-Ereignis verkörpert.

{
  "stream": {
    "cloud_region": "eu01",
    "detected_level": "INFO",
    "http_request_method": "GET",
    "observed_timestamp": "1777997157625756444",
    "scope_name": "audit-logger",
    "server_address": "ske-api.ing.ske.eu01.stackit.cloud",
    "service_instance_id": "118e6780-c9d0-48d0-87a3-044fe90c17c4",
    "service_name": "unknown_service:ske-api",
    "service_name_extracted": "ske",
    "severity_number": "9",
    "severity_text": "INFO",
    "stackit_action": "ske.clusters.list",
    "stackit_initiator": "ca83351e-6262-4987-8c1c-2b7894bcb4d9",
    "stackit_log_id": "4d6c9b41-489c-11f1-877d-ba44d7fb4040",
    "stackit_log_type": "AUDIT",
    "stackit_request_body": "{\"projectId\":\"118e6780-c9d0-48d0-87a3-044fe90c17c4\",\"region\":\"eu01\"}",
    "stackit_resource_id": "118e6780-c9d0-48d0-87a3-044fe90c17c4",
    "stackit_resource_type": "PROJECT",
    "stackit_visibility": "PUBLIC",
    "telemetry_sdk_language": "go",
    "telemetry_sdk_name": "opentelemetry",
    "telemetry_sdk_version": "1.43.0",
    "url_path": "/v2/projects/118e6780-c9d0-48d0-87a3-044fe90c17c4/regions/eu01/clusters",
    "user_agent": "stackit-sdk-go/ske"
  },
  "values": [["1777997157625750313", "ListClusters"]]
}

Nun haben Sie einen Überblick über Audit Logging erhalten. Von hier aus möchten Sie vielleicht weitere Informationen aus einem der How-tos erhalten. Lesen Sie Erstellen und Verwalten von Telemetry Router-Instanzen, Erstellen und Verwalten von Telemetry Router-Destinations oder Erstellen und Verwalten von Telemetry Router-Links, um mehr über das Produkt zu erfahren.