SysFlow: クラウドネイティブシステムテレメトリパイプライン

このリポジトリは、すべてのSysFlowプロジェクトのドキュメントと課題追跡をホストしています。

クイックリファレンス

• ドキュメント:
  SysFlowドキュメント

• ヘルプの入手先:
  SysFlowコミュニティSlack

• 問題の報告先:
  GitHubの課題追跡機能

• この説明のソース:
  リポジトリのREADME (履歴)

• Dockerイメージ:
  Docker Hub | GHCR

SysFlowとは？

SysFlowテレメトリパイプラインは、クラウドワークロードを監視し、パフォーマンスおよびセキュリティ分析を作成するためのフレームワークです。このプロジェクトの目標は、システムテレメトリに必要なすべての配管を構築し、ユーザーがスケーラブルで共通のオープンソースプラットフォーム上で分析の作成と共有に集中できるようにすることです。テレメトリパイプラインの基盤は、SysFlowと呼ばれる新しいデータ形式であり、生のシステムイベント情報を、プロセスの動作やコンテナ、ファイル、ネットワークとの関係を記述する抽象化に変換します。このオブジェクトリレーショナル形式は非常にコンパクトでありながら、コンテナクラウドへの広範な可視性を提供します。また、ユーザーが好みのツールキットでSysFlowを処理できるように、いくつかのAPIも構築しています。SysFlowの詳細については、SysFlow仕様書をご覧ください。

SysFlowフレームワークは、以下のサブプロジェクトで構成されています：

• sf-apisは、Go、Python、C++でSysFlowスキーマとプログラムAPIを提供します。
• sf-collectorは、ホストからシステムコールおよびイベント情報を監視・収集し、Apache Avroオブジェクトシリアライゼーションを使用してSysFlow形式でエクスポートします。
• sf-processorは、パフォーマンス最適化されたポリシーエンジンを提供し、SysFlowイベントの処理、エンリッチ、フィルタリング、アラート生成、および処理済みデータのさまざまなターゲットへのエクスポートを行います。
• sf-exporterは、アーカイブ目的でSysFlowトレースをS3互換のストレージシステムにエクスポートします。
• sf-deploymentsには、Docker、Helm、OpenShiftを含むSysFlowのデプロイメントパッケージが含まれています。
• 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などの他のソフトウェアや、含まれている主要ソフトウェアの直接的または間接的な依存関係が含まれている可能性があり、それらは他のライセンスに基づいている場合があります。

プレビルドイメージの使用に関しては、イメージユーザーはこのイメージの使用が含まれるすべてのソフトウェアの関連ライセンスに準拠していることを確認する責任があります。