{"id":14965239,"url":"https://github.com/saltstack/salt-analytics-framework","last_synced_at":"2025-10-19T08:32:21.355Z","repository":{"id":158415670,"uuid":"421785879","full_name":"saltstack/salt-analytics-framework","owner":"saltstack","description":"Salt Analytics Framework","archived":false,"fork":false,"pushed_at":"2024-01-22T13:20:27.000Z","size":1234,"stargazers_count":10,"open_issues_count":16,"forks_count":6,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-01-29T11:22:07.085Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/saltstack.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-27T11:12:42.000Z","updated_at":"2025-01-19T22:30:15.000Z","dependencies_parsed_at":"2024-09-13T23:38:47.179Z","dependency_job_id":"17adeb36-23ee-4306-a7ed-ba29fe596f03","html_url":"https://github.com/saltstack/salt-analytics-framework","commit_stats":{"total_commits":257,"total_committers":6,"mean_commits":"42.833333333333336","dds":"0.30739299610894943","last_synced_commit":"2d24ffc8b07b233d6b06f761a2631505e71d19de"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fsalt-analytics-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fsalt-analytics-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fsalt-analytics-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/saltstack%2Fsalt-analytics-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/saltstack","download_url":"https://codeload.github.com/saltstack/salt-analytics-framework/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237092968,"owners_count":19254320,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T13:34:25.136Z","updated_at":"2025-10-19T08:32:20.220Z","avatar_url":"https://github.com/saltstack.png","language":"Python","readme":"..\n   include-starts-here\n\n================================\nWhat is Salt Analytics Framework\n================================\n\nIt's a framework which extends `Salt`_ through the use of an `engine`_ that can collect,\nprocess and forward analytics/metrics data.\n\n\nInstall\n=======\n\nInstalling Salt Analytics Framework is as simple as:\n\n.. code-block:: bash\n\n   python -m pip install salt-analytics-framework\n\n\nConfiguration\n=============\n\nThe minimal configuration to start salt analytics with `Salt`_ is to add it to Salt's engines\nconfiguration:\n\n.. code-block:: yaml\n\n   engines:\n     - analytics\n\n\nExample Pipeline\n----------------\n\n.. code-block:: yaml\n\n   beacons:\n     memusage:\n       - interval: 5\n       - percent: 0.01%\n     status:\n       - interval: 5\n       - time:\n         - all\n       - loadavg:\n         - all\n\n   analytics:\n     collectors:\n       beacons-collector:\n         plugin: beacons\n         beacons:\n           - \"*\"\n\n     processors:\n       noop-processor:\n         plugin: noop\n\n     forwarders:\n       disk-forwarder:\n         plugin: disk\n         path: /var/cache/salt\n         filename: events-dumped.txt\n         pretty_print: true\n\n     pipelines:\n       my-pipeline:\n         collect: beacons-collector\n         process: noop-processor\n         forward: disk-forwarder\n\n\nUsage\n=====\n\nTBD\n\nContributing\n============\n\nThe salt-analytics-framework project team welcomes contributions from the community.\nFor more detailed information, refer to `CONTRIBUTING`_.\n\n.. _salt: https://github.com/saltstack/salt\n.. _engine: https://docs.saltproject.io/en/latest/topics/engines/index.html\n.. _CONTRIBUTING: https://github.com/saltstack/salt-analytics-framework/blob/main/CONTRIBUTING.md\n.. _examples: https://github.com/saltstack/salt-analytics-framework/blob/main/examples\n\n..\n   include-ends-here\n\nDocumentation\n=============\n\nThe full documentation can be seen `here \u003chttps://salt-analytics-framework.readthedocs.io\u003e`_.\n\n\nExamples\n========\n\nSome examples of custom pipelines are provided.  You can find them at `examples`_.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack%2Fsalt-analytics-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaltstack%2Fsalt-analytics-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaltstack%2Fsalt-analytics-framework/lists"}