SysFlow: Облачно-родной конвейер системной телеметрии

Этот репозиторий содержит документацию и трекер задач для всех проектов SysFlow.

Быстрая справка

• Документация:
  the SysFlow Documentation

• Где получить помощь:
  the SysFlow Community Slack

• Куда отправлять сообщения об ошибках:
  the github issue tracker

• Источник этого описания:
  repo's readme (history)

• Docker-образы:
  docker hub | GHCR

Что такое SysFlow?

Конвейер телеметрии SysFlow — это платформа для мониторинга облачных нагрузок и создания аналитики производительности и безопасности. Цель этого проекта — создать всю необходимую инфраструктуру для системной телеметрии, чтобы пользователи могли сосредоточиться на написании и обмене аналитическими данными на масштабируемой, общей платформе с открытым исходным кодом. Основой конвейера телеметрии является новый формат данных под названием SysFlow, который преобразует необработанную информацию о системных событиях в абстракцию, описывающую поведение процессов и их отношения с контейнерами, файлами и сетью. Этот объектно-реляционный формат является очень компактным, но при этом обеспечивает широкую видимость в контейнерных облаках. Мы также создали несколько API, которые позволяют пользователям обрабатывать SysFlow с помощью своих любимых наборов инструментов. Узнайте больше о SysFlow в документе спецификации SysFlow.

Платформа SysFlow состоит из следующих подпроектов:

• sf-apis предоставляет схему SysFlow и программные API на Go, Python и C++.
• sf-collector отслеживает и собирает информацию о системных вызовах и событиях с хостов и экспортирует их в формате SysFlow с использованием сериализации объектов Apache Avro.
• 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 и т.д. из базового дистрибутива, а также любые прямые или косвенные зависимости основного программного обеспечения).

Что касается использования любых предварительно собранных образов, ответственность за то, чтобы любое использование этого образа соответствовало всем соответствующим лицензиям для всего содержащегося в нем программного обеспечения, лежит на пользователе образа.