##########################################################################################

       VEH-14: Create Status Submodule

##########################################################################################


Issue Type: Task 
-----------------------------------------------------------------------------------------

Issue Information
====================

Priority: Minor					Status:      Closed
Resolution:  Done (2013-11-02 18:22:45)
Project: VehMan (VEH)


Reported By: btasker					
Assigned To: btasker

Components: 
	- Submodules 


Targeted for fix in version: 
	- 1.0.1

Labels: monitoring, 

Time Estimate: 0 minutes
Time Logged:   0 minutes


-----------------------------------------------------------------------------------------

Issue Description
==================

Create a sub-module to display the current API status

- Should return OK, Some Issues or Offline

Would like it to check DB connection is available amongst other things. 

Should also provide an INT defining how long the command took to run (so grab a timestamp
before doing anything, grab a timestamp once checks are done and subtract one from the
other). This will allow the Nagios plugin to throw a warning/critical if the API is
responding but taking a while to do so

-----------------------------------------------------------------------------------------

Subtasks
==========

	- VEH-15: Create Nagios Plugin


-----------------------------------------------------------------------------------------

Activity
==========

	
-----------------------------------------------------------------------------------------
2013-10-24 06:05:45              
-----------------------------------------------------------------------------------------

btasker added 'monitoring' to labels
	
-----------------------------------------------------------------------------------------
2013-11-02 18:22:09              btasker
-----------------------------------------------------------------------------------------

Implemented. Current responses are

*All quiet on the western front*


-- BEGIN QUOTE --


\{
  "timestamp":1383416435,
  "response":\{
                   "notes":[],
                  "maintenancemode":false,
                  "maintenancemessage":"",
                 "db":"OK"
                \},
  "errors":null,
  "error":0
\}

-- END QUOTE --

*Status - Site in maintenance mode*

-- BEGIN QUOTE --


\{
 "timestamp":1383416330,
 "response":\{
                "notes":[
                             "Other checks disabled as site under maintenance"
                          ],
             "maintenancemode":true,
            "maintenancemessage":"Hello World"
              \},
 "errors":null,
 "error":0
\}

-- END QUOTE --

*Global - API in maintenance mode (new config setting) *

-- BEGIN QUOTE --



\{
"timestamp":1383415891,
"response":[],
"errors":[
             ["API Unavailable","Hello World"]
          ],
"error":1
\}


-- END QUOTE --
	
-----------------------------------------------------------------------------------------
2013-11-02 18:22:46              
-----------------------------------------------------------------------------------------

btasker changed status from 'Open' to 'Resolved'
	
-----------------------------------------------------------------------------------------
2013-11-02 18:22:46              
-----------------------------------------------------------------------------------------

btasker added 'Done' to resolution
	
-----------------------------------------------------------------------------------------
2013-11-02 18:23:14              btasker
-----------------------------------------------------------------------------------------

Basic functionality implemented
	
-----------------------------------------------------------------------------------------
2013-11-02 18:23:14              
-----------------------------------------------------------------------------------------

btasker changed status from 'Resolved' to 'Closed'