ansible/awx

Improve Slack Notification Error Handling

Open

#1,048 opened on Jan 24, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (13,071 stars) (3,333 forks)batch import
Hacktoberfestcomponent:apicomponent:uigood first issuetype:enhancement

Description

ISSUE TYPE
  • Enhancement
COMPONENT NAME
  • API
  • UI
SUMMARY

Currently we only surface errors when sending slack notification if a Python exception occurs. We could do better if we read the event stream after our rtm_send_message call to see if there were any error events waiting.

A common error is when the bot has not been invited to a channel that we are attempting to send the notification to. This can be caught in the message stream, but does not throw an exception.

ADDITIONAL INFORMATION

https://github.com/ansible/awx/blob/devel/awx/main/notifications/slack_backend.py#L49

Contributor guide

Tech stack
python
Domain
backend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonSlack RTM APIAWX notification system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the Slack RTM API documentation and the existing code in awx/main/notifications/slack backend.py, specifically the rtm send message method. Investigate how to read the event stream after sending a message to catch errors like 'not in channel'. Implement error handling that logs or surfaces these errors appropriately.