Overzicht aangepaste integraties

Stel dat u uw Uptrends-account koppelt aan het operationsmanagementsysteem dat uw organisatie gebruikt. Door alertdata van Uptrends in uw bestaande incidentmanagementprocessen in te voeren, creëert u een naadloze integratie van Uptrends' externe monitoring in de dagelijkse procedures die uw teams al gebruiken.

Als onze voorgedefinieerde integratietypes uw DevOps-software niet bevatten, kunt u de aangepaste-integratieoptie gebruiken om de integratie zelf te bouwen. Het belangrijkste bij het bouwen van een succesvolle integratie is dat u weet wat voor soort bericht het andere systeem verwacht. In de API-documentatie van de third party vindt u welke URL u moet gebruiken en welke inhoud u op die URL moet posten. Deze zogenoemde webhook-gebaseerde integraties laten Uptrends koppelen met het andere systeem door directe calls toe te staan. Uptrends kan een call naar de integratie initiëren zodra er een relevante alert verschijnt.

Dit artikel behandelt het configureren van een aangepaste integratie, het aanpassen van berichtinhoud en berichttypes, het testen van uw configuratie en het toevoegen van de integratie aan een alertdefinitie.

Een aangepaste integratie configureren

Volg deze stappen om een aangepaste integratie te configureren:

1. Maak een aangepaste integratie met een van de onderstaande opties:

• Alerting > Integraties +.
• Configureren > Alert kanalen +.
• Opslaan als — open een bestaande aangepaste integratie en klik op Opslaan als om deze te dupliceren. Met de kopie kunt u bestaande configuraties hergebruiken in plaats van helemaal opnieuw te beginnen.

Opmerking

U kunt ingebouwde integraties (e-mail, SMS, telefoon) of third-partyintegraties waarvoor een specifieke configuratiestroom vereist is, zoals Slack en PagerDuty, niet dupliceren.

2. Selecteer Uptrends-integratie. Klik vervolgens op Kiezen....

3. Geef een integratienaam op.

4. Specificeer de API-URL waarmee u verbinding wilt maken.

5. (Optioneel) Pas uw integratie aan in het tabblad Aanpassingen.

6. Klik op Opslaan om de wijzigingen te bevestigen.

De API-URL specificeren

De ApiUrl is een voorgedefinieerde variabele die de doel-URL voor de HTTP-call bevat.

Er zijn twee opties om de API-URL te specificeren:

• Waarde hier opgeven — stelt de ApiUrl in op integratieniveau. Elke alertdefinitie en elk escalatieniveau dat deze integratie gebruikt, krijgt dezelfde URL. U kunt de Uptrends Vault gebruiken om de API-URL op te slaan. Zie Uptrends Vault voor meer informatie

• Waarde opgeven in het escalatieniveau — stelt de ApiUrl in wanneer u de integratie koppelt aan een escalatieniveau in een alertdefinitie. Elk escalatieniveau heeft een eigen URL-veld, zodat één integratie naar verschillende eindpunten in verschillende alertdefinities kan verwijzen.

Integraties aanpassen

Definieer in het tabblad Aanpassingen wat Uptrends verstuurt wanneer een alert optreedt.

Uptrends biedt een voorgedefinieerde sjabloon die de beschikbare informatie van een alert bevat. Deze sjabloon is een aanpasbare, JSON-geformatteerde berichtinhoud die u vindt in Request body.

{
  "alert": {
    "alertGuid": "{{@alert.alertGuid}}",
    "type": "{{@alert.type}}",
    "description": "{{@JsonEncode({{@alert.description}})}}",
    "failureMessage": "{{@alert.failureMessage}}",
    ...
  }
}

De body bevat de volledige reeks alertingvariabelen, bijvoorbeeld {{@alert.alertGuid}} of {{@alert.description}}. Uptrends vervangt deze placeholders door live-alertdata wanneer het bericht wordt verstuurd. Bewerk de sjabloon om velden te verwijderen, uw eigen data toe te voegen of het formaat te wijzigen.

Zie voor meer informatie:

• De juiste berichtinhoud bouwen — berichtinhoud aanpassen en variabelen gebruiken
• Berichtopmaak — uitgaande berichten correct opmaken en fouten in de ontvangende applicatie voorkomen
• Systeemvariabelen voor alerting — volledige lijst met beschikbare variabelen

Berichttypes

Er zijn verschillende soorten alertingberichten. Uptrends maakt onderscheid tussen Fout-berichten, Herinnering-berichten en OK-berichten. Standaard worden al deze berichttypes met dezelfde configuratie gemaakt. Wanneer u echter een aangepaste integratie configureert of een bestaande integratie aanpast, kunt u verschillende sets acties maken voor elk afzonderlijk berichttype. Zie Berichttypes voor meer informatie.

Aangepaste integratie testen

Nadat u een aangepaste integratie heeft gemaakt of gewijzigd, test u deze voordat u deze in production gebruikt. U kunt een testbericht vanuit de integratie-editor versturen zonder de integratie aan een alertdefinitie te koppelen. Zie Uw aangepaste integratie testen voor meer informatie.

Een integratie toevoegen aan de alertdefinitie

Een integratiedefinitie op zichzelf doet niets. U moet deze koppelen aan een of meer escalatieniveaus van alertdefinities om alerts via de integratie te ontvangen.

Om een integratiedefinitie aan een escalatieniveau te koppelen:

1. Ga naar de pagina met alertdefinities via een van de onderstaande opties:

• Alerting > Alertdefinities
• Configureren > Alert escalaties

2. Open de alertdefinitie die u wilt gebruiken.
3. Klik op een tabblad Escalatieniveau.
4. Schakel de selectievakjes voor uw aangepaste-integratiedefinities in.
5. Klik op Opslaan om de wijzigingen te bevestigen.

Uw integratie is nu gekoppeld aan de alertdefinitie. Wanneer een monitor die aan deze alertdefinitie is toegewezen een alert triggert en aan de voorwaarden voor het escalatieniveau is voldaan, verstuurt Uptrends het geconfigureerde bericht via de integratie.

Als u vragen heeft, kunt u contact opnemen met ons supportteam.