Table of Contents

• About
• Plugin configuration
  • Installation
  • General configuration
  • Retrieving probe measures
• Probes description
  • monitor probes
    • Description
    • Configuration
  • counter probes
    • Description
    • Configuration
  • watcher probes
    • Description
    • Configuration
  • sampler probes
    • Description
    • Configuration

About

Plugin allowing to add probes, collecting data and events to calculate data metrics and send them to KDC (Kuzzle Data Collector). This plugin must be used in conjonction with a KDC instance where the plugin kuzzle-plugin-probe is installed. Refer to the kuzzle-plugin-probe documentation for more information.

Plugin configuration

Installation

Place the plugin directory under plugins/available, then create a symbolic link pointing to it under plugins/enabled.

General configuration

After a fresh installation, the plugin configuration looks like this:

{
  "kdcAddress": "kdc-proxy",
  "probes": {}
}

Probes description

monitor probes

Description

Please refer to the documentation of the plugin-plugin-probe for more information about the monitor probe.

Configuration

Probe configuration example:

{
  "probes": {
    "probe_monitor_1": {
      "type": "monitor",
      "hooks": ["some:event", "some:otherevent", "andyet:anotherone"]
    }
  }
}

counter probes

Description

Please refer to the documentation of the plugin-plugin-probe for more information about the counter probe.

Configuration

Probe configuration example:

{
  "probes": {
    "probe_counter_1": {
      "type": "counter",
      "increasers": ["list:of", "counterIncreasing:events"],
      "decreasers": ["anotherlist:of", "counterDecreasing:events"]
    }
  }
}

watcher probes

Description

Please refer to the documentation of the plugin-plugin-probe for more information about the watcher probe.

Configuration

Probe configuration example:

{
  "probes": {
    "probe_watcher_1": {
      "type": "watcher",
      "index": "some index",
      "collection": "some collection"
    }
  }
}

sampler probes

Description

Please refer to the documentation of the plugin-plugin-probe for more information about the sampler probe.

Configuration

Probe configuration example:

{
  "probes": {
    "probe_sampler": {
      "type": "sampler",
      "index": "some index",
      "collection": "some collection"
    }
  }
}