HealthCheck
in package
This is the HealthCheck class.
The purpose of this class is to execute a general health check of the system.
Tags
Table of Contents
CONFIGURATION | = 'configuartion' | |
---|---|---|
DATA | = 'data' | |
ENVIRONMENT_VALUES | = 'environmentValues' | |
MSG | = 'message' | |
STEP_10_LC_FWK | = 'step_10_LcFWK' | |
STEP_1_APPLICATION | = 'step_1_application' | |
STEP_2_REDIS | = 'step_2_redis' | |
STEP_3_SESSION | = 'step_3_session' | |
STEP_4_API_CONNECTION | = 'step_4_ApiConnection' | |
STEP_5_ADD_PRODUCT | = 'step_5_addProduct' | |
STEP_6_BATCH_REQUEST | = 'step_6_batchRequests' | |
STEP_7_CREATE_CONTROLLER | = 'step_7_createController' | |
STEP_8_RENDER_RESPONSE | = 'step_8_renderResponse' | |
STEP_9_CURL_TIMETAKEN | = 'step_9_curlTimeTaken' | |
STEPS | = 'steps' | |
SUCCESS | = 'success' | |
SUMMARY | = 'summary' | |
TIMER | = 'time_taken' | |
__construct() | Constructor of the HealthCheck. | : mixed |
run() | This method executes the health check. It consists into check some basic mechanisms of the commerce like: <ul> <li>Check start Application.</li> <li>Check Redis.</li> <li>Check Session.</li> <li>Check Api Connection.</li> <li>Check Add Product.</li> <li>Check Batch Request.</li> <li>Check Create Controller.</li> <li>Check Render Response.</li> <li>Timings.</li> </ul> If the request contains the parameter 'template=true' then it returns a json response with the checks results. | : mixed |
Constants
CONFIGURATION
public
mixed
CONFIGURATION
= 'configuartion'
DATA
public
mixed
DATA
= 'data'
ENVIRONMENT_VALUES
public
mixed
ENVIRONMENT_VALUES
= 'environmentValues'
MSG
public
mixed
MSG
= 'message'
STEP_10_LC_FWK
public
mixed
STEP_10_LC_FWK
= 'step_10_LcFWK'
STEP_1_APPLICATION
public
mixed
STEP_1_APPLICATION
= 'step_1_application'
STEP_2_REDIS
public
mixed
STEP_2_REDIS
= 'step_2_redis'
STEP_3_SESSION
public
mixed
STEP_3_SESSION
= 'step_3_session'
STEP_4_API_CONNECTION
public
mixed
STEP_4_API_CONNECTION
= 'step_4_ApiConnection'
STEP_5_ADD_PRODUCT
public
mixed
STEP_5_ADD_PRODUCT
= 'step_5_addProduct'
STEP_6_BATCH_REQUEST
public
mixed
STEP_6_BATCH_REQUEST
= 'step_6_batchRequests'
STEP_7_CREATE_CONTROLLER
public
mixed
STEP_7_CREATE_CONTROLLER
= 'step_7_createController'
STEP_8_RENDER_RESPONSE
public
mixed
STEP_8_RENDER_RESPONSE
= 'step_8_renderResponse'
STEP_9_CURL_TIMETAKEN
public
mixed
STEP_9_CURL_TIMETAKEN
= 'step_9_curlTimeTaken'
STEPS
public
mixed
STEPS
= 'steps'
SUCCESS
public
mixed
SUCCESS
= 'success'
SUMMARY
public
mixed
SUMMARY
= 'summary'
TIMER
public
mixed
TIMER
= 'time_taken'
Methods
__construct()
Constructor of the HealthCheck.
public
__construct() : mixed
Return values
mixed —run()
This method executes the health check. It consists into check some basic mechanisms of the commerce like: <ul> <li>Check start Application.</li> <li>Check Redis.</li> <li>Check Session.</li> <li>Check Api Connection.</li> <li>Check Add Product.</li> <li>Check Batch Request.</li> <li>Check Create Controller.</li> <li>Check Render Response.</li> <li>Timings.</li> </ul> If the request contains the parameter 'template=true' then it returns a json response with the checks results.
public
run() : mixed
Otherwise, it generates a 'health check' log register with the checks results.