Skip to main content

Salt Analytics Framework

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

salt-analytics-framework-0.4.0.tar.gz (53.0 kB view details)

Uploaded Source

Built Distribution

salt_analytics_framework-0.4.0-py2.py3-none-any.whl (29.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file salt-analytics-framework-0.4.0.tar.gz.

File metadata

File hashes

Hashes for salt-analytics-framework-0.4.0.tar.gz
Algorithm Hash digest
SHA256 a1cf4fba1e26fcdba58a2e8ad79afc024fcf3f7a3a834237ac64497cb9ff7243
MD5 1e33c512ff9246480f768c8e6e20f8b3
BLAKE2b-256 ab15d8714d50e8331fcc71cc231addb0f103c124baf71795f711bc8169bc0f19

See more details on using hashes here.

File details

Details for the file salt_analytics_framework-0.4.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for salt_analytics_framework-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9df399fac47c51d6ceaa27e44f0966d6ea0df70deaa64af0118722419305efb1
MD5 be83cb573e62e0a14b36de1e458c9e27
BLAKE2b-256 c86d09ba4ec73bf5cf1ab7e20fa5b0c49ba00e140bd738535d7cdae4b7310188

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page