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

Uploaded Source

Built Distribution

salt_analytics_framework-0.1.1-py2.py3-none-any.whl (29.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for salt-analytics-framework-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d9b5a0eea95b3171bfd53b6933ba68d7d41af2a3e9ee5cd5231d3b4759cfa481
MD5 6eab88b4871dd52d0a26ed94e6b7fe40
BLAKE2b-256 70862d4a90b0d67655b2363fa0c2aae2846e30453d1cb478e6996f962aefecd3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for salt_analytics_framework-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 109d89755d5187b0349c91175e1791ffa1995025fff9fe33e78831b93e070f07
MD5 8d20fa97c00f01e3953b553a462b5c20
BLAKE2b-256 fbc57d0a113302bc2eadf20fc1dc95c25b0d12a323db99dde8b6f781c5cd0dcb

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