REST API

Ereignisse und Transaktionen über die REST API

Kostenlos in jedem Plan, auch im kostenlosen

Kostenlos starten Dokumentation

Voraussetzungen Beliebiger HTTP-Client

Woher nehmen Kein Paket

Preise Kostenlos

Wozu es dient

Die DockRay REST API ermöglicht es, Fehler, Ausnahmen und Informationen über HTTP-Transaktionen direkt aus beliebigen Anwendungen, Diensten oder Geräten an die DockRay-Plattform zu übermitteln.

Diese Lösung ist vor allem für Technologien vorgesehen, für die noch keine dedizierte DockRay-Bibliothek, kein Modul oder Plugin verfügbar ist.

Reporting von Fehlern und Ausnahmen

Der Fehler-Endpoint ermöglicht die Übermittlung von Ereignissen mit Informationen, die für die Diagnose von Problemen in der Anwendung erforderlich sind.

Eine Meldung kann unter anderem folgende Informationen enthalten:

Typ und Beschreibung des Fehlers oder der Ausnahme,
Stack Trace,
Umgebung und Anwendungsversion,
Informationen über SDK, Runtime und Betriebssystem,
Kontext der HTTP-Anfrage,
optionale Benutzerdaten.

Monitoring von HTTP-Transaktionen

Ein separater Endpoint ermöglicht die Meldung verarbeiteter HTTP-Transaktionen, einschließlich Transaktionsname, Methode, Adresse, Ereigniszeitpunkt, HTTP-Statuscode und Informationen über die Umgebung.

Diese Daten können zur Analyse des Datenverkehrs, des Anfrageverlaufs und der Verteilung von HTTP-Antworten im überwachten Projekt verwendet werden.

Beliebige Technologie

Die REST API erfordert weder eine bestimmte Programmiersprache noch ein bestimmtes Framework. Es genügt, HTTP-Anfragen ausführen und Daten im JSON-Format senden zu können.

Dadurch lässt sich DockRay in eigene Backends, Microservices, Geräte, Skripte und weniger verbreitete Technologien integrieren.

Authentifizierung

Jede Meldung wird über den Projekt-Token einem Projekt zugeordnet. Die Anfrage wird mit dem privaten Schlüssel des Projekts authentifiziert, der im Authorization-Header übermittelt wird.

Der private Schlüssel sollte ausschließlich serverseitig gespeichert und niemals in öffentlichen Anwendungscode eingebunden werden.

Datenformat

Die Endpoints akzeptieren JSON-Daten in einem Format, das dem Ereignismodell von DockRay entspricht. Der Payload kann direkt oder mit gzip komprimiert gesendet werden.

Installation

Für die Integration benötigen Sie den Projekt-Token und den privaten Schlüssel, die im DockRay-Dashboard verfügbar sind.

Der Projekt-Token ist Bestandteil der Endpoint-URL, während der private Schlüssel als Bearer-Token im Authorization-Header übermittelt werden muss.

Reporting von Fehlern

Senden Sie eine POST-Anfrage an den folgenden Endpoint:

https://dockray.io/api/v1/PROJECT_TOKEN/project

Fügen Sie die erforderlichen Header hinzu:

Authorization: Bearer PROJECT_PRIVATE_KEY
Content-Type: application/json

Reporting von HTTP-Transaktionen

Transaktionen werden an einen separaten Endpoint gesendet:

https://dockray.io/api/v1/PROJECT_TOKEN/transaction

Jede Transaktion kann unter anderem den Routennamen, die HTTP-Methode, den HTTP-Statuscode, den Ereigniszeitpunkt, die Umgebung sowie Informationen über Runtime und Anwendung enthalten.

Der private Schlüssel des Projekts darf nicht in clientseitigem Browser-Code oder an anderen öffentlich zugänglichen Stellen hinterlegt werden.

So wird es verwendet

Ausnahmen meldet die Integration von selbst. Das hier ist für Meldungen, die Sie bewusst senden.

bash

curl -X POST https://dockray.io/api/v1/PROJECT_TOKEN/project \
  -H 'Authorization: Bearer PROJECT_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "environment": "production",
    "sdk": {
      "name": "custom-http-client",
      "version": "1.0.0"
    },
    "exception": {
      "values": [
        {
          "type": "RuntimeException",
          "value": "Payment gateway returned an unexpected response",
          "stacktrace": {
            "frames": []
          }
        }
      ]
    },
    "request": {
      "url": "https://api.example.com/api/orders",
      "method": "POST"
    }
  }'