{"id":13721194,"url":"https://github.com/kuzzleio/kuzzle-plugin-probe-listener","last_synced_at":"2025-05-07T13:31:58.682Z","repository":{"id":71813443,"uuid":"91788254","full_name":"kuzzleio/kuzzle-plugin-probe-listener","owner":"kuzzleio","description":"Kuzzle statistical probe listener plugin","archived":true,"fork":false,"pushed_at":"2020-03-14T04:33:06.000Z","size":240,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-08-04T01:14:44.996Z","etag":null,"topics":["kuzzle","kuzzle-analytics","kuzzle-plugin","kuzzle-probe"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kuzzleio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-05-19T09:12:39.000Z","updated_at":"2023-07-21T12:45:35.000Z","dependencies_parsed_at":"2023-06-11T00:15:27.873Z","dependency_job_id":null,"html_url":"https://github.com/kuzzleio/kuzzle-plugin-probe-listener","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuzzleio%2Fkuzzle-plugin-probe-listener","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuzzleio%2Fkuzzle-plugin-probe-listener/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuzzleio%2Fkuzzle-plugin-probe-listener/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuzzleio%2Fkuzzle-plugin-probe-listener/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kuzzleio","download_url":"https://codeload.github.com/kuzzleio/kuzzle-plugin-probe-listener/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224604832,"owners_count":17339214,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kuzzle","kuzzle-analytics","kuzzle-plugin","kuzzle-probe"],"created_at":"2024-08-03T01:01:13.725Z","updated_at":"2024-11-14T10:31:15.243Z","avatar_url":"https://github.com/kuzzleio.png","language":"JavaScript","funding_links":[],"categories":["Plugins"],"sub_categories":["Others"],"readme":"# Table of Contents\n\n- [About](#about)\n- [Plugin configuration](#plugin-configuration)\n  - [Installation](#installation)\n  - [General configuration](#general-configuration)\n  - [Retrieving probe measures](#retrieving-probe-measures)\n- [Probes description](#probes-description)\n  - [`monitor` probes](#monitor-probes)\n    - [Description](#description)\n    - [Configuration](#configuration)\n  - [`counter` probes](#counter-probes)\n    - [Description](#description-1)\n    - [Configuration](#configuration-1)\n  - [`watcher` probes](#watcher-probes)\n    - [Description](#description-2)\n    - [Configuration](#configuration-2)\n  - [`sampler` probes](#sampler-probes)\n    - [Description](#description-3)\n    - [Configuration](#configuration-3)\n\n\n# About\n\nPlugin 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.\n\n\n# Plugin configuration\n\n## Installation\n\nPlace the plugin directory under `plugins/available`, then create a symbolic link pointing to it under `plugins/enabled`.\n\n\n## General configuration\n\nAfter a fresh installation, the plugin configuration looks like this:\n\n```json\n{\n  \"kdcAddress\": \"kdc-proxy\",\n  \"probes\": {}\n}\n```\n\n\n# Probes description\n\n## `monitor` probes\n\n### Description\n\nPlease refer to the documentation of the [plugin-plugin-probe](https://github.com/kuzzleio/kuzzle-plugin-probe#description) for more information about the `monitor` probe.\n\n### Configuration\n\nProbe configuration example:\n\n```json\n{\n  \"probes\": {\n    \"probe_monitor_1\": {\n      \"type\": \"monitor\",\n      \"hooks\": [\"some:event\", \"some:otherevent\", \"andyet:anotherone\"]\n    }\n  }\n}\n```\n\n\n## `counter` probes\n\n### Description\n\nPlease 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.\n\n### Configuration\n\nProbe configuration example:\n\n```json\n{\n  \"probes\": {\n    \"probe_counter_1\": {\n      \"type\": \"counter\",\n      \"increasers\": [\"list:of\", \"counterIncreasing:events\"],\n      \"decreasers\": [\"anotherlist:of\", \"counterDecreasing:events\"]\n    }\n  }\n}\n```\n\n\n## `watcher` probes\n\n### Description\n\nPlease 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.\n\n### Configuration\n\nProbe configuration example:\n\n```json\n{\n  \"probes\": {\n    \"probe_watcher_1\": {\n      \"type\": \"watcher\",\n      \"index\": \"some index\",\n      \"collection\": \"some collection\"\n    }\n  }\n}\n```\n\n## `sampler` probes\n\n### Description\n\nPlease 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.\n\n### Configuration\n\nProbe configuration example:\n\n```json\n{\n  \"probes\": {\n    \"probe_sampler\": {\n      \"type\": \"sampler\",\n      \"index\": \"some index\",\n      \"collection\": \"some collection\"\n    }\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkuzzleio%2Fkuzzle-plugin-probe-listener","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkuzzleio%2Fkuzzle-plugin-probe-listener","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkuzzleio%2Fkuzzle-plugin-probe-listener/lists"}