Merge pull request #14 from GabrielSalla/isolate-slack-plugin

Isolate Slack plugin

Author: GabrielSalla

configs.yaml

@@ -61,9 +61,6 @@ time_zone: America/Sao_Paulo
 controller_process_schedule: "* * * * *"
 # How many monitors can be processed at the same time by the Controller
 controller_concurrency: 5
-# Enable or disable the Slack websocket
-# The websocket is used to receive the mentions and button presses from notification messages
-slack_websocket_enabled: true
 
 # Executor settings
 # How many tasks can be executed at the same time by each Executor

docs/monitor.md

@@ -43,7 +43,6 @@ from monitor_utils import (
     IssueOptions,
     MonitorOptions,
     PriorityLevels,
-    SlackNotification,
 )
 ```
 

docs/plugin_slack.md

@@ -1,6 +1,12 @@
 # Slack Plugin
 The Slack plugin offers an interface to interact with Sentinela through Slack. It allows users to receive notifications from Sentinela in a Slack channel while also providing useful commands from notification buttons or Slack messages mentioning the Sentinela bot.
 
+## Environment variables
+The following environment variables are used by the Slack plugin:
+- `SLACK_TOKEN`: Used to send messages to Slack. Example: `xoxb-1234567890-1234567890123-12345678901234567890abcdef`
+- `SLACK_WEBSOCKET_ENABLED`: Used to enable the websocket to receive events from Slack. Possible values are `true` or `false`.
+- `SLACK_APP_TOKEN` Used to start the websocket, to receive the events from interactions with the Sentinela Slack app. Example: `xapp-1234567890-1234567890123-12345678901234567890abcdef`
+
 ## Slack commands
 Sentinela provides two main ways to interact through Slack:
 1. **Buttons** in notifications sent to a Slack channel.

docs/usage.md

@@ -9,10 +9,12 @@ THe monitors path is also defined in the `configs.yaml` file. By default, it's s
 For the secrets, the application expects them to be set as environment variables.
 - `DATABASE_APPLICATION`: The database DSN that will be used to connect to the application database. This database will not be accessible through the databases interface for the monitors.
 - Every variable that starts with `DATABASE`, besides the application database, will have a connection pool instantiated, that can be used in the monitors to query data from them.
-- `SLACK_TOKEN` and `SLACK_APP_TOKEN` will be used as the token to send messages to Slack and to start the websocket, to receive the events from interactions with the Sentinela Slack app.
 - `AWS_ENDPOINT_URL`: The AWS endpoint to be used for local testing, without the need of a real SQS queue. When using the `motoserver` container as an AWS mock, it should be `http://motoserver:5000`. Don't set this environment variable when using a real SQS queue.
 - `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN`: The service credentials to access the AWS SQS queue.
 
+> [!IMPORTANT]
+> Check the documentation for the plugins that are being used to see if they have environment variables of their own.
+
 ## Development execution
 Development execution should be used when developing or testing the platform features. It's not intended to be used to develop monitors as it might set variables that might interfere with the monitors execution.
 

resources/kubernetes_template/config_map.yaml

@@ -63,9 +63,6 @@ data:
     controller_process_schedule: "* * * * *"
     # How many monitors can be processed at the same time by the Controller
     controller_concurrency: 5
-    # Enable or disable the Slack websocket
-    # The websocket is used to receive the mentions and button presses from notification messages
-    slack_websocket_enabled: true
 
     # Executor settings
     # How many tasks can be executed at the same time by each Executor

resources/kubernetes_template/controller.yaml

@@ -28,6 +28,8 @@ spec:
           value: C07NCL94SDT
         - name: SAMPLE_SLACK_MENTION
           value: U07NFGGMB98
+        - name: SLACK_WEBSOCKET_ENABLED
+          value: "true"
         - name: DATABASE_APPLICATION
           valueFrom:
             secretKeyRef:

resources/kubernetes_template/executor.yaml

@@ -28,6 +28,8 @@ spec:
           value: C07NCL94SDT
         - name: SAMPLE_SLACK_MENTION
           value: U07NFGGMB98
+        - name: SLACK_WEBSOCKET_ENABLED
+          value: "true"
         - name: DATABASE_APPLICATION
           valueFrom:
             secretKeyRef:

src/components/controller/controller.py

@@ -169,5 +169,4 @@ async def run():
             sleep_time = time_until_next_trigger(controller_process_schedule)
             await app.sleep(sleep_time)
 
-    # Wait for Slack websocket and all tasks to finish
     _logger.info("Finishing")

src/configs/configs.py

@@ -28,7 +28,6 @@ class Configs:
 
     controller_process_schedule: str
     controller_concurrency: int
-    slack_websocket_enabled: bool
 
     executor_concurrency: int
     executor_sleep: int

src/plugins/slack/notifications/slack_notification.py

@@ -1,5 +1,6 @@
 import json
 import logging
+import os
 from dataclasses import dataclass
 from functools import partial
 from typing import Any, Coroutine
@@ -163,7 +164,7 @@ async def _build_notification_buttons(
     """Build the buttons that will be shown in the notification message"""
     buttons: list[slack.MessageButton] = []
 
-    if not configs.slack_websocket_enabled:
+    if os.environ.get("SLACK_WEBSOCKET_ENABLED", "false") == "false":
         return buttons
 
     if alert.status == AlertStatus.solved: