Unknown SDK

getAllStats

Gets all stored internal statistic snapshots. 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

Copied to clipboard!
getAllStats([options]);

Arguments Type Description
options
object
Query options

Options

Additional query options

Property Type
(default)
Description
queuable
boolean

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

Resolve

Resolves to an object containing all stored internal statistic snapshots.

Usage

Copied to clipboard!
try {
  const allStats = await kuzzle.server.getAllStats();
  console.log('All Kuzzle Stats:', JSON.stringify(allStats));
} catch (error) {
  console.error(error.message);
}