# Core Monitoring Plugin
This plugin monitors messagebus traffic to log events and metrics. This data may
optionally be uploaded to a remote endpoint and/or saved locally for evaluation.
## Configuration
Metrics may be uploaded to an MQ endpoint for aggregation/data sharing. They may
also be saved locally for local monitoring/evaluation.
```yaml
PHAL:
neon-phal-plugin-core-monitor:
upload_enabled: False
save_locally: True
```
## Messagebus API
Messagebus events are handled to collect various metrics. There is no defined
set of supported metrics; any module may choose to report a metric to this plugin.
### Report Metric
Record an arbitrary metric by emitting:
```yaml
msg_type: neon.metric
data:
name: Metric name/type
timestamp: Optional timestamp metric was collected (float epoch time)
# Add any data that will be collected as part of this metric
```
### Get Metric
Get processed data for a collected metric.
```yaml
msg_type: neon.get_metric
data:
name: Metric name/type (required)
```
### Get Raw Metric
Get raw data for collected metrics. This will return a list of dict data for the
requested metric (dict of metric name to list dict data if no metric requested).
```yaml
msg_type: neon.get_raw_metric
data:
name: Metric name/type (or None to get all metrics)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/NeonGeckoCom/neon-phal-plugin-monitoring",
"name": "neon-phal-plugin-monitoring",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Neongecko",
"author_email": "developers@neon.ai",
"download_url": "https://files.pythonhosted.org/packages/30/41/359d926a54e3308139a458b3be31aa9fed84be4eeff74def7036bfd37e55/neon-phal-plugin-monitoring-0.0.2.tar.gz",
"platform": null,
"description": "# Core Monitoring Plugin\nThis plugin monitors messagebus traffic to log events and metrics. This data may\noptionally be uploaded to a remote endpoint and/or saved locally for evaluation.\n\n## Configuration\nMetrics may be uploaded to an MQ endpoint for aggregation/data sharing. They may\nalso be saved locally for local monitoring/evaluation.\n\n```yaml\nPHAL:\n neon-phal-plugin-core-monitor:\n upload_enabled: False\n save_locally: True\n```\n\n## Messagebus API\nMessagebus events are handled to collect various metrics. There is no defined \nset of supported metrics; any module may choose to report a metric to this plugin.\n\n### Report Metric\nRecord an arbitrary metric by emitting:\n```yaml\nmsg_type: neon.metric\ndata: \n name: Metric name/type\n timestamp: Optional timestamp metric was collected (float epoch time)\n # Add any data that will be collected as part of this metric\n```\n\n### Get Metric\nGet processed data for a collected metric.\n```yaml\nmsg_type: neon.get_metric\ndata:\n name: Metric name/type (required)\n```\n\n### Get Raw Metric\nGet raw data for collected metrics. This will return a list of dict data for the\nrequested metric (dict of metric name to list dict data if no metric requested).\n```yaml\nmsg_type: neon.get_raw_metric\ndata:\n name: Metric name/type (or None to get all metrics)\n```\n",
"bugtrack_url": null,
"license": "BSD-3",
"summary": "Core Monitoring Service",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/NeonGeckoCom/neon-phal-plugin-monitoring"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0c1f2b8f34508d36a11b622e93ea0e1670d9acb284cdd4a603f3c2b9619608a8",
"md5": "167fbce284033a347837fdf7fe6f8b95",
"sha256": "f0d5e1af4a9c5780d119c64710668281da88f971a41c706d05fa70db2f73ab79"
},
"downloads": -1,
"filename": "neon_phal_plugin_monitoring-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "167fbce284033a347837fdf7fe6f8b95",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6126,
"upload_time": "2024-04-22T18:46:01",
"upload_time_iso_8601": "2024-04-22T18:46:01.951777Z",
"url": "https://files.pythonhosted.org/packages/0c/1f/2b8f34508d36a11b622e93ea0e1670d9acb284cdd4a603f3c2b9619608a8/neon_phal_plugin_monitoring-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3041359d926a54e3308139a458b3be31aa9fed84be4eeff74def7036bfd37e55",
"md5": "552004faf6e4686211a94d2eef65c821",
"sha256": "f2d6525be96dcd9196ab7f8ad10a072b7b38386ddff7c657947a57b96711dbd3"
},
"downloads": -1,
"filename": "neon-phal-plugin-monitoring-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "552004faf6e4686211a94d2eef65c821",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4946,
"upload_time": "2024-04-22T18:46:04",
"upload_time_iso_8601": "2024-04-22T18:46:04.277333Z",
"url": "https://files.pythonhosted.org/packages/30/41/359d926a54e3308139a458b3be31aa9fed84be4eeff74def7036bfd37e55/neon-phal-plugin-monitoring-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 18:46:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NeonGeckoCom",
"github_project": "neon-phal-plugin-monitoring",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "neon-phal-plugin-monitoring"
}
JSON
