SysFlow: Cloud-native system telemetry pipeline

This repository hosts the documentation and issue tracker for all SysFlow projects.

Quick reference

• Documentation:
  the SysFlow Documentation

• Where to get help:
  the SysFlow Community Slack

• Where to file issues:
  the github issue tracker

• Source of this description:
  repo's readme (history)

• Docker images:
  docker hub | GHCR

What is SysFlow?

The SysFlow Telemetry Pipeline is a framework for monitoring cloud workloads and for creating performance and security analytics. The goal of this project is to build all the plumbing required for system telemetry so that users can focus on writing and sharing analytics on a scalable, common open-source platform. The backbone of the telemetry pipeline is a new data format called SysFlow, which lifts raw system event information into an abstraction that describes process behaviors, and their relationships with containers, files, and network. This object-relational format is highly compact, yet it provides broad visibility into container clouds. We have also built several APIs that allow users to process SysFlow with their favorite toolkits. Learn more about SysFlow in the SysFlow specification document.

The SysFlow framework consists of the following sub-projects:

• sf-apis provides the SysFlow schema and programatic APIs in go, python, and C++.
• sf-collector monitors and collects system call and event information from hosts and exports them in the SysFlow format using Apache Avro object serialization.
• sf-processor provides a performance optimized policy engine for processing, enriching, filtering SysFlow events, generating alerts, and exporting the processed data to various targets.
• sf-exporter exports SysFlow traces to S3-compliant storage systems for archival purposes.
• sf-deployments contains deployment packages for SysFlow, including Docker, Helm, and OpenShift.
• sysflow is the documentation repository and issue tracker for the SysFlow framework.

Online documentation

SysFlow documentation is available at sysflow.readthedocs.io.

Offline build

This documentation depends on Sphinx (http://www.sphinx-doc.org/en/master/), which must be installed to do builds. The project also requires the following Sphinx plugins:

• http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
• https://pypi.org/project/m2r/

To build the site as HTML go to the base directory and type:

make html

License

View license information for SysFlow.

As with all software packages, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.