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

Uploaded Source

Built Distribution

salt_analytics_framework-0.3.0-py2.py3-none-any.whl (29.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for salt-analytics-framework-0.3.0.tar.gz
Algorithm Hash digest
SHA256 fcee1d924ee2560b31e646d40ea6b3d4e0d6eaa6bdab6e44dbb72c54d16db693
MD5 54fb998e3081600455b0eb06e4bc5d6c
BLAKE2b-256 bf9994912ab12e2c5957f09d3072597aaf65988796932e26b024746dcd800301

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for salt_analytics_framework-0.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 46297240c26868739209cfea3b5d3ad1406213a2e7211903bcc0cd0736208be0
MD5 da56803f09ad3455e17a38294167b748
BLAKE2b-256 cc6e035ac17d86d33e0558e6275c74bed7d2266e08f646f43c5b3f3475eb97f6

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