apache/kafka:README に基づく導入ガイド
README、メタデータ、ライセンスに基づく apache/kafka の導入と確認ガイドです。
プロジェクトの範囲
apache/kafka の README はプロジェクトを「Apache Kafka - A distributed event streaming platform」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「README」には次の説明があります。Apache Kafka is an open-source distributed event streaming platform used by thousands of companies for high-performance data pipelines, streaming analytics, data integration, and mission-critical applications.。これは範囲の説明であり、本番検証の結果ではありません。
向いている用途
README の「Common build options」にある内容から、用途が合うかを先に判断できます。mavenUrl: sets the URL of the maven deployment repository (file://path/to/repo can be used to point to a local repository).。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。commitId: sets the build commit ID as .git/HEAD might not be correct if there are local commits added for build purposes.。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。
動作の考え方
動作の説明は「README」など複数の箇所に分かれています。確認できる情報は次の通りです。Scala 2.13 is the only supported version in Apache Kafka.。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。
インストールと初回起動
初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 ./gradlew reportCoverage -PenableTestCoverage=true -Dorg.gradle.parallel=false 実行可能なコマンドがない場合は手順を作らず、「Build source JAR」で依存関係、待受ポート、初回設定を確認します。
設定と日常運用
日常運用は公式文書の範囲に限ります。「Running a particular unit/integration test with log4j output」にはBy default, there will be only a small number of logs output while testing. You can adjust it by changing the log4j2.yaml file in the module's src/test/resources directory.とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料にはmaxParallelForks: maximum number of test processes to start in parallel. Defaults to the number of processors available to the JVM.ともあります。