Edit Order Notification Runbook

Overview

This is the runbook for the storepick edit order notification work. This documents (and references) the component documentation. Below are a set of scenarios that may happen in production along with diagnosis and resolution information.

References

Document

Ref

Business Analysis Pages

Business Analysis.

Architecture Document

Solution Architecture.

Low Level Design

Low Level Design.

Edit Order Notification Exceptions

Error Codes

Error Code

Exception Name

Detail

Solution

150

ConfigurationException

A server error occurred when loading configuration

Check the config (see: Configuration (from config service)) is as required, and the environment variable provided is correct (in production environment: prd) in the ECS task Container Overrides, see: AWS ECS Task

151

GoogleCredentialError

The google credentials for big query were missing or invalid

Check the google credentials in the SSM service are as expected, see: SSM Key

152

NotExecutedError

This object has not been correctly used. You need to execute the object before using getters

Check that the config (see: Configuration (from config service)) and SSM (see: SSM Key) are set up and as expected, otherwise refer to 3rd line support

153

ConfigTypeError

The config returned from the config service was not of type dictionary

Check the config (see: Configuration (from config service)) is as required, and the environment variable provided is correct (in production environment: prd) in the ECS task Container Overrides, see: AWS ECS Task

154

EnvironmentVariableDidNotMatchRegexError

The env passed to the application did not match the expected regex

Check the environment variable provided is correct (in production environment: prd) in the ECS task Container Overrides, see: AWS ECS Task

155

ReportNotificationStatusError

The parameters passed to the report notification status were not the expected type or format

Refer to 3rd line support

160

(Generic Exception)

(Specific to the exception raised)

View the logs on cloudwatch and investigate the issue, cloudwatch logs groups can be found here: AWS Cloudwatch Group

170

BigQueryError

The query provided to big query caused an error view logs for more details

Check the TABLE and DATASET values in the config match the correct big query table and environment, see: Big Query Cutoff Time Tomorrow View and Configuration (from config service)

171

BigQueryNoItemsFoundError

The query provided to big query did not return any items

Check the TABLE and DATASET values in the config match the correct big query table and environment, and that the view is not empty, see: Big Query Cutoff Time Tomorrow View and Configuration (from config service)

174

BigQueryTableNotFoundError

The table name provided to big query caused an error and the table could not be returned

Check the REPORT_TABLE value in the config matches to the correct Edit_Order_Notification_Report table in big query, see: Big Query Report and Configuration (from config service)

175

BigQueryRowsNotSentError

The rows provided to big query caused an error and were not added to the table

Refer to 3rd line support

176

MetricClassNotFoundException

Metric class was not found, certain functions require the metric to be added first

Refer to 3rd line support, the MetricMonitoring class may have been used incorrectly.

177

MetricFormatException

The format or type entered for a metric function was invalid

Refer to 3rd line support, the MetricMonitoring class may have been used incorrectly.

178

MetricInvalidLoggerException

A valid logger was not specified for metric monitoring

Check the config (see: Configuration (from config service)) has the required monitoring format. Otherwise refer to 3rd line support

1500 - 1514, 1901

MoriException

A general exception was raised calling the Morrisons API

Any issues with these error codes are related to the Morrisons Customer API and Marketing API. View the logs on cloudwatch for further details, cloudwatch logs groups can be found here: AWS Cloudwatch Group

1512 - 1514

MoriSSMException

Invalid or missing SSM config

Check the SSM service config is as expected, see: SSM Key, otherwise refer to 3rd line support

1501

MoriConfigurationException

Invalid configuration passed to Morrisons class

Check the config (see: Configuration (from config service)) is as required, otherwise refer to 3rd line support

500

(Unknown error)

An unexpected error occurred

View the logs on cloudwatch and investigate the issue, cloudwatch logs groups can be found here: AWS Cloudwatch Group