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:

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:

engines:
  - analytics

Example Pipeline

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.

Documentation

The full documentation can be seen here.

Examples

Some examples of custom pipelines are provided. You can find them at examples.

Metadata

Release files for salt-analytics-framework 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for salt-analytics-framework 0.5.0
File	Size	Uploaded
salt-analytics-framework-0.5.0.tar.gz	58.0 kB	Jun 1, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for salt-analytics-framework 0.5.0
File	Interpreter	ABI	Platform	Reset
salt_analytics_framework-0.5.0-py2.py3-none-any.whl 31.3 kB Jun 1, 2023	Python 3, Python 2	none	any	Details

Total release size: 89.3 kB

Release files / salt-analytics-framework-0.5.0.tar.gz

Download URL	salt-analytics-framework-0.5.0.tar.gz
Size	58.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`b9553ec4b073d1e9502ae28d40547a13336e82b2cd7dda9ef9f9ffa2f71007ec`
BLAKE2b-256 checksum How to use checksums	`2407f4351af86a8fd3c4193522f10ede08974ae07a81a4222d1550274c223076`
Upload date	Jun 1, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/4.0.1 CPython/3.11.3`

Release files / salt_analytics_framework-0.5.0-py2.py3-none-any.whl

Download URL	salt_analytics_framework-0.5.0-py2.py3-none-any.whl
Size	31.3 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`3615f72c831f625ccdd133187537f413b77d707efd4128b971c7f5b92bb128ec`
BLAKE2b-256 checksum How to use checksums	`64e9accf58164191e93d0a5807b6c452346af0dfa5ea6057ae062b3129782392`
Upload date	Jun 1, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/4.0.1 CPython/3.11.3`