Stell dir vor, du verbindest deinen Uptrends Account mit dem Betriebsmanagementsystem, das dein Unternehmen nutzt. Wenn du Uptrends Alarmdaten in deine bestehenden Incident Management-Prozesse einspeist, entsteht eine nahtlose Integration des externen Monitorings von Uptrends in die täglichen Abläufe, die deine Teams bereits nutzen.
Wenn unsere vordefinierten Integrationstypen deine DevOps-Software nicht enthalten, kannst du die Option für benutzerdefinierte Integrationen nutzen, um die Integration selbst zu erstellen. Der Schlüssel zu einer erfolgreichen Integration liegt darin, zu wissen, welche Art von Nachricht das andere System erwartet. In der API-Dokumentation des Drittanbieters erfährst du, welche URL du verwenden und welche Inhalte du an diese URL senden musst. Sie werden oft als webhook-basierte Integrationen bezeichnet und ermöglichen Uptrends, sich in das andere System einzuklinken, indem sie direkte Aufrufe zulassen. Uptrends kann einen Aufruf an die Integration starten, sobald ein relevanter Alarm auftritt.
Dieser Artikel behandelt die Einrichtung einer benutzerdefinierten Integration, das Anpassen von Nachrichteninhalten und Nachrichtentypen, das Testen deiner Einrichtung und das Hinzufügen der Integration zu einer Meldedefinition.
Benutzerdefinierte Integration einrichten
Um eine benutzerdefinierte Integration einzurichten, führe diese Schritte aus:
- Erstelle eine benutzerdefinierte Integration mit einer der folgenden Optionen:
- Alarmierung > Integrationen +.
- Konfigurieren > Benachrichtigungskanäle +.
- Speichern unter — öffne eine bestehende benutzerdefinierte Integration und klicke auf Speichern unter, um sie zu duplizieren. Mit der Kopie kannst du bestehende Konfigurationen wiederverwenden, statt von Grund auf neu zu beginnen.
Notiz
Du kannst keine integrierten Integrationen (E-Mail, SMS, Telefon) oder Drittanbieterintegrationen duplizieren, die einen eigenen Einrichtungsablauf erfordern, zum Beispiel Slack und PagerDuty.
-
Wähle Uptrends Integration. Klicke dann auf Wählen....
-
Gib einen Integrationsnamen an.
-
Gib die API-URL an, mit der du eine Verbindung herstellen möchtest.
-
(Optional) Passe deine Integration auf der Registerkarte Anpassungen an.
-
Klicke auf Speichern, um die Änderungen zu bestätigen.
API-URL angeben
Die ApiUrl ist eine vordefinierte Variable, die die Ziel-URL für den HTTP-Aufruf enthält.
Es gibt zwei Optionen, um die API-URL anzugeben:
- Wert hier eintragen — legt die
ApiUrlauf Integrationsebene fest. Jede Meldedefinition und Eskalationsstufe, die diese Integration verwendet, erhält dieselbe URL. Du kannst die Uptrends Vault verwenden, um die API-URL zu speichern. Weitere Informationen findest du unter Uptrends Vault
- Wert in Eskalations-Level definieren — legt die
ApiUrlfest, wenn du die Integration einer Eskalationsstufe in einer Meldedefinition hinzufügst. Jede Eskalationsstufe hat ein eigenes URL-Feld, sodass eine Integration in verschiedenen Meldedefinitionen auf unterschiedliche Endpunkte verweisen kann.
Integrationen anpassen
Lege auf der Registerkarte Anpassungen fest, was Uptrends sendet, wenn ein Alarm ausgelöst wird.
Uptrends stellt eine vordefinierte Vorlage bereit, die die verfügbaren Informationen aus einem Alarm enthält. Diese Vorlage ist ein anpassbarer, JSON-formatierter Nachrichtentext, den du unter Request Body findest.
{
"alert": {
"alertGuid": "{{@alert.alertGuid}}",
"type": "{{@alert.type}}",
"description": "{{@JsonEncode({{@alert.description}})}}",
"failureMessage": "{{@alert.failureMessage}}",
...
}
}
Der Body enthält die gesamte Auswahl an Alarmierungsvariablen, zum Beispiel {{@alert.alertGuid}} oder {{@alert.description}}. Uptrends ersetzt diese Platzhalter durch Live-Alarmdaten, wenn die Nachricht gesendet wird. Bearbeite die Vorlage, um Felder zu entfernen, eigene Daten hinzuzufügen oder das Format zu ändern.
Weitere Informationen findest du unter:
- Den richtigen Nachrichteninhalt erzeugen — Nachrichteninhalt anpassen und Variablen verwenden
- Nachrichtenformatierung — ausgehende Nachrichten korrekt formatieren und Fehler in der empfangenden Anwendung vermeiden
- Alarmierungs-Systemvariablen — vollständige Liste der verfügbaren Variablen
Nachrichtentypen
Alarmierungsnachrichten gibt es in verschiedenen Typen. Uptrends unterscheidet zwischen Fehler Nachrichten, Erinnerung Nachrichten und OK Nachrichten. Standardmäßig werden all diese Nachrichtentypen mit derselben Einrichtung erstellt. Wenn du jedoch eine benutzerdefinierte Integration einrichtest oder eine bestehende Integration anpasst, kannst du unterschiedliche Aktionssets für jeden einzelnen Nachrichtentyp erstellen. Weitere Informationen findest du unter Nachrichtentypen.
Benutzerdefinierte Integration testen
Sobald du eine benutzerdefinierte Integration erstellst oder änderst, teste sie, bevor du sie in der Produktion einsetzt. Du kannst eine Testnachricht aus dem Integrationseditor senden, ohne die Integration einer Meldedefinition hinzuzufügen. Weitere Informationen findest du unter Deine benutzerdefinierte Integration testen.
Integration zur Meldedefinition hinzufügen
Eine Integrationsdefinition allein bewirkt nichts. Du musst sie einer oder mehreren Eskalationsstufen einer Meldedefinition hinzufügen, um Alarme über die Integration zu erhalten.
Um eine Integrationsdefinition einer Eskalationsstufe hinzuzufügen:
- Öffne die Seite mit den Meldedefinitionen über eine der folgenden Optionen:
- Alarmierung > Meldedefinitionen
- Konfigurieren > Alarmeskalationen
- Öffne die Meldedefinition, die du verwenden möchtest.
- Klicke auf eine Registerkarte Eskalationsstufe.
- Aktiviere die Kontrollkästchen für deine benutzerdefinierten Integrationsdefinitionen.
- Klicke auf Speichern, um die Änderungen zu bestätigen.
Deine Integration ist jetzt mit der Meldedefinition verknüpft. Wenn ein Prüfobjekt, das dieser Meldedefinition zugewiesen ist, einen Alarm auslöst und die Bedingungen der Eskalationsstufe erfüllt sind, sendet Uptrends die konfigurierte Nachricht über die Integration.
Wenn du Fragen hast, wende dich bitte an unser Support-Team.