Slack-integration

Anslut din egenvärdade Status200 till Slack. Du skapar en Slack-app från manifestet som din server genererar, ger Status200 appens inloggningsuppgifter och ansluter varje projekt till en arbetsyta. Sedan publicerar Status200 incidenter, larm och planerat underhåll i dina kanaler, och ditt team hanterar dem direkt i Slack.

Den här sidan är till för den som driver Status200-servern. När Slack är anslutet ställs aviseringsregler in per projekt: se Slack.

Så fungerar det#

Slack-appen är din egen: den är installerad i din arbetsyta och pratar bara med din server. Trafiken går åt båda hållen, och varje riktning behöver sin egen nätverksåtkomst.

• Utgående: Status200 anropar Slacks Web API för att publicera meddelanden, skapa kanaler och ladda upp bilder.
• Inkommande: Slack anropar fyra rutter på din server för händelser, klick på knappar, menyer och snedstreckskommandon. Varje begäran är signerad med appens signing secret. Status200 avvisar en begäran vars signatur inte stämmer eller vars tidsstämpel är mer än fem minuter gammal.

Innan du börjar#

• En Slack-arbetsyta där du kan skapa och installera appar.
• Ett offentligt HTTPS-värdnamn för Status200 som Slack kan nå. Se Nätverksåtkomst.
• Åtkomst till serverns konfiguration: config.env för Docker Compose, eller dina Helm-values för Kubernetes.
• För att ansluta ett projekt: rollen Project Owner, Project Admin eller Project Member i det.

Konfigurera Slack-appen#

1. Ange den offentliga URL:en#

   Status200 bygger appmanifestet och varje callback-URL från HOST och HTTP_PROTOCOL. Ställ in dem på värdnamnet som Slack kommer att anropa, över HTTPS:

   Docker ComposeKubernetes

   Docker Compose

   config.envBash

   HOST=status200.example.com
   HTTP_PROTOCOL=https

   Kubernetes

   values.yamlYAML

   host: status200.example.com
   httpProtocol: https

   De här värdena genererar bara URL:er. De skapar inga DNS-poster, certifikat eller brandväggsregler.

2. Kopiera appmanifestet#

   Öppna Projektinställningar > Arbetsyta > Slack. Så länge Slack inte är konfigurerat på servern visar sidan Integrating Slack with your Status200 Project med manifestet som genererats för ditt värdnamn. Det serveras också på https://status200.example.com/api/slack/app-manifest.

   Kontrollera att varje URL i manifestet börjar med ditt offentliga värdnamn. Om inte, rätta först HOST och HTTP_PROTOCOL och tillämpa ändringen.

3. Skapa Slack-appen#

   Skapa en ny app från ett manifest på api.slack.com/apps, välj din arbetsyta och klistra in manifestet. Använd alltid manifestet som din egen server genererar, så att dess URL:er stämmer med ditt värdnamn.

4. Kopiera appens inloggningsuppgifter#

   Kopiera Client ID, Client Secret och Signing Secret på appens sida Basic Information under App Credentials.

5. Lägg till inloggningsuppgifterna i Status200#

   Docker ComposeKubernetes

   Docker Compose

   config.envBash

   SLACK_APP_CLIENT_ID=YOUR_SLACK_APP_CLIENT_ID
   SLACK_APP_CLIENT_SECRET=YOUR_SLACK_APP_CLIENT_SECRET
   SLACK_APP_SIGNING_SECRET=YOUR_SLACK_APP_SIGNING_SECRET

   Kubernetes

   values.yamlYAML

   slackApp:
     clientId: "YOUR_SLACK_APP_CLIENT_ID"
     clientSecret: "YOUR_SLACK_APP_CLIENT_SECRET"
     signingSecret: "YOUR_SLACK_APP_SIGNING_SECRET"

   För att hålla värdena i en Kubernetes-Secret som du själv hanterar anger du i stället slackApp.existingSecret: dess name och nycklarna clientIdKey, clientSecretKey och signingSecretKey.

6. Tillämpa konfigurationen#

   Docker ComposeKubernetes

   Docker Compose

   Bash

   npm run start

   Det här återskapar containrarna med den nya config.env. docker compose restart läser inte in den igen.

   Kubernetes

   Bash

   helm upgrade my-oneuptime oneuptime/status200 -f values.yaml

   När Status200 är igång igen visar Projektinställningar > Arbetsyta > Slack en knapp Connect with Slack i stället för manifestet.

7. Verifiera begärande-URL:en för händelser#

   Verifiera begärande-URL:en under Event Subscriptions i Slack-appen. Status200 svarar på Slacks challenge först när signing secret är angiven, så försök igen om det misslyckades medan du skapade appen.

8. Anslut projektet#

   Välj Connect with Slack under Projektinställningar > Arbetsyta > Slack och tillåt appen i Slack. Slack skickar tillbaka dig till samma sida, som nu visar din arbetsyta.

9. Anslut ditt eget Slack-konto#

   Knappar, formulär och kommandon agerar som den Status200-användare som är kopplad till Slack-kontot som använder dem. Varje person öppnar Användarinställningar > Arbetsyta > Slack och väljer Connect my account with Slack. Den som inte har anslutit ett konto får där de tryckte ett svar med knappen Connect Slack account, som ansluter det i ett steg.

Miljövariabler#

Vad appen kan göra#

Manifestet konfigurerar de här funktionerna. Var och en når din server via den angivna rutten och fungerar därför bara när Slack kan nå den rutten.

Bilder i meddelanden#

