AUI Service Runbook¶
Overview¶
This is the runbook for productavailability Service covers below components. 1. Storing file in S3 Bucket 2. upload single product in file 3. Sending Batch to SQS
This documents (and references) the component documentation. Below are a set of scenarios that may happen in production along with diagnosis and resolution information.
Reference¶
Docuement |
Ref |
|---|---|
Jira Story (OSP productavailability service) |
|
Bitbucket(OSP productavailability service) |
https://bitbucket.org/morrisonsplc/aui-osp-productavailability-service/src/master/ |
Runtime Issue List¶
Issue |
component |
Description |
|---|---|---|
Request_validator |
if request does not have valid username it raises exception with status code 400 |
|
payload_validator |
payloadvalidationerror - when there is error while validation data field of request |
|
File_Format_validator |
when the request contain different file format then expected |
|
Add_product_sqs |
when the request does not have valid payload for sqs arguments raise exception |
|
ApplicationConfiguration |
ApplicationConfigurationException - application configuration missing |
|
ApplicationDependencies |
Exception - Exception while loading configs |
Runtime Issues¶
Issue 1¶
Scenario¶
if the request data does not have valid username for the request it raises a exception with status code 400
Error¶
Payloadvalidationerror
Symptoms¶
service will respond with response code 400 .
Corrective Action¶
call service with correct username
Issue 2¶
Scenario¶
if the request data does not have valid field data for the request it raises a exception with status code 400
Error¶
Payloadvalidationerror
Symptoms¶
service will respond with response code 400 .
Corrective Action¶
call service with valid field data
Issue 3¶
Scenario¶
if the request have different Media format then it raises exception and respond with status code 400
Error¶
Payloadvalidationerror
Symptoms¶
service will respond with response code 400 .
Corrective Action¶
upload correct file format like .csv or .xlsx
Issue 4¶
Scenario¶
while adding product in sqs it require a payload containing different information if it not satisfied the request it raise the exception
Error¶
Payloadvalidationerror
Symptoms¶
service will respond with response code 400 .
Corrective Action¶
call service with correct payload data field
Issue 5¶
Scenario¶
This happens when application configuration file is missing in the config service or when config service is not reachable.
Error¶
FlaskConfigurationFileNotFoundError raised when application configuration is missing in config service
Symptoms¶
service will respond with response code 400.
Corrective Action¶
make sure file the path to the file is correct
Issue 6¶
Scenario¶
This happens when there is an error while loading all the dependencies needed for the application to run.
Error¶
Exception raised when loading dependencies
Symptoms¶
service will respond with response code 400.
Corrective Action¶
config fields are present in the config file.