SysFlow: 云原生系统遥测管道

此仓库托管所有 SysFlow 项目的文档和问题追踪。

快速参考

• 文档:
  SysFlow 文档

• 获取帮助的渠道:
  SysFlow 社区 Slack

• 提交问题的位置:
  GitHub 问题追踪器

• 此描述的来源:
  仓库的 readme (历史)

• Docker 镜像:
  docker hub | GHCR

什么是 SysFlow？

SysFlow 遥测管道是一个用于监控云工作负载并创建性能和安全分析的框架。该项目的目标是构建系统遥测所需的所有基础设施，以便用户能够专注于在可扩展的、通用的开源平台上编写和分享分析。遥测管道的核心是一种名为 SysFlow 的新数据格式，它将原始系统事件信息提升为描述进程行为及其与容器、文件、网络关系的抽象。这种对象关系格式非常紧凑，同时为容器云提供了广泛的可见性。我们还构建了多个 API，允许用户使用他们喜欢的工具包处理 SysFlow。在 SysFlow 规范文档中了解更多关于 SysFlow 的信息。

SysFlow 框架包含以下子项目：

• sf-apis 提供 SysFlow 模式以及 Go、Python 和 C++ 中的编程 API。
• sf-collector 监控并收集主机上的系统调用和事件信息，并使用 Apache Avro 对象序列化以 SysFlow 格式导出。
• sf-processor 提供一个性能优化的策略引擎，用于处理、丰富、过滤 SysFlow 事件，生成告警，并将处理后的数据导出到各种目标。
• sf-exporter 将 SysFlow 跟踪数据导出到符合 S3 的存储系统以进行归档。
• sf-deployments 包含 SysFlow 的部署包，包括 Docker、Helm 和 OpenShift。
• sysflow 是 SysFlow 框架的文档仓库和问题追踪器。

在线文档

SysFlow 文档可在 sysflow.readthedocs.io 获取。

离线构建

本文档依赖于 Sphinx (http://www.sphinx-doc.org/en/master/)，构建前必须安装。该项目还需要以下 Sphinx 插件：

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

要构建为 HTML 站点，请转到根目录并输入：

make html

许可证

查看 SysFlow 的许可证信息。

与所有软件包一样，这些软件可能还包含其他软件，这些软件可能受其他许可证约束（例如基础发行版中的 Bash 等，以及包含的主要软件的任何直接或间接依赖项）。

至于任何预构建镜像的使用，镜像用户有责任确保对此镜像的任何使用均符合其中包含的所有软件的相关许可证。