https://github.com/saltstack/salt-analytics-framework
Salt Analytics Framework
https://github.com/saltstack/salt-analytics-framework
Last synced: 5 months ago
JSON representation
Salt Analytics Framework
- Host: GitHub
- URL: https://github.com/saltstack/salt-analytics-framework
- Owner: saltstack
- License: apache-2.0
- Created: 2021-10-27T11:12:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-22T13:20:27.000Z (over 1 year ago)
- Last Synced: 2025-01-29T11:22:07.085Z (5 months ago)
- Language: Python
- Size: 1.18 MB
- Stars: 10
- Watchers: 4
- Forks: 6
- Open Issues: 16
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
..
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 `_.
Examples
========
Some examples of custom pipelines are provided. You can find them at `examples`_.