您可以向 Logstash 添加自己的输入、编解码器、过滤器或输出插件。
从最终目标入手。这些指南和最佳实践可以帮助您构建更好的插件,即使您选择不与世界分享它。
-
一致性。 您的插件在质量和命名约定方面必须与其他插件保持一致。插件名称必须是唯一的,并且采用以下格式:
logstash-plugintype-pluginname
。如果插件名称包含多个单词,请在插件类型之后用下划线分隔单词。示例:logstash-output-elastic_app_search - 文档。 文档是插件的必要组成部分。如果我们在 Logstash 参考中列出您的插件,我们会指向您的文档——您的插件仓库中的 readme.md、docs/index.asciidoc 或两者都有。
- 代码审查。 您的插件必须由社区成员进行审查,以确保其连贯性、质量、可读性、稳定性和安全性。
-
测试。 您的插件必须包含测试才能被接受。您可以参考 http://betterspecs.org/ 获取示例。
- 第一步:在您的帐户上启用 travis
- 第二步:导入我们的标准 travis.yml https://github.com/logstash-plugins/.ci/blob/1.x/travis/travis.yml,如 指纹过滤器示例 中所示。
- 第三步:在 spec 文件夹中包含 spec 文件。
插件可以独立于 Logstash 核心进行开发和部署。以下是一些文档,可指导您完成插件的编码、部署和共享过程
-
编写新插件
- 编写插件文档
- 将插件发布到 RubyGems.org
- 列出您的插件
-
贡献补丁
您有三个选项可以关闭插件:stop
、stop?
和 close
。
- 从插件线程外部调用
stop
方法。此方法会通知插件停止。 - 当已为该插件调用
stop
方法时,stop?
方法返回true
。 - 插件的
run
方法和插件的线程都退出后,close
方法执行最终的簿记和清理工作。close
方法是 Logstash 早期版本中称为teardown
的方法的新名称。
shutdown
、finished
、finished?
、running?
和 terminating?
方法是冗余的,并且不再存在于 Plugin Base 类中。
插件关闭 API 的示例代码可用。