SDK
SDK Java v2.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

getStatistics #

Without argument, retrieves the last statistic frame in an array: When providing a timestamp, retrieves all frames recorded after that timestamp: Kuzzle server monitors active connections, and ongoing/completed/failed requests.
This method returns either the last statistics frame, or a set of frames starting from a provided timestamp.


getStatistics([timestamp], [options], callback) #

ArgumentsTypeDescription
timestampEpoch timeOptional starting time from which the frames are to be retrieved
optionsJSON objectOptional parameters
callbackfunctionCallback handling the response

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Note: Kuzzle statistics are cleaned up regularly. If the timestamp is set too far in the past, then this method will return all available statistics.


Callback Response #

Returns an array containing one or more statistics frame (as JSON objects).

Usage #

kuzzle.getStatistics(new ResponseListener<JSONObject>() {
  @Override
  public void onSuccess(JSONObject[] statistics) {
    // ...
  }
  @Override
  public void onError(JSONObject error) {
    // Handle error
  }
});
// Date can be either in ISO format or a timestamp (utc, in milliseconds)
kuzzle.getStatistics("2015-11-15T13:36:45.558Z", new ResponseListener<JSONObject[]>() {
  @Override
  public void onSuccess(JSONObject[] statistics) {
    // ...
  }
  @Override
  public void onError(JSONObject error) {
    // Handle error
  }
};

Callback response:

[
  {
    "connections": { "socketio": 1 },
    "ongoingRequests": { "rest": 0, "socketio": 0 },
    "completedRequests": { "mqtt": 37, "socketio": 17 },
    "failedRequests": { "socketio": 1 },
    "timestamp": "1453110641308"
  }
]