Beskrivningar av incidenter och larm kan innehålla skärmbilder, till exempel från en syntetisk monitor (se Visa en skärmbild). Status200 visar dem i Slack-meddelanden genom att ladda upp var och en till din arbetsyta som en privat fil, vilket kräver bot-scopet files:write. Det genererade manifestet innehåller det.

Om du skapade din Slack-app från ett äldre manifest lägger du till files:write under OAuth & Permissions > Bot Token Scopes (eller uppdaterar appen från det aktuella manifestet). Välj sedan Connect with Slack igen under Projektinställningar > Arbetsyta > Slack, så att det nya scopet beviljas. Fram till dess visas varje skärmbild som sin alternativa text.

Jouranvändargrupper#

Att hålla ett schemas användargrupp i Slack lika med dem som har jour (se Jouranvändargrupper) kräver bot-scopen usergroups:read och usergroups:write. Det genererade manifestet innehåller dem.

Om du skapade din Slack-app från ett äldre manifest lägger du till usergroups:read och usergroups:write under OAuth & Permissions > Bot Token Scopes (eller uppdaterar appen från det aktuella manifestet). Välj sedan Connect with Slack igen under Projektinställningar > Arbetsyta > Slack, så att de nya scopen beviljas. Fram till dess säger schemats kort att Status200s Slack-app inte får ändra användargrupper än.

Appar skapade från ett äldre manifest#

En Slack-app som skapats från ett tidigare Status200-manifest registrerar /incident och /maintenance som egna kommandon, som kan krocka med kommandon med samma namn i andra appar. De fungerar fortfarande och öppnar samma formulär som /status200 incident och /status200 maintenance. För att ersätta dem med /status200 uppdaterar du appen från manifestet som din server genererar: på api.slack.com/apps öppnar du appens App Manifest, klistrar in manifestet och sparar.

En app som skapades före /status200 page behöver samma uppdatering: tills den har fått den kan /status200 page inte känna igen vem du nämner med @, och öppnar ett formulär där du väljer dem i stället för att larma dem direkt. Välj sedan Connect with Slack igen under Projektinställningar > Arbetsyta > Slack, så att scopet users:read.email som manifestet lägger till beviljas: med det hittas en person vars Slack-konto inte är anslutet till Status200 via sin e-postadress.

En app som skapades före fliken Home behöver samma uppdatering: tills den har den visar Slack ingen flik Home för appen, och appen publicerar ingen hälsning i en kanal den läggs till i. Uppdateringen slår på fliken och prenumererar appen på händelserna app_home_opened och member_joined_channel. Den lägger inte till något scope, så inget behöver anslutas igen.

Nätverksåtkomst för egenvärdade installationer#

Trafikriktning och slutpunkter#

De utgående domänerna beskriver Status200s Slack-integration, inte en fullständig tillåtelselista för Slack-klienter eller varje Slack-funktion. En Slack-incoming webhook drivs av Slack: Status200 skickar till den, så den är ingen inkommande slutpunkt på din server. Se Slacks guide för incoming webhooks.

Vidarebefordra de här callbacks till Status200 via dess ingress:

OAuth är en omdirigering i webbläsaren följd av ett tokenutbyte på servern. Manifestet registrerar /api/slack/auth som prefix för omdirigerings-URL:en, och Status200 lägger till projekt- och användarsökvägarna när den startar auktoriseringen. Enbart åtkomst från webbläsaren låter inte Slack leverera händelser eller klick på knappar.

Privata installationer och säkerhet för callbacks#

Använd offentlig DNS och en gateway med ett offentligt betrott HTTPS-certifikat, en fullständig certifikatkedja och en privat rutt till din Status200-ingress. Tillåt inkommande TCP 443 till gatewayen och vidarebefordra bara de fyra callback-rutterna ovan. En privat ClusterIP, ett internt DNS-namn eller en anställds VPN-anslutning kan Slack inte nå. Med delad DNS kan dashboarden och OAuth-rutterna förbli privata under samma värdnamn.

Generera om manifestet och uppdatera Slack-appen efter ett byte av värdnamn.

Bevara genom gatewayen:

• metoden, sökvägen, frågesträngen och den ursprungliga bodyn;
• Content-Type, X-Slack-Signature och X-Slack-Request-Timestamp;
• den offentliga värden och HTTPS-schemat, via betrodda proxyhuvuden.

Undanta callback-rutterna från webbläsar-SSO, CAPTCHA och proxyns inloggningssidor, och behåll Status200s kontroller av signing secret och tidsstämpel. Håll serverns klocka synkroniserad: en begäran som avviker mer än fem minuter avvisas. Slack dokumenterar verifiering av begärandens signatur; en kontroll av käll-IP ersätter den inte.

Kontrollera åtkomsten och förstå begränsningarna#

Slack förväntar sig snabba kvitteringar, bland annat ett svar inom tre sekunder för interaktioner. En GET från webbläsaren eller ett lyckat utgående meddelande verifierar inte de här POST-callbacks.

Inställningarna för åtkomst till privata nätverk styr utgående begäranden till privata mål. De gör inte callbacks nåbara för Slack.

Felsökning#

Anslutningen slutfördes inte#

När Slack skickar tillbaka dig och anslutningen inte gjordes visar Slack-sidan du började från (Projektinställningar > Arbetsyta > Slack, eller dina egna Användarinställningar > Arbetsyta > Slack om du anslöt ditt konto) Slack anslöts inte, med en mening på ditt språk som säger varför. Resten av sidan laddas som vanligt, så du kan ansluta igen direkt där. Den visar aldrig vad Slack själv svarade: det står i Status200-serverns logg, tillsammans med orsaken.

Andra problem#

Nästa steg#