salt-analytics-framework 0.5.0

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.