Slack¶

Služba zasílání zpráv může odesílat oznámení do kanálů Slacku.

Používejte Slack, když by se oznámení z LogMan.io měla zobrazovat v týmovém kanálu, například pro provozní upozornění, aktualizace incidentů nebo sledovací zprávy.

Předpoklady¶

Než začnete nastavovat Slack, ujistěte se, že:

přístup k pracovnímu prostoru Slack, kam budou odesílána oznámení, je dostupný
povolení k vytvoření nebo instalaci aplikace Slack v tomto pracovním prostoru je dostupné
aplikace Slack má požadované oprávnění tokenu bota
aplikace Slack je pozvána do cílového veřejného kanálu
server LogMan.io může komunikovat se Slackem přes HTTPS
je dostupné bezpečné místo pro uložení OAuth tokenu uživatele bota Slack

Požadovaná konfigurační pole¶

Pole	Popis
`token`	Přístupový token OAuth pro aplikaci Slack.
`channel`	Název kanálu Slack, kam služba posílá zprávy.

Ukázka konfigurace¶

Upravte soubor model.yaml pro konfiguraci služby asab-iris:

/Site/model.yaml

define:
  type: rc/model

services:
  asab-iris:
    instances:
      - node1
    asab:
      config:
        slack:
          token: "{{SLACK_TOKEN}}"
          channel: "logman-alerts"

secrets:
  SLACK_TOKEN: {}

Nastavení aplikace Slack¶

Otevřete Slack API Apps.
Klikněte na Vytvořit novou aplikaci.
Vyberte Od začátku.
Zadejte název aplikace, například LogMan.io Notifications.
Vyberte Slack workspace.
Klikněte na Vytvořit aplikaci.
Otevřete OAuth & oprávnění.
V sekci Rozsahy tokenu bota přidejte následující rozsahy:

Rozsah	Proč je potřeba
`chat:write`	Umožňuje aplikaci Slack odesílat upozorňovací zprávy do nakonfigurovaného kanálu.
`channels:read`	Umožňuje službě vyhledat ID kanálu podle názvu veřejného kanálu.
`files:write`	Umožňuje aplikaci Slack nahrávat přílohy upozornění, pokud upozornění obsahuje soubory.

Klikněte na Nainstalovat do pracovního prostoru.
Schvalte instalaci.
Zkopírujte OAuth token uživatele bota. Obvykle začíná na xoxb-.

Nastavení kanálu¶

Otevřete Slack.
Přejděte na kanál, kam by služba měla posílat oznámení.
Pozvěte aplikaci Slack do kanálu.
Použijte název kanálu v konfiguraci channel služby.

Nezahrnujte # do názvu kanálu. Například použijte logman-alerts, ne #logman-alerts.

Použít konfiguraci¶

Uložte Slack token do Vaultu nebo do úložiště tajemství nasazení používaného instalací LogMan.io.
Aktualizujte /Site/model.yaml.
Aplikujte model z Knihovny, nebo spusťte příkaz pro aplikaci nasazení používaný instalací.
Odešlete testovací Slack upozornění.

Ověřte konfiguraci¶

Konfigurace je připravena, když:

služba se spouští bez chyb konfigurace Slacku
aplikace Slack je nainstalována ve správném workspace
aplikace Slack je přítomna v nakonfigurovaném veřejném kanálu
testovací oznámení se zobrazí v nakonfigurovaném kanálu
protokoly služby neobsahují chyby Slack API

Šablony Slack¶

Šablony oznámení Slack musí být uloženy v adresáři /Templates/Slack/ v knihovně.

Tělo zprávy může používat šablonové parametry, takže jedna šablona může být znovu použita pro různá oznámení.