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

Uploaded Source

Built Distribution

salt_analytics_framework-0.1.0-py2.py3-none-any.whl (29.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for salt-analytics-framework-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a4de6f0189880e3ea35259b5149828e28f3798b6d7b536de241b4f3c66962be9
MD5 93d5d6f44f06d12328417df39df7eb90
BLAKE2b-256 b576f5c7e880421bf1435f5523f6bd257af6052d31ef7a18fa8960a54215a17b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for salt_analytics_framework-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4daad41c58a2670dd6fdd3a6e30efac07fb29a09b47d7b540f362e09777b9cbd
MD5 c4c17a4ec56a49cc4030fe6fa22ba707
BLAKE2b-256 17b7e25dddb344b1bb97664bb6edb24f1e51d25268b881e2b024d4fc5cd3f5de

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