SDK
SDK Java v1.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.

This SDK has been deprecated because of stability issues. It is not advised to use it in a production environment.

getStats #

Returns statistics snapshots within a provided timestamp range. By default, snapshots are made every 10 seconds and they are stored for 1 hour.

These statistics include:

  • the number of connected users per protocol (not available for all protocols)
  • the number of ongoing requests
  • the number of completed requests since the last frame
  • the number of failed requests since the last f

Arguments #

public java.lang.String getStats(
long,
long,
io.kuzzle.sdk.QueryOptions
);
public java.lang.String getStats(
long,
long
);
ArgumentsTypeDescriptionRequired
startTimelongbegining of statistics frame set (timestamp or datetime format)yes
stopTimelongend of statistics frame set (timestamp or datetime format)yes
optionsio.kuzzle.sdk.QueryOptionsAn object containing query options.no

Options #

Additional query options

PropertyTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return #

Return statistics snapshots within a provided timestamp range as a String.

Exceptions #

Throws a io.kuzzle.sdk.KuzzleException if there is an error. See how to handle error.

Usage #

try {
  String stats = new String(kuzzle.getServer().getStats(
    1234567890000L,
    1541426610000L
  ));
  System.out.println("Kuzzle Stats as JSON string: " + stats);
} catch (KuzzleException e) {
  System.err.println(e.getMessage());
}