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

getStats(startTime, stopTime, [options]);

Arguments	Type	Description
`startTime`	number, string	Begining of statistics frame set (timestamp or datetime format)
`stopTime`	number, string	End of statistics frame set (timestamp or datetime format)
`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
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolve #

Resolves to an object containing statistics snapshots within the provided range.

Usage #

try {
  const stats = await kuzzle.server.getStats('1234567890101', '1541426610304');
  console.log('Kuzzle Stats:', JSON.stringify(stats));
} catch (error) {
  console.error(error.message);
}

Edit this page on Github