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 frame

Signature

Copied to clipboard!
std::string getStats(time_t start, time_t end);

std::string getStats(time_t start, time_t end, const kuzzleio::query_options& options);

Arguments

Arguments Type Description
startTime
time_t
Timestamp of the begining of statistics frame set
stopTime
time_t
Timestamp of the end of statistics frame set
options
kuzzleio::query_options*
Query options

options

Additional query options

Option Type
(default)
Description
queuable
bool

(true)
If true, queues the request during downtime, until connected to Kuzzle again

Return

A JSON string representing the statistics for the given period of time.

Exceptions

Throws a kuzzleio::KuzzleException if there is an error. See how to handle error.

Usage

Copied to clipboard!
try {
  time_t start = std::time(0);
  time_t stop = std::time(0);

  std::string stats = kuzzle->server->getStats(start, stop);

  std::cout << "Kuzzle Stats as JSON string: " << stats << std::endl;
} catch (kuzzleio::KuzzleException& e) {
  std::cerr << e.what() << std::endl;
}