如何编写 Logstash 编解码器插件

每个 Logstash 插件都位于其自己的 GitHub 存储库中。要为你的插件创建新的存储库，请执行以下操作

你可以在几秒钟内创建自己的 Logstash 插件！ bin/logstash-plugin 的 generate 子命令使用模板化文件为新的 Logstash 插件创建基础。它创建正确的目录结构、gemspec 文件和依赖项，以便你可以开始添加自定义代码以使用 Logstash 处理数据。

有关更多信息，请参阅 生成插件

或者，你可以使用我们在 github.com 上托管的示例存储库

你的文件结构应如下所示

$ tree logstash-codec-mypluginname
├── Gemfile
├── LICENSE
├── README.md
├── Rakefile
├── lib
│   └── logstash
│       └── codecs
│           └── mypluginname.rb
├── logstash-codec-mypluginname.gemspec
└── spec
    └── codecs
        └── mypluginname_spec.rb

有关 Ruby gem 文件结构以及 Ruby gem 创建过程的出色演练的更多信息，请参阅 http://timelessrepo.com/making-ruby-gems

在我们深入了解细节之前，请在你喜欢的文本编辑器中打开插件文件并查看一下。

require "logstash/codecs/base"
require "logstash/codecs/line"

# Add any asciidoc formatted documentation here
class LogStash::Codecs::Example < LogStash::Codecs::Base

  # This example codec will append a string to the message field
  # of an event, either in the decoding or encoding methods
  #
  # This is only intended to be used as an example.
  #
  # input {
  #   stdin { codec => example }
  # }
  #
  # or
  #
  # output {
  #   stdout { codec => example }
  # }
  config_name "example"

  # Append a string to the message
  config :append, :validate => :string, :default => ', Hello World!'

  public
  def register
    @lines = LogStash::Codecs::Line.new
    @lines.charset = "UTF-8"
  end

  public
  def decode(data)
    @lines.decode(data) do |line|
      replace = { "message" => line["message"].to_s + @append }
      yield LogStash::Event.new(replace)
    end
  end # def decode

  public
  def encode(event)
    @on_event.call(event, event.get("message").to_s + @append + NL)
  end # def encode

end # class LogStash::Codecs::Example

Logstash 编解码器插件需要在 logstash/codecs/base 和 logstash/namespace 中定义的父类

require "logstash/codecs/base"
require "logstash/namespace"

当然，你构建的插件可能依赖于其他代码，甚至 gem。只需将它们与这些 Logstash 依赖项一起放在这里。

编解码器插件类应该是 LogStash::Codecs::Base 的子类

class LogStash::Codecs::Example < LogStash::Codecs::Base

类名称应与插件名称紧密呼应，例如

LogStash::Codecs::Example

  config_name "example"

这是你的插件将在编解码器配置块内调用的名称。

如果你在插件代码中设置 config_name "example"，则相应的 Logstash 配置块应如下所示

  public
  def register
  end # def register

Logstash register 方法类似于 initialize 方法。它最初是为了强制调用 super 而创建的，以防止新手头疼。（注意：为了支持 initialize，它可能会被淘汰，并结合一些强制测试以确保调用 super。）

public 表示该方法可以在任何地方调用，而不仅仅是在类中调用。这是 Ruby 中方法的默认行为，但此处仍明确指定。

你还可以在此处分配实例变量（以 @ 开头的变量）。配置变量现在在作用域中作为实例变量，例如 @message

  public
  def decode(data)
    @lines.decode(data) do |line|
      replace = { "message" => line["message"].to_s + @append }
      yield LogStash::Event.new(replace)
    end
  end # def decode

编解码器的 decode 方法是将来自输入的数据转换为事件的位置。有一些复杂的示例，例如 collectd 编解码器，以及一些简单的示例，例如 spool 编解码器。

必须有一个 yield 语句作为 decode 方法的一部分，该语句会将解码的事件返回到管道。

  public
  def encode(event)
    @on_event.call(event, event.get("message").to_s + @append + NL)
  end # def encode

encode 方法接收一个事件并将其序列化（编码）为另一种格式。 encode 方法的优秀示例包括简单的 plain 编解码器，略微复杂的 msgpack 编解码器，甚至 avro 编解码器。

在大多数情况下，你的 encode 方法应具有 @on_event.call() 语句。此调用将按描述的方式输出每个事件的数据。

Ruby 中的 require 语句用于包含必要的代码。在某些情况下，你的插件可能需要其他文件。例如，collectd 插件 使用 collectd 提供的 types.db 文件。在你的插件的主目录中，有一个名为 vendor.json 的文件，其中描述了这些文件。

vendor.json 文件包含一个 JSON 对象数组，每个 JSON 对象描述一个文件依赖项。此示例来自 collectd 编解码器插件

