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

Uploaded Source

Built Distribution

salt_analytics_framework-0.2.0-py2.py3-none-any.whl (28.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for salt-analytics-framework-0.2.0.tar.gz
Algorithm Hash digest
SHA256 2d3b4bf01d6aa346bfc5f6a9e0a0fdecddff3801f397e91bdaf2d269fee9750e
MD5 8fbe12c397587b901b5c34a30f88e338
BLAKE2b-256 5986e5a00550b32614b1e866d67d528684e5007015554fcb0ae5707708da9309

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for salt_analytics_framework-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e2a1b1a4f4be46529011d2129da6ae5a3d47b483b2138327566b6b647ec34e22
MD5 f80f405926745c8b43f6091577c139e4
BLAKE2b-256 b9a5308630b272ad1b0e4e54a24caef4e0a9589ccb2cb28d595f277af120bd7f

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