Close

Automatisch incidentmanagement met Jira en StatusPage

Headshot van Kev Zettler
Kev Zettler

Full stack web developer, DevOps

Leer hoe je automation-regels in Jira gebruikt om StatusPage automatisch te synchroniseren met Jira-issues.

Tijd

5 minuten lezen.

Publiek

Je bent een ervaren gebruiker van Jira Software en hebt een StatusPage-account.

Vereisten

Je hebt een actief Jira-project nodig met een aangepast taaktype 'Incident' en een aangepast veld 'Incident-ID'. Ga hier aan de slag met Jira.

Je hebt een StatusPage-account nodig waarbij API-toegang is ingeschakeld. Je hebt ook je API-sleutel en paginacode voor StatusPage nodig om de volgende automatiseringsregels te configureren. Bekijk de handleiding voor de StatusPage-API om je API-sleutels voor StatusPage te vinden. Ga hier aan de slag met StatusPage.

Stap 1. Automation toevoegen

Klik op de knop Automation toevoegen en selecteer vervolgens de optie Issue.

Klik op: 'Automation toevoegen', selecteer: 'Issue'

Zoek Issue aangemaakt en selecteer deze optie.

Nieuwe trigger. Triggers starten de uitvoering van een regel. Triggers kunnen luisteren naar events of worden gepland om te worden uitgevoerd.

Klik op de knop Opslaan om verder te gaan.

Issue aangemaakt. Regel wordt uitgevoerd wanneer er een issue wordt aangemaakt. Deze trigger hoeft niet te worden geconfigureerd.

Stap 2. Maak een nieuwe voorwaarde aan

Zoek de voorwaarde Issue-velden en selecteer deze.

Selecteer de voorwaarde 'Issuevelden' onder 'Nieuwe voorwaarde'. Hiermee wordt gecontroleerd of een issueveld aan bepaalde criteria voldoet.

Gebruik de voorwaarde Issue-velden om te controleren of het type issue een incident is en handel dienovereenkomstig. Configureer de voorwaarde Issue-velden zodat het veld Type issue gelijk is aan Incident. Klik op Opslaan om verder te gaan.

Gebruik de 'Issuevelden' om te controleren of het type issue een incident is en handel dienovereenkomstig. Configureer de voorwaarde 'Issuevelden' zodat het veld 'Type issue' gelijk is aan 'Incident'. Klik op 'Opslaan' om verder te gaan.

Stap 3. Verstuur een webaanvraag

Selecteer Webaanvraag verzenden. StatusPage wordt nu bijgewerkt.

Nieuwe actie. Selecteer 'Webaanvraag verzenden'

Om de actie Webaanvraag verzenden te configureren, heb je je API-sleutel en paginacode voor StatusPage nodig. Deze waarden zijn te vinden in de StatusPage-documentatie. Webaanvraag verzenden is een geavanceerde actie met gevoelige invoerwaarden. Later in deze handleiding wordt deze actie in aanvullende regels gereproduceerd. Daarbij wordt naar deze configuratie verwezen.

Voer in het veld Webhook-URL de URL van het eindpunt voor StatusPage-incidenten in:
https://api.StatusPage.io/v1/pages/your-page-code/incidents

Vervang de tijdelijke aanduiding van je paginacode door de StatusPage-paginacode. Voer in de twee koptekstvelden onder het kopje 'Kopteksten' Authorization:OAuth en je API-sleutel in.

Stel de HTTP-methode in op POST en stel de hoofdtekst van de Webhook in op Aangepaste gegevens.

Vergeet niet om het selectievakje Wachten op reactie in te schakelen, want je gebruikt de waarden van de reactie op de webaanvraag in extra componenten.

Het veld Aangepaste gegevens bevat code die een incident-payload definieert voor de StatusPage-API. Deze code gebruikt slimme waarden om de samenvatting van issues te extraheren en toe te voegen aan de payload. De volgende schermafbeelding toont de volledige configuratie van de actie Webaanvraag verzenden. Klik op Opslaan om verder te gaan.

Webaanvraag verzenden

Stap 4. Maak de actie 'Issue bewerken'

Zoek ten slotte de actie Issue bewerken en selecteer deze.

Nieuwe actie: 'Issue bewerken'

De actie Issue bewerken haalt de incident-ID uit de StatusPage-aanvraag en slaat deze op in een aangepast veld 'Incident-ID'. De 'Incident-ID' wordt geëxtraheerd met behulp van slimme waarden. De volgende schermafbeelding toont hoe je deze component Issue bewerken configureert.

Issue bewerken. Waarden instellen voor velden over de issue

De volgende schermafbeelding toont de definitieve samenvatting van deze regel.

De laatste samenvatting van de regel

Deze regel is nu klaar om te worden ingeschakeld. Voer een naam in voor deze regel en klik op de knop Inschakelen. Gegevens uit deze regel worden gebruikt om de volgende regels te maken.

StatusPage bijwerken wanneer er op een issue is gereageerd

Deze volgende regel wordt geactiveerd wanneer er een opmerking wordt achtergelaten op een issuetype 'Incident'. Er wordt een webaanvraag gedaan naar StatusPage die het bijbehorende incident bijwerkt met de content van de opmerking. De volgende afbeelding toont de samenvatting van de componenten voor deze regel.

StatusPage-opmerking over incident

De belangrijkste component die in deze regel moet worden bekeken, is de actie Webaanvraag verzenden. Deze actie wordt gekopieerd van de vorige regel, maar met enkele wijzigingen.

De Webhook-URL is toegevoegd met /{{issue.incident_id}}. Er worden slimme waarden gebruikt om het aangepaste veld 'Incident-ID' uit de issue te halen en door te geven aan StatusPage als doel van de webaanvraag.

De HTTP-methode is nu ingesteld op PATCH in plaats van op POST. Dit vertelt StatusPage om een bestaand incident bij te werken in plaats van een nieuw incident aan te maken.

Het aangepaste gegevensveld wordt gewijzigd om code met slimme waarden op te nemen om de commentaartekst uit het issue te extraheren en in de content van het incident te plaatsen.

StatusPage-opmerking over incident
Webaanvraag verzenden

StatusPagina-incident sluiten wanneer issues zijn overgezet

Deze laatste regel verbindt ze allemaal met elkaar. Deze regel vertelt StatusPage dat een incident is afgesloten zodra de overeenkomstige Jira-issue wordt verplaatst naar 'Gereed'. De volgende afbeelding toont de samenvatting van de regels.

StatusPage-opmerking over incident

De webaanvraag-component is opnieuw gekopieerd en aangepast op basis van de vorige regels.

Webaanvraag verzenden

Het veld Aangepaste gegevens is aangepast om de incidentstatus in te stellen op 'Opgelost'. Dit is de enige wijziging van de vorige commentaarregel.

Deze regels zijn nu klaar voor gebruik. Je kunt deze regels testen door Incidenttype-issues aan te maken en triggerinteracties uit te voeren. Je kunt het gedrag van de regels controleren in het auditlog voor automation, dat voorziet in het loggen en informatie geeft over het gedrag van de regels. De automation-regels die in deze handleiding worden getoond, zijn goede voorbeelden van geavanceerde gebruiksregels voor de API voor webaanvragen.

Bekijk honderden andere voorbeelden in onze bibliotheek met automation-sjablonen.

Kev Zettler
Kev Zettler

Kev is een toonaangevende full stack webontwikkelaar en serieondernemer met jarenlange ervaring in het ontwikkelen van producten en samenstellen van teams met agile methodieken. Hij is een enthousiaste bijdrager, auteur en docent op het gebied van opkomende opensoucetechnologieën, zoals DevOps, cryptovaluta en VR/AR. In zijn vrije tijd doet hij graag mee aan Indie Game Development Jams.


Deel dit artikel
Volgend onderwerp

Aanbevolen artikelen

Bookmark deze resources voor meer informatie over soorten DevOps-teams of voor voortdurende updates over DevOps bij Atlassian.

Toelichting DevOps

DevOps-community

Toelichting DevOps

DevOps-leertraject

Afbeelding van kaart

Gratis aan de slag

Meld je aan voor onze DevOps-nieuwsbrief

Thank you for signing up