[{
        "sha1": "a90fe6cc53b76b7bdd56dc57950d90787cb9c96e",
        "url": "http://collectd.org/files/collectd-5.4.0.tar.gz",
        "files": [ "/src/types.db" ]
}]

vendor.json 文件的另一个示例是 geoip 过滤器

下载这些依赖项的过程是调用 rake vendor。这将在本文档的测试部分进一步讨论。

另一种外部依赖项是 jar 文件。这将在“添加 gemspec 文件”部分中描述。

随着插件的演变，某个选项或功能可能不再符合预期用途，开发人员可能希望弃用其使用。弃用会警告用户该选项的状态，这样当它在以后的版本中被移除时，他们就不会感到意外。

Logstash 7.6 引入了一个弃用记录器，以使处理这些情况更容易。您可以使用 适配器来确保您的插件可以使用弃用记录器，同时仍然支持旧版本的 Logstash。有关更多信息和使用适配器的说明，请参阅 readme。

弃用会在 log 目录中的 logstash-deprecation.log 文件中记录。

Gemfile 允许 Ruby 的 Bundler 为您的插件维护依赖项。目前，我们只需要 Logstash gem 进行测试，但如果您需要其他 gem，您应该在此处添加它们。

source 'https://rubygems.org.cn'
gemspec
gem "logstash", :github => "elastic/logstash", :branch => "8.17"

在 gemspec 文件的底部是一个带有注释的部分：Gem dependencies。这是必须提及任何其他所需 gem 的位置。如果一个 gem 是插件运行所必需的，那么它就是一个运行时依赖项。如果一个 gem 仅用于测试，那么它就是一个开发依赖项。

  # Gem dependencies
  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
  s.add_development_dependency 'logstash-devutils'

在某些情况下，例如 Elasticsearch 输出插件，您的代码可能依赖于 jar 文件。在这种情况下，依赖项以这种方式添加到 gemspec 文件中

  # Jar dependencies
  s.requirements << "jar 'org.elasticsearch:elasticsearch', '5.0.0'"
  s.add_runtime_dependency 'jar-dependencies'

在这两者都定义之后，安装过程将在 http://mvnrepository.com 上搜索所需的 jar 文件并下载指定的版本。

您已经具备了所有必要的要素，因此让我们继续运行构建命令

gem build logstash-codec-example.gemspec

就是这样！您的 gem 应该已构建并位于同一路径中，名称为

logstash-codec-mypluginname-0.1.0.gem

来自您的 gemspec 文件的 s.version 数字将提供 gem 版本，在本例中为 0.1.0。

您应该将插件测试安装到 Logstash 的全新安装中。从 Logstash 下载页面下载最新版本。

bin/logstash -e 'input { stdin{ codec => example{}} } output {stdout { codec => rubydebug }}'

示例编解码器插件将附加 append 的内容（默认情况下附加 “, Hello World!”）

启动 Logstash 后，键入一些内容，例如“Random output string”。生成的输出消息字段内容应为“Random output string, Hello World!”

Random output string
{
       "message" => "Random output string, Hello World!",
      "@version" => "1",
    "@timestamp" => "2015-01-27T19:17:18.932Z",
          "host" => "cadenza"
}

随意尝试并通过更改 append 参数来测试此功能

bin/logstash -e 'input { stdin{ codec => example{ append => ", I am appending this! }} } output {stdout { codec => rubydebug }}'

恭喜！您已构建、部署并成功运行了 Logstash 编解码器。

Logstash 及其所有插件均在 Apache 许可证 2.0 版 (“ALv2”) 下获得许可。如果您通过 RubyGems.org 公开发布您的插件，请确保在您的 gemspec 中包含以下行

首先，您需要在 RubyGems.org 上拥有一个帐户

创建帐户后，从 RubyGems.org 获取 API 密钥。默认情况下，RubyGems 使用文件 ~/.gem/credentials 来存储您的 API 密钥。这些凭据将用于发布 gem。将 username 和 password 替换为您在 RubyGems.org 上创建的凭据

curl -u username:password https://rubygems.org.cn/api/v1/api_key.yaml > ~/.gem/credentials
chmod 0600 ~/.gem/credentials

在继续之前，请确保您的 gemspec 文件中具有正确的版本并提交您的更改。

要发布新 logstash gem 的 0.1.0 版本

bundle install
bundle exec rake vendor
bundle exec rspec
bundle exec rake publish_gem

就是这样！您的插件已发布！Logstash 用户现在可以通过运行以下命令来安装您的插件

bin/logstash-plugin install logstash-codec-mypluginname

将您的插件放在 logstash-plugins 存储库中的许多好处包括

要开始将您的插件迁移到 logstash-plugins，只需在 Logstash 存储库中创建一个新的 issue。 当验收指南完成后，我们将使用推荐的 github 流程 来促进迁移到 logstash-plugins 组织。