Skip to content

Script to ping our 3 main LibraryH3lp services (web, clavardez, sms) and if any of those queues are closed during standard Ask opening Hours for more than 10 minutes then this script will send an SMS to the Scholars-Portal Ask coordinator

Notifications You must be signed in to change notification settings

scholarsportal/sp_ask_service_downtime_sms_alert_script

Repository files navigation

PyPI PyPI PyPI TravisCI


SP ASK Service SMS Alert script

Script to ping our 3 main LibraryH3lp services (web, clavardez, sms) and if any of those queues are closed during standard Ask opening Hours for more than 10 minutes then this script will send an SMS to the Scholars-Portal Ask coordinator
If the service is close and one of the queue is still open due that an operator had stayed connected then an SMS notification will be sent to the SP Ask coordinator

Screenshots

This is a mockup, it will only send if one of the services has been down for at least 10 minutes

Installation

SP ASK Service SMS Alert is not a package but a script and can run by typing this in the terminal:

## using pip 
pip install -r test-requirements.txt
python sp_ask_service_availability_alert.py

## or using poetry
poetry install 
poetry run python sp_ask_service_availability_alert.py

## if Using the Makefile
make setup 
# then.. 
make run

In addition it is useful to execute it from crontab */10 * * * * python sp_ask_service_availability_alert.py

Requirement

  1. This script requires a TWILIO account credentials to send SMS
  2. This script requires a .env file

# .env
ACCOUNT_SID="Twillio account sid"
AUTH_TOKEN="twillio auth token"
FROM="phone number"
TO="phone number"
ENVIRONMENT="STAGING or PRODUCTION"

Docker

docker-compose run smsapp
# to stop
## docker ps -a -q  --filter ancestor=test_smsapp


----------- coverage: platform linux, python 3.7.7-final-0 -----------
Name                                   Stmts   Miss  Cover
----------------------------------------------------------
log_setup.py                              28      0   100%
sp_ask_service_availability_alert.py     163     66    60%
tests/__init__.py                          0      0   100%
tests/test_sp_ask_presence_alert.py      104      0   100%
----------------------------------------------------------
TOTAL                                    295     66    78%
Coverage HTML written to dir coverage-output/coverage/html
Coverage XML written to file coverage-output/coverage/cov_odesi_coverage.xml


Results (38.78s):
      13 passed

Todo

  1. Replace SMS with email to ASK SP inbox
  2. For tests find a way to use Staging
  3. Move the logic to create a Mobile app

About

Script to ping our 3 main LibraryH3lp services (web, clavardez, sms) and if any of those queues are closed during standard Ask opening Hours for more than 10 minutes then this script will send an SMS to the Scholars-Portal Ask coordinator

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages