logstash-input-kafka

翁翰墨

2023-12-01

logstash-input-kafka的所有版本见：

https://rubygems.org/gems/logstash-input-kafka/versions

目前最新版本是2.0.2，说明见：

https://rubygems.org/gems/logstash-input-kafka

RUNTIME 依赖关系:

jruby-kafka < 2.0.0, >= 1.2.0 logstash-codec-json >= 0 logstash-codec-plain >= 0 logstash-core < 3.0.0, >= 2.0.0.beta2 stud < 0.1.0, >= 0.0.22

安装说明见：

http://www.rubydoc.info/gems/logstash-input-kafka/2.0.2

Logstash Plugin

Logstash插件

This is a plugin for Logstash.

这是Logstash的一个插件。

It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.

它完全免费，而且开源。许可证是Apache2.0，意味着你可以用你喜欢的方式完全免费地使用它。

Documentation 文档

Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one central location.

Logstash提供了可以自动为此插件生成文档的基础组件。我们使用asciidoc格式写文档，所以任何源代码中的意见会先被转换车程asciidoc格式，然后转换成html格式。所有插件文档被放在一个中心位置。

For formatting code or config example, you can use the asciidoc [source,ruby] directive
对于格式化的代码或配置例子，你可以使用asciidoc指令
For more asciidoc formatting tips, see the excellent reference herehttps://github.com/elastic/docs#asciidoc-guide
想了解更多的asciidoc格式例子，你可以看这里

Need Help?需要帮助？

Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.

可以在IRC（一款聊天工具）或论坛寻找答案。

Developing发展

1. Plugin Developement and Testing

插件发展及测试

Code

代码

To get started, you'll need JRuby with the Bundler gem installed.
想要启动，你需要安装捆绑有gem的JRuby。
Create a new plugin or clone and existing from the GitHub logstash-plugins organization. We also provide example plugins.
产生一个Github的logstash-plugins板块中的新的插件或拷贝，我们提供了插件例子。
Install dependencies sh bundle install
安装依赖sh捆绑安装

Test

测试

Update your dependencies
更新依赖

bundle install

捆绑安装

Run tests
运行例子

bundle exec rspec

捆绑函数簇驱动开发

2. Running your unpublished Plugin in Logstash

在Logstash中运行未公开的插件

2.1 Run in a local Logstash clone

在一个本机Logstash克隆中运行

Edit Logstash Gemfile and add the local plugin path, for example: ruby gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
编辑Logstash的Gemfile,添加本机插件路径，例如，ruby的gem“logstash-filter-awesome”，路径是“/your/local/logstash-filter-awesome”。
Install plugin sh bin/plugin install --no-verify
安装插件 sh bin/plugin install --no-verify
Run Logstash with your plugin sh bin/logstash -e 'filter {awesome {}}' At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
在你的插件中运行Logstash，使用命令：sh bin/logstash -e 'filter {awesome {}}'，此时，任何对于plugn的编辑都会被应用在这个本地Logstash设置中，编辑后，简单地重启Logstash。

2.2 Run in an installed Logstash

在一个安装过的Logstash中运行

You can use the same 2.1 method to run your plugin in an installed Logstash by editing its Gemfile and pointing the :path to your local plugin development directory or you can build the gem and install it using:

你可以使用2.1中的方法来在已安装的Logstash中运行你的插件，通过编辑它的Gemfile和这点：你本地插件发展目录的路径或者按下面的方法生成gem文件并使用它：

Build your plugin gem sh gem build logstash-filter-awesome.gemspec
生成你的插件gem，使用sh gem build logstash-filter-awesome.gemspec
Install the plugin from the Logstash home sh bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
从Logstash目录安装插件，使用sh bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
Start Logstash and proceed to test the plugin
运行Logstash，测试插件。

Contributing

贡献

欢迎提出改正意见

All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.

Programming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here.

It is more important to the community that you are able to contribute.

For more information about contributing, see the CONTRIBUTING file.