PagerDuty Schritt-für-Schritt-Anleitung für die Integration

Erfahren Sie, wie Sie Oracle Cloud Infrastructure Notifications in PagerDuty integrieren, damit Sie PagerDuty-Vorfälle auslösen können.

Überblick

Die Integration mit PagerDuty umfasst die folgenden Aufgaben.

PagerDuty-Endpunkt erstellen

Um dieses Verfahren abzuschließen, benötigen Sie eine der folgenden Rollen in PagerDuty: Manager, Admin, Global Admin oder Accountverantwortlicher.

Gehen Sie zu PagerDuty.
Wählen Sie im Menü Konfiguration die Option Services.
Auf Ihrer Services-Seite:
1. Wenn Sie einen Service für Ihre Integration erstellen, wählen Sie +Add Neuer Service aus.
2. Wenn Sie die Integration zu einem vorhandenen Service hinzufügen, wählen Sie den Namen des Service aus, dem Sie die Integration hinzufügen möchten. Wählen Sie dann die Registerkarte Integrationen aus, und klicken Sie auf die Schaltfläche +New-Integration.
Geben Sie einen Integrationsnamen im Format monitoring-tool-service-name ein.

Wenn Sie einen Service für Ihre Integration erstellen, geben Sie in den Vorfalleinstellungen die Eskalations-Policy, die Benachrichtigungsdringlichkeit und das Vorfallsverhalten für Ihren neuen Service an.
Wählen Sie im Menü Integrationstyp basierend auf den folgenden Optionen den gewünschten Endpunkttyp aus:
- Oracle Cloud Infrastructure Monitoring: Wenn Sie nur Nachrichten per Alarm veröffentlichen möchten (mit dem Alarmnachrichtenformat). Für diesen Endpunkttyp antwortet PagerDuty entsprechend dem Nachrichtenformat:
  - Nachrichten, die generische Nachrichtenformate verwenden, werden ignoriert. Beispiel: Wenn Ihre Ereignisregel die Veröffentlichung einer Nachricht in dem Thema auslöst, das dieses Abonnement enthält, oder wenn Sie eine Nachricht direkt mit dem Notifications-Service in dem Thema veröffentlichen, wird kein PagerDuty-Vorfall erstellt.
  - Nachrichten, die das Alarmnachrichtenformat verwenden, werden verarbeitet. Beispiel: Wenn Ihr Alarm die Veröffentlichung einer Nachricht an das Thema im Alarmnachrichtenformat auslöst, wird ein PagerDuty-Vorfall erstellt.
- Transformator für benutzerdefinierte Ereignisse: Wenn Nachrichten einen PagerDuty-Vorfall generieren sollen, unabhängig davon, ob sie aus Ereignisregeln, Alarmen, Connectors, Konsolenankündigungen oder direkten Veröffentlichungen stammen. Nachrichten, die an diesen Endpunkt gesendet werden, folgen dem allgemeinen Nachrichtenformat.
  
  Weitere Informationen zum Transformer für benutzerdefinierte Ereignisse finden Sie in der Dokumentation zu PagerDuty.
Klicken Sie auf die Schaltfläche Service hinzufügen oder Integration hinzufügen, um die neue Integration zu speichern.
Sie werden zur Seite "Integrationen" für Ihren Service umgeleitet.
Kopieren Sie den Integrationsschlüssel und die Integrations-URL für Ihre neue Integration, und bewahren Sie sie für die spätere Verwendung an einem sicheren Ort auf.
Beispiel für einen PagerDuty-Integrationsschlüssel und eine Integrations-URL (zum Zeitpunkt der Veröffentlichung dieses Dokuments):

Sie verfügen jetzt über den Integrationsschlüssel, der zum Erstellen eines PagerDuty-Abonnements in Notifications erforderlich ist.

PagerDuty-Abonnement erstellen

Um dieses Verfahren abzuschließen, benötigen Sie Zugriff auf Benachrichtigungen und Berechtigungen zum Erstellen von Themen und Abonnements. Siehe Benachrichtigungen sichern (IAM-Policys).

Wählen Sie auf der Listenseite Themen die Option Thema erstellen aus. Wenn Sie Hilfe bei der Suche nach der Listenseite benötigen, finden Sie weitere Informationen unter Themen auflisten.
Wählen Sie im Bereich Abonnement erstellen unter Protokoll die Option PagerDuty aus.
Das Feld URL wird mit einem Leerzeichen angezeigt, mit dem Sie den Integrationsschlüssel hinzufügen können.
- Protokoll: Wählen Sie PagerDuty aus.
- URL:
  Geben Sie den Integrationsschlüsselteil der URL für Ihr PagerDuty-Abonnement ein (oder kopieren Sie ihn, und fügen Sie ihn ein). Dieser Teil ist der PagerDuty-Endpunkt. (Die anderen Teile der URL sind hartcodiert.)
Klicken Sie auf Erstellen.

Das PagerDuty-Abonnement wurde erstellt. Sie bleibt im Status "Ausstehend", bis die Bestätigung eingeht.
Bestätigen Sie das neue PagerDuty-Abonnement:
1. Gehen Sie zu PagerDuty.
2. Greifen Sie auf den Vorfall mit dem Titel "Oracle Notification Service-Abonnementbestätigung" zu.
3. Wählen Sie den Link Bestätigungs-URL.
Beispiel für einen Bestätigungsvorfall (zum Zeitpunkt der Veröffentlichung dieses Dokuments):

Nachdem Sie ein bestätigtes Abonnement haben, das Ihren PagerDuty-Endpunkt referenziert, können Sie die Integration testen, indem Sie eine Nachricht direkt im übergeordneten Thema veröffentlichen.

PagerDuty-Abonnement testen (Direkte Veröffentlichung)

Um dieses Verfahren abzuschließen, benötigen Sie Zugriff auf Benachrichtigungen und Berechtigungen zum Veröffentlichen von Nachrichten. Siehe Benachrichtigungen sichern (IAM-Policys).

1. Suchen Sie auf der Listenseite Themen das Thema, mit dem Sie arbeiten möchten. Wenn Sie Hilfe bei der Suche nach der Listenseite oder dem Thema benötigen, finden Sie weitere Informationen unter Themen auflisten.
2. Wählen Sie im Menü Aktionen (drei Punkte) für das Thema die Option Nachricht veröffentlichen aus.
3. Geben Sie im Dialogfeld Nachricht veröffentlichen Werte für die folgenden Felder an: Geben Sie die Elemente ein, die für Ihren Integrationstyp erforderlich sind.
  
  Geben Sie unter Transformator für benutzerdefiniertes Ereignis eine Nachricht und einen Titel ein.
  
  Beispielmeldung: "Nicht optimale Auslastung ermittelt. Eine Anwendung oder ein Prozess belegt möglicherweise mehr CPU als gewöhnlich."
  
  Beispieltitel: "Nicht-optimaler Alarm"
  
  Geben Sie für Oracle Cloud Infrastructure Monitoring eine Nachricht ein, die einen JSON-Blob mit Schlüssel/Wert-Paaren für severity (Zeichenfolge, erforderlich) und mindestens eine der folgenden Zeichen enthält: title (Zeichenfolge), body (Zeichenfolge) und alarmMetaData (JSON-Blob oder -Array).
  
  Beispiel für JSON-Blob:
  { "title": "my test alarm", "body": "my test body", "severity": "warning", "alarmMetaData": { "key1": "value1", "key2": "value2" } }
  
  Der Wert severity ist beim Testen flexibel. Verwenden Sie für die Produktion einen von PagerDuty unterstützten Wert, wie critical, error, warning oder info.
4. Wählen Sie Veröffentlichen aus.
  Ein PagerDuty-Vorfall wird ausgelöst, der den Inhalt Ihrer Nachricht enthält.
  Beispiel für einen ausgelösten PagerDuty-Vorfall (zum Zeitpunkt der Veröffentlichung dieses Dokuments):
  Beispiel für den Inhalt eines ausgelösten PagerDuty-Vorfalls (zum Zeitpunkt der Veröffentlichung dieses Dokuments):
  Sie haben bestätigt, dass die direkte Veröffentlichung einer Nachricht einen PagerDuty-Vorfall auslöst. Verwenden Sie als Nächstes Ihr neues Abonnement, um PagerDuty-Vorfälle aus Alarmen, Ereignissen und Connectors auszulösen.
  Hinweis
  
  Informationen zum Prüfen der Endpunkt-URL oder anderer Details des Abonnements PagerDuty finden Sie unter Details eines Abonnements abrufen. Informationen zur Fehlerbehebung bei veröffentlichten Nachrichten finden Sie unter Nachricht nicht empfangen.
Verwenden Sie den Befehl oci ons message publish und die erforderlichen Parameter, um eine Nachricht in einem Thema zu veröffentlichen:
oci ons message publish --body <message_text> --topic-id <topic_OCID>
Eine vollständige Liste der Parameter und Werte für CLI-Befehle finden Sie in der Befehlszeilenreferenz für Notifications.

Führen Sie den Vorgang PublishMessage aus, um eine Nachricht in einem Thema zu veröffentlichen.

Beispielanforderung für einen PagerDuty-Endpunkt des Typs "Benutzerdefinierter Ereignistransformator":

POST /20181201/topics/<topic_OCID>/messages
Host: <topic API endpoint>
<authorization and other headers>
{
  "title": "Non-Optimal Alarm",
  "body": "Non-optimal utilization detected. An application or process may be consuming more CPU than usual."
}

PagerDuty-Vorfall auslösen

Lösen Sie einen Vorfall in PagerDuty aus einem Alarm-, Ereignis-, Connector- oder Ankündigungsabonnement mit einem Abonnement in Notifications aus.

Wenn Sie einen Alarm, eine Ereignisregel, einen Connector oder ein Ankündigungsabonnement erstellen, wählen Sie das Notifications-Thema aus, das das Abonnement PagerDuty enthält. Weitere Informationen zum Erstellen dieser Ressourcen finden Sie in der folgenden Dokumentation.

Hinweis

Informationen zum Prüfen der Endpunkt-URL oder anderer Details des Abonnements PagerDuty finden Sie unter Details eines Abonnements abrufen.