..
include-starts-here
================================
What is Salt Analytics Framework
================================
It's a framework which extends `Salt`_ through the use of an `engine`_ that can collect,
process and forward analytics/metrics data.
Install
=======
Installing Salt Analytics Framework is as simple as:
.. code-block:: bash
python -m pip install salt-analytics-framework
Configuration
=============
The minimal configuration to start salt analytics with `Salt`_ is to add it to Salt's engines
configuration:
.. code-block:: yaml
engines:
- analytics
Example Pipeline
----------------
.. code-block:: yaml
beacons:
memusage:
- interval: 5
- percent: 0.01%
status:
- interval: 5
- time:
- all
- loadavg:
- all
analytics:
collectors:
beacons-collector:
plugin: beacons
beacons:
- "*"
processors:
noop-processor:
plugin: noop
forwarders:
disk-forwarder:
plugin: disk
path: /var/cache/salt
filename: events-dumped.txt
pretty_print: true
pipelines:
my-pipeline:
collect: beacons-collector
process: noop-processor
forward: disk-forwarder
Usage
=====
TBD
Contributing
============
The salt-analytics-framework project team welcomes contributions from the community.
For more detailed information, refer to `CONTRIBUTING`_.
.. _salt: https://github.com/saltstack/salt
.. _engine: https://docs.saltproject.io/en/latest/topics/engines/index.html
.. _CONTRIBUTING: https://github.com/saltstack/salt-analytics-framework/blob/main/CONTRIBUTING.md
.. _examples: https://github.com/saltstack/salt-analytics-framework/blob/main/examples
..
include-ends-here
Documentation
=============
The full documentation can be seen `here <https://salt-analytics-framework.readthedocs.io>`_.
Examples
========
Some examples of custom pipelines are provided. You can find them at `examples`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/saltstack/salt-analytics-framework",
"name": "salt-analytics-framework",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "salt-extension",
"author": "Pedro Algarvio",
"author_email": "palgarvio@vmware.com",
"download_url": "https://files.pythonhosted.org/packages/24/07/f4351af86a8fd3c4193522f10ede08974ae07a81a4222d1550274c223076/salt-analytics-framework-0.5.0.tar.gz",
"platform": "any",
"description": "..\n include-starts-here\n\n================================\nWhat is Salt Analytics Framework\n================================\n\nIt's a framework which extends `Salt`_ through the use of an `engine`_ that can collect,\nprocess and forward analytics/metrics data.\n\n\nInstall\n=======\n\nInstalling Salt Analytics Framework is as simple as:\n\n.. code-block:: bash\n\n python -m pip install salt-analytics-framework\n\n\nConfiguration\n=============\n\nThe minimal configuration to start salt analytics with `Salt`_ is to add it to Salt's engines\nconfiguration:\n\n.. code-block:: yaml\n\n engines:\n - analytics\n\n\nExample Pipeline\n----------------\n\n.. code-block:: yaml\n\n beacons:\n memusage:\n - interval: 5\n - percent: 0.01%\n status:\n - interval: 5\n - time:\n - all\n - loadavg:\n - all\n\n analytics:\n collectors:\n beacons-collector:\n plugin: beacons\n beacons:\n - \"*\"\n\n processors:\n noop-processor:\n plugin: noop\n\n forwarders:\n disk-forwarder:\n plugin: disk\n path: /var/cache/salt\n filename: events-dumped.txt\n pretty_print: true\n\n pipelines:\n my-pipeline:\n collect: beacons-collector\n process: noop-processor\n forward: disk-forwarder\n\n\nUsage\n=====\n\nTBD\n\nContributing\n============\n\nThe salt-analytics-framework project team welcomes contributions from the community.\nFor more detailed information, refer to `CONTRIBUTING`_.\n\n.. _salt: https://github.com/saltstack/salt\n.. _engine: https://docs.saltproject.io/en/latest/topics/engines/index.html\n.. _CONTRIBUTING: https://github.com/saltstack/salt-analytics-framework/blob/main/CONTRIBUTING.md\n.. _examples: https://github.com/saltstack/salt-analytics-framework/blob/main/examples\n\n..\n include-ends-here\n\nDocumentation\n=============\n\nThe full documentation can be seen `here <https://salt-analytics-framework.readthedocs.io>`_.\n\n\nExamples\n========\n\nSome examples of custom pipelines are provided. You can find them at `examples`_.\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Salt Analytics Framework",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/saltstack/salt-analytics-framework",
"Source": "https://github.com/saltstack/salt-analytics-framework",
"Tracker": "https://github.com/saltstack/salt-analytics-framework/issues"
},
"split_keywords": [
"salt-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "64e9accf58164191e93d0a5807b6c452346af0dfa5ea6057ae062b3129782392",
"md5": "d3d32e9b5a0b6f4caaba5e18f12cb5c5",
"sha256": "3615f72c831f625ccdd133187537f413b77d707efd4128b971c7f5b92bb128ec"
},
"downloads": -1,
"filename": "salt_analytics_framework-0.5.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3d32e9b5a0b6f4caaba5e18f12cb5c5",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 31316,
"upload_time": "2023-06-01T20:17:20",
"upload_time_iso_8601": "2023-06-01T20:17:20.853062Z",
"url": "https://files.pythonhosted.org/packages/64/e9/accf58164191e93d0a5807b6c452346af0dfa5ea6057ae062b3129782392/salt_analytics_framework-0.5.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2407f4351af86a8fd3c4193522f10ede08974ae07a81a4222d1550274c223076",
"md5": "6f75e435b07dae3728030d406119fd82",
"sha256": "b9553ec4b073d1e9502ae28d40547a13336e82b2cd7dda9ef9f9ffa2f71007ec"
},
"downloads": -1,
"filename": "salt-analytics-framework-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "6f75e435b07dae3728030d406119fd82",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 57960,
"upload_time": "2023-06-01T20:17:25",
"upload_time_iso_8601": "2023-06-01T20:17:25.094139Z",
"url": "https://files.pythonhosted.org/packages/24/07/f4351af86a8fd3c4193522f10ede08974ae07a81a4222d1550274c223076/salt-analytics-framework-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-01 20:17:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "saltstack",
"github_project": "salt-analytics-framework",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "salt-analytics-framework"
}
JSON
