Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kuzzleio/kuzzle-plugin-probe-listener
Kuzzle statistical probe listener plugin
https://github.com/kuzzleio/kuzzle-plugin-probe-listener
kuzzle kuzzle-analytics kuzzle-plugin kuzzle-probe
Last synced: about 2 months ago
JSON representation
Kuzzle statistical probe listener plugin
- Host: GitHub
- URL: https://github.com/kuzzleio/kuzzle-plugin-probe-listener
- Owner: kuzzleio
- License: apache-2.0
- Archived: true
- Created: 2017-05-19T09:12:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-03-14T04:33:06.000Z (over 4 years ago)
- Last Synced: 2024-06-23T12:45:02.356Z (3 months ago)
- Topics: kuzzle, kuzzle-analytics, kuzzle-plugin, kuzzle-probe
- Language: JavaScript
- Homepage:
- Size: 234 KB
- Stars: 0
- Watchers: 11
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Table of Contents
- [About](#about)
- [Plugin configuration](#plugin-configuration)
- [Installation](#installation)
- [General configuration](#general-configuration)
- [Retrieving probe measures](#retrieving-probe-measures)
- [Probes description](#probes-description)
- [`monitor` probes](#monitor-probes)
- [Description](#description)
- [Configuration](#configuration)
- [`counter` probes](#counter-probes)
- [Description](#description-1)
- [Configuration](#configuration-1)
- [`watcher` probes](#watcher-probes)
- [Description](#description-2)
- [Configuration](#configuration-2)
- [`sampler` probes](#sampler-probes)
- [Description](#description-3)
- [Configuration](#configuration-3)
# 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](https://github.com/kuzzleio/kuzzle-plugin-probe) 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:
```json
{
"kdcAddress": "kdc-proxy",
"probes": {}
}
```
# Probes description
## `monitor` probes
### Description
Please refer to the documentation of the [plugin-plugin-probe](https://github.com/kuzzleio/kuzzle-plugin-probe#description) for more information about the `monitor` probe.
### Configuration
Probe configuration example:
```json
{
"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](https://github.com/kuzzleio/kuzzle-plugin-probe#description-1) for more information about the `counter` probe.
### Configuration
Probe configuration example:
```json
{
"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](https://github.com/kuzzleio/kuzzle-plugin-probe#description-2) for more information about the `watcher` probe.
### Configuration
Probe configuration example:
```json
{
"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](https://github.com/kuzzleio/kuzzle-plugin-probe#description-3) for more information about the `sampler` probe.
### Configuration
Probe configuration example:
```json
{
"probes": {
"probe_sampler": {
"type": "sampler",
"index": "some index",
"collection": "some collection"
}
}
}
```