stackforge/libra
Code Issues Proposed changes

Add documentation for new STATS worker message.

Browse Source 
Change-Id: I51fe2ae43237f557582e837c8c504e53184b0fd5
This commit is contained in:
David Shrewsbury 2013-04-08 16:12:21 -04:00
parent 912f0fe55d
commit 5887df9ac4
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/worker/messages.rst
View File

@ -273,3 +273,36 @@ Example Response
"hpcs_error": "Some error string explaining the failure." "hpcs_error": "Some error string explaining the failure."
} }
STATS Message
-------------
The STATS message queries the worker for load balancer statistics. Currently,
this doesn't do more than verify that the HAProxy process is running and we
can successfully query its statistics socket.
Required Fields
^^^^^^^^^^^^^^^
* hpcs_action
Example Request
^^^^^^^^^^^^^^^
.. code-block:: json
{
"hpcs_action": "STATS"
}
Example Response
^^^^^^^^^^^^^^^^
.. code-block:: json
{
"hpcs_action": "ARCHIVE",
"hpcs_response": "FAIL",
"hpcs_error": "Some error string explaining the failure."
}