From 7553a92232f642a50af15b07e2b9d94bf203cb09 Mon Sep 17 00:00:00 2001 From: Brandon Philips Date: Wed, 8 Jan 2014 10:40:57 -0800 Subject: [PATCH] feat(Documentation/api): document the store statistics --- Documentation/api.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/Documentation/api.md b/Documentation/api.md index 5201bb48a..0f0cbc343 100644 --- a/Documentation/api.md +++ b/Documentation/api.md @@ -765,3 +765,33 @@ curl -L 127.0.0.1:4001/v2/stats/self "state": "leader" } ``` + +### Store Statistics + +The store statistics include information about the operations that this node has handled. + +Operations that modify the store's state like create, delete, set and update are seen by the entire cluster and the number will increase on all nodes. +Operations like get and watch are node local and will only be seen on this node. + +```sh +curl -L 127.0.0.1:4001/v2/stats/store +``` + +```json +{ + "compareAndSwapFail": 0, + "compareAndSwapSuccess": 0, + "createFail": 0, + "createSuccess": 2, + "deleteFail": 0, + "deleteSuccess": 0, + "expireCount": 0, + "getsFail": 4, + "getsSuccess": 75, + "setsFail": 2, + "setsSuccess": 4, + "updateFail": 0, + "updateSuccess": 0, + "watchers": 0 +} +```