Stel dat u uw Uptrends-account koppelt aan het operationsmanagementsysteem dat uw organisatie gebruikt. Door alertdata van Uptrends in te voeren in uw bestaande incidentmanagementprocessen, 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 “hook” (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.
De artikelen in deze sectie beschrijven het bouwen van de juiste berichtinhoud (met inbegrip van de juiste opmaak), het creëren van verschillende regels voor verschillende berichttypes en hoe u uw aangepaste integratie kunt testen als u klaar bent met de configuratie.
Een aangepaste integratie configureren
Volg deze stappen om aangepaste integraties te gaan gebruiken:
- Voeg een aangepaste-integratiesjabloon toe aan uw account. Om dit te doen klikt u op de knop naast Integraties in het menu Alerts in de Uptrends-applicatie.
- Er verschijnt een pop-upvenster waarin u een integratietype kunt kiezen. Voor een aanpasbare integratie scrollt u naar beneden in de lijst en selecteert Uptrends-integratie.
- Specificeer de URL van de API waarmee u wilt verbinden, gebruik hierbij de variabele ApiUrl onder Voorgedefinieerde variabelen. Welke URL dit moet zijn vindt u in de documentatie of gebruikersinterface van het externe systeem waarmee u Uptrends wilt verbinden.
- Geef de integratie een passende naam in het veld Integratienaam.
- Pas zo nodig uw integratie aan in de tab Aanpassingen. De andere hoofdstukken in dit artikel begeleiden u door het proces.
- Als u klaar bent met de configuratie klikt u op om uw instellingen te bewaren. U kunt desgewenst terugkeren naar de integratie om uw aanpassingen te voltooien.
De juiste berichtinhoud bouwen
Deze nieuwe integratie is een voorgedefinieerde sjabloon die een (aanpasbare) JSON-geformatteerde berichtinhoud bevat met de volledige reeks beschikbare alertingvariabelen. Dit standaard berichtformaat stelt u in staat om alle beschikbare informatie bij elke alert te verwerken, maar u kunt ook gegevens verwijderen die u niet nodig heeft, uw eigen gegevens toevoegen of het berichtformaat wijzigen. U vindt de voorgedefinieerde berichtinhoud in de tab Aanpassingen, samen met andere opties om uw integratie verder aan te passen.
- Om te begrijpen hoe u begint met het opzetten van de gewenste berichtinhoud en hoe u variabelen gebruikt, raden we u aan eerst ons artikel over het bouwen van de juiste berichtinhoud te lezen.
- Een compleet overzicht van beschikbare alertingvariabelen vindt u in onze lijst met systeemvariabelen voor alerting.
- Vergeet niet dat uw uitgaande bericht correct moet zijn opgemaakt. Zorg ervoor dat u onze handleiding voor berichtopmaak leest om onnodige fouten in uw externe applicatie te voorkomen.
Berichttypes
Er zijn verschillende soorten alertberichten. Uptrends maakt onderscheid tussen Foutberichten, Herinneringen en Ok-berichten. Standaard worden al deze berichttypes gemaakt met dezelfde instellingen. Wanneer u echter een aangepaste integratie configureert of een bestaande integratie aanpast, kunt u verschillende sets acties maken voor elk afzonderlijk berichttype. Bekijk ons artikel over berichttypes voor meer informatie.
Uw aangepaste integratie testen
Nadat u een aangepaste integratie heeft gemaakt of gewijzigd, is het handig om deze eerst te testen voordat u deze in production gebruikt. Ons artikel over het testen van uw aangepaste integratie beschrijft op welke manieren u de nieuw geconfigureerde integratie kunt testen.
De integratie toevoegen aan een alertdefinitie in Uptrends
Een integratiedefinitie op zichzelf doet niets. U moet deze koppelen aan een of meer escalatieniveaus om alerts te ontvangen via de integratie. Om een integratiedefinitie aan een escalatieniveau te koppelen doet u het volgende:
- Navigeer naar de betreffende alertdefinitie in Uptrends (Alerts > Alertdefinities).
- Klik om een bestaande definitie te openen of creëer een nieuwe met de knop rechts bovenaan.
- Klik op een tab Escalatieniveau.
- Selecteer de selectievakjes voor uw aanpasbare-integratiedefinities in het gedeelte Alerts versturen door integraties.
- Klik op als u klaar bent.
Dat is alles! U heeft met succes een aangepaste integratie geconfigureerd.
Zoals gewoonlijk kunt u als u vragen heeft contact opnemen met ons supportteam.