core

Since Kuzzle v1.0.0

Events triggered to synchronize Kuzzle server instances in a cluster.


core:auth:strategyAdded

Since Kuzzle v1.2.0

Event type: Hook

Payload: Object (see below)

This event is triggered whenever a plugin registers an authentication strategy dynamically (see PluginContext).
This event is NOT triggered when plugins register authentication strategies by exposing a strategies object.

This event payload is a plain JSON object with the following properties:

  • pluginName: the name of the plugin having registered a strategy
  • name: authentication strategy name
  • strategy: authentication strategy properties, identical to the content of the strategies object for a given strategy

core:auth:strategyRemoved

Since Kuzzle v1.2.0

Event type: Hook

Payload: Object (see below)

This event is triggered whenever a plugin removes an authentication strategy dynamically (see PluginContext).

This event payload is a plain JSON object with the following properties:

  • pluginName: the name of the plugin having registered a strategy
  • name: authentication strategy name

core:kuzzleStart

Since Kuzzle v1.0.0

Event type: Hook

Triggered when Kuzzle has completed its starting sequence and is ready to process user requests.


core:overload

Since Kuzzle v1.0.0

Event type: Hook

Payload: Requests buffer filling percentage (number)

Kuzzle features an overload-protection system, configurable through the limits parameters in the .kuzzlerc file (see Configuring Kuzzle).

This feature allows only a small number of requests to be processed simultaneously. If more requests are to be processed, then they are stored in a buffer until some of the running requests are finished.

If requests are buffered more rapidly than they are processed, then Kuzzle enters overload mode, and starts triggering this event regularly, to inform about the state of the requests buffer.

Any request submitted while the requests buffer is completely filled (i.e. the payload is equal to 100) is automatically rejected.