准备工作编辑

Packetbeat 是用 Go 编写的,因此安装 Go 并了解其基础知识是理解本指南的前提条件。但如果您不是 Go 专家,也不必担心。Go 是一种相对较新的语言,很少有人是专家。事实上,包括 Packetbeat 的原作者在内,有几个人是通过为 Packetbeat 和 libbeat 做贡献而学习 Go 的。

您还需要很好地理解要添加支持的网络协议。对于标准协议或开源项目中使用的协议,您通常可以找到详细的规范和示例源代码。Wireshark 是一个非常有用的工具,可以帮助您理解它所支持的协议的内部工作原理。

在某些情况下,您甚至可以使用现有库来执行协议的实际解析和解码。如果特定协议有一个许可证足够宽松的 Go 实现,那么您可以使用它来解析和解码单个消息,而不必编写自己的解析器。

在开始之前,请阅读为 Beats 做贡献

克隆和编译编辑

在您安装了 Go 并设置了GOPATH 环境变量以指向您的首选工作区位置后,您可以使用以下命令克隆 Packetbeat

$ mkdir -p ${GOPATH}/src/github.com/elastic
$ cd ${GOPATH}/src/github.com/elastic
$ git clone https://github.com/elastic/beats.git

注意:如果您有多个 go 路径,请使用 ${GOPATH%%:*}` 代替 `${GOPATH}

然后,您可以使用以下命令编译它

$ cd beats
$ make

请注意,您克隆到的位置很重要。如果您希望在 GOPATH 环境之外工作,您可以克隆到另一个目录,并只创建一个指向 $GOPATH/src/github.com/elastic/ 目录的符号链接。

Fork 和分支编辑

我们建议使用以下工作流程为 Packetbeat 做贡献

  • 在 GitHub 中将 Beats fork 到您自己的帐户
  • $GOPATH/src/github.com/elastic/beats 文件夹中,将您的 fork 添加为新的远程仓库。例如(将 tsg 替换为您的 GitHub 帐户)
$ git remote add tsg [email protected]:tsg/beats.git
  • 为您的工作创建一个新分支
$ git checkout -b cool_new_protocol
  • 尽可能频繁地提交,然后使用以下命令推送到您的私有 fork
$ git push --set-upstream tsg cool_new_protocol
  • 当您准备好提交 PR 时,只需从 GitHub 网页界面提交即可。您可以尽早提交您的 PR。您仍然可以在创建 PR 后向分支添加提交。尽早提交 PR 可以让我们有更多时间提供反馈,并可能为您提供帮助。