Skip to main content

Salt Analytics Framework

Project description

CI Docs Codecov Python Versions Python Wheel Code Style: black PyPI - License

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.

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.0.1.tar.gz (57.9 kB view details)

Uploaded Source

Built Distribution

salt_analytics_framework-0.0.1-py2.py3-none-any.whl (29.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for salt-analytics-framework-0.0.1.tar.gz
Algorithm Hash digest
SHA256 0d9d2c4733dc29ff8d7bd29c84e8e8fe5d0162206b58d99f3a9c375ebf0a20dd
MD5 fd3e9f7269f77502c86f1dd88cb4412c
BLAKE2b-256 746f3f751a720d2e66272649f750be89df92bd396d42a4788523d05fef4d3756

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for salt_analytics_framework-0.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8a91041a0ff266994b63ec31c466ae62b16cad166dd54549ce6cf140f5f5b8fa
MD5 149bf7018e9bc0c7c6b5c791ffb6a062
BLAKE2b-256 e7cb8fba8f6cc215dbb4e25a8a3b6c6d2b6515c5a39279fc17ee7dd5f758285d

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