› ›

如何编写 Java 编解码器插件

Java 编解码器目前仅支持 Java 输入和输出插件。它们不适用于 Ruby 输入或输出插件。

要为 Logstash 开发新的 Java 编解码器，你需要编写一个新的 Java 类，该类符合 Logstash Java 编解码器 API，将其打包，并使用 logstash-plugin 实用程序进行安装。我们将逐步介绍这些步骤。

设置你的环境

复制示例存储库

首先复制示例编解码器插件。该插件 API 目前是 Logstash 代码库的一部分，因此你必须拥有该代码库的本地副本。你可以使用以下 git 命令获取 Logstash 代码库的副本

git clone --branch <branch_name> --single-branch https://github.com/elastic/logstash.git <target_folder>

branch_name 应与包含 Java 插件 API 首选版本的 Logstash 版本相对应。

Java 插件 API 的 GA 版本在 Logstash 代码库的 7.2 及更高版本的分支中可用。

为你的 Logstash 代码库本地副本指定 target_folder。如果你未指定 target_folder，则默认为你当前文件夹下的一个名为 logstash 的新文件夹。

生成 .jar 文件

在你获得适当版本的 Logstash 代码库的副本后，你需要对其进行编译以生成包含 Java 插件 API 的 .jar 文件。从你的 Logstash 代码库的根目录 ($LS_HOME) 中，你可以使用 ./gradlew assemble（如果你在 Windows 上运行，则使用 gradlew.bat assemble）进行编译。这应该会生成 $LS_HOME/logstash-core/build/libs/logstash-core-x.y.z.jar，其中 x、y 和 z 指的是 Logstash 的版本。

成功编译 Logstash 后，你需要告知你的 Java 插件在哪里可以找到 logstash-core-x.y.z.jar 文件。在你的插件项目的根文件夹中创建一个名为 gradle.properties 的新文件。该文件应包含一行

LOGSTASH_CORE_PATH=<target_folder>/logstash-core

其中 target_folder 是你的 Logstash 代码库本地副本的根文件夹。

编写插件代码

示例编解码器插件会解码由可配置分隔符分隔的消息，并通过写入其由分隔符分隔的字符串表示形式来编码消息。例如，如果编解码器配置为使用 / 作为分隔符，则输入文本 event1/event2/ 将被解码为两个单独的事件，其 message 字段分别为 event1 和 event2。请注意，这只是一个示例编解码器，不涵盖生产级编解码器应涵盖的所有边缘情况。

让我们看一下该编解码器过滤器中的主类

@LogstashPlugin(name="java_codec_example")
public class JavaCodecExample implements Codec {

    public static final PluginConfigSpec<String> DELIMITER_CONFIG =
            PluginConfigSpec.stringSetting("delimiter", ",");

    private final String id;
    private final String delimiter;

    public JavaCodecExample(final Configuration config, final Context context) {
        this(config.get(DELIMITER_CONFIG));
    }

    private JavaCodecExample(String delimiter) {
        this.id = UUID.randomUUID().toString();
        this.delimiter = delimiter;
    }

    @Override
    public void decode(ByteBuffer byteBuffer, Consumer<Map<String, Object>> consumer) {
        // a not-production-grade delimiter decoder
        byte[] byteInput = new byte[byteBuffer.remaining()];
        byteBuffer.get(byteInput);
        if (byteInput.length > 0) {
            String input = new String(byteInput);
            String[] split = input.split(delimiter);
            for (String s : split) {
                Map<String, Object> map = new HashMap<>();
                map.put("message", s);
                consumer.accept(map);
            }
        }
    }

    @Override
    public void flush(ByteBuffer byteBuffer, Consumer<Map<String, Object>> consumer) {
        // if the codec maintains any internal state such as partially-decoded input, this
        // method should flush that state along with any additional input supplied in
        // the ByteBuffer

        decode(byteBuffer, consumer); // this is a simplistic implementation
    }

    @Override
    public void encode(Event event, OutputStream outputStream) throws IOException {
        outputStream.write((event.toString() + delimiter).getBytes(Charset.defaultCharset()));
    }

    @Override
    public Collection<PluginConfigSpec<?>> configSchema() {
        // should return a list of all configuration options for this plugin
        return Collections.singletonList(DELIMITER_CONFIG);
    }

    @Override
    public Codec cloneCodec() {
        return new JavaCodecExample(this.delimiter);
    }

    @Override
    public String getId() {
        return this.id;
    }

}

让我们逐步检查该类的每个部分。

类声明

@LogstashPlugin(name="java_codec_example")
public class JavaCodecExample implements Codec {

关于类声明的注意事项

所有 Java 插件都必须使用 @LogstashPlugin 注释进行注释。此外
- 必须提供注释的 name 属性，并定义插件在 Logstash 管道定义中使用的名称。例如，此编解码器将在 Logstash 管道定义的适当输入或输出的编解码器部分中引用，例如 codec => java_codec_example { }
- name 属性的值必须与类的名称匹配，不包括大小写和下划线。
该类必须实现 co.elastic.logstash.api.Codec 接口。
Java 插件可能不会在 org.logstash 或 co.elastic.logstash 包中创建，以防止与 Logstash 本身的类发生潜在的冲突。

插件设置

以下代码段包含设置定义和引用该设置的方法

public static final PluginConfigSpec<String> DELIMITER_CONFIG =
        PluginConfigSpec.stringSetting("delimiter", ",");

@Override
public Collection<PluginConfigSpec<?>> configSchema() {
    return Collections.singletonList(DELIMITER_CONFIG);
}

PluginConfigSpec 类允许开发人员指定插件支持的设置，包括设置名称、数据类型、弃用状态、必需状态和默认值。在此示例中，delimiter 设置定义了编解码器将拆分事件的分隔符。这不是必需的设置，如果未显式设置，则其默认值将为 ,。

configSchema 方法必须返回插件支持的所有设置的列表。Logstash 执行引擎将验证所有必需的设置是否存在，并且不存在不受支持的设置。

构造函数和初始化

private final String id;
private final String delimiter;

public JavaCodecExample(final Configuration config, final Context context) {
    this(config.get(DELIMITER_CONFIG));
}

private JavaCodecExample(String delimiter) {
    this.id = UUID.randomUUID().toString();
    this.delimiter = delimiter;
}

所有 Java 编解码器插件都必须具有一个采用 Configuration 和 Context 参数的构造函数。这是将在运行时用于实例化它们的构造函数。所有插件设置的检索和验证应在此构造函数中进行。在此示例中，用于分隔事件的分隔符是从其设置中检索的，并存储在本地变量中，以便以后可以在 decode 和 encode 方法中使用。编解码器的 ID 初始化为随机 UUID（大多数编解码器都应如此），并且本地 encoder 变量初始化为使用指定的字符集进行编码和解码。

任何其他初始化也可能在构造函数中进行。如果在编解码器插件的配置或初始化中遇到任何无法恢复的错误，则应抛出一个描述性异常。该异常将被记录下来，并会阻止 Logstash 启动。

编解码器方法

@Override
public void decode(ByteBuffer byteBuffer, Consumer<Map<String, Object>> consumer) {
    // a not-production-grade delimiter decoder
    byte[] byteInput = new byte[byteBuffer.remaining()];
    byteBuffer.get(byteInput);
    if (byteInput.length > 0) {
        String input = new String(byteInput);
        String[] split = input.split(delimiter);
        for (String s : split) {
            Map<String, Object> map = new HashMap<>();
            map.put("message", s);
            consumer.accept(map);
        }
    }
}

@Override
public void flush(ByteBuffer byteBuffer, Consumer<Map<String, Object>> consumer) {
    // if the codec maintains any internal state such as partially-decoded input, this
    // method should flush that state along with any additional input supplied in
    // the ByteBuffer

    decode(byteBuffer, consumer); // this is a simplistic implementation
}

@Override
public void encode(Event event, OutputStream outputStream) throws IOException {
    outputStream.write((event.toString() + delimiter).getBytes(Charset.defaultCharset()));
}

decode、flush 和 encode 方法提供了编解码器的核心功能。编解码器可以由输入使用，以将字节序列或流解码为事件，也可以由输出使用，以将事件编码为字节序列。

decode 方法从指定的 ByteBuffer 解码事件，并将其传递给提供的 Consumer。输入必须提供一个 ByteBuffer，该缓冲区已准备好进行读取，其中 byteBuffer.position() 指示要读取的下一个位置，byteBuffer.limit() 指示缓冲区中第一个不安全读取的字节。编解码器必须确保 byteBuffer.position() 反映在将控制权返回给输入之前的最后读取位置。然后，输入负责通过 byteBuffer.clear() 或 byteBuffer.compact() 将缓冲区返回到写入模式，然后再恢复写入。在上面的示例中，decode 方法仅按指定的分隔符拆分传入的字节流。生产级编解码器（如java-line）不会做出简化假设，即所提供的字节流的末尾与事件的末尾相对应。

事件应构造为 Map<String, Object> 的实例，并通过 Consumer<Map<String, Object>>.accept() 方法推送到事件管道中。为了减少分配和 GC 压力，编解码器可以通过在调用 Consumer<Map<String, Object>>.accept() 之间修改其字段来重用同一映射实例，因为事件管道将基于映射数据的副本创建事件。

flush 方法与 decode 方法协调工作，以从指定的 ByteBuffer 解码所有剩余事件，以及在先前调用 decode 方法后可能保留的任何内部状态。作为编解码器可能维护的内部状态的示例，请考虑字节输入流 event1/event2/event3，其分隔符为 /。由于缓冲或其他原因，输入可能会向编解码器的 decode 方法提供部分字节流，例如 event1/eve。在这种情况下，编解码器可以保存第二个事件的前三个字符 eve，而不是假设所提供的字节流在事件边界上结束。如果下次调用 decode 提供了 nt2/ev 字节，则编解码器会将保存的 eve 字节添加到前面，以生成完整的 event2 事件，然后保存剩余的 ev 字节，以便在提供该事件的剩余字节时进行解码。调用 flush 会向编解码器发出信号，指示提供的字节表示事件流的结尾，应将所有剩余字节解码为事件。上面的 flush 示例是一个简单的实现，它不维护有关跨调用 decode 的部分提供的字节流的任何状态。

encode 方法将事件编码为字节序列，并将其写入指定的 OutputStream。由于单个编解码器实例在 Logstash 管道的输出阶段中的所有管道工作线程之间共享，因此编解码器不应在对其 encode 方法的调用中保留状态。

cloneCodec 方法

@Override
public Codec cloneCodec() {
    return new JavaCodecExample(this.delimiter);
}

cloneCodec 方法应返回一个与原始编解码器相同的实例，但 ID 除外。由于编解码器在调用其 decode 方法时可能会保持状态，因此多线程的输入插件应通过 cloneCodec 方法为每个线程使用单独的编解码器实例。由于单个编解码器实例在 Logstash 管道的输出阶段的所有管道工作器之间共享，因此编解码器在调用其 encode 方法时不应保持状态。在上面的示例中，克隆的编解码器具有相同的分隔符，但 ID 不同。

getId 方法

@Override
public String getId() {
    return id;
}

对于编解码器插件，getId 方法应始终返回实例化时设置的 ID。这通常是一个 UUID。

单元测试

最后但同样重要的是，强烈建议进行单元测试。示例编解码器插件包含一个示例单元测试，您可以将其用作自己的模板。

打包和部署

Java 插件打包为 Ruby gem，用于依赖项管理以及与 Ruby 插件的互操作性。一旦它们被打包为 gem，就可以像 Ruby 插件一样使用 logstash-plugin 实用程序进行安装。由于 Java 插件开发不应需要 Ruby 或其工具链的任何知识，因此将 Java 插件打包为 Ruby gem 的过程已通过示例 Java 插件提供的 Gradle 构建文件中的自定义任务实现自动化。以下部分描述了如何配置和执行该打包任务，以及如何在 Logstash 中安装打包的 Java 插件。

配置 Gradle 打包任务

以下部分出现在示例 Java 插件提供的 build.gradle 文件顶部附近

// ===========================================================================
// plugin info
// ===========================================================================
group                      'org.logstashplugins' // must match the package of the main plugin class
version                    "${file("VERSION").text.trim()}" // read from required VERSION file
description                = "Example Java filter implementation"
pluginInfo.licenses        = ['Apache-2.0'] // list of SPDX license IDs
pluginInfo.longDescription = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using \$LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
pluginInfo.authors         = ['Elasticsearch']
pluginInfo.email           = ['[email protected]']
pluginInfo.homepage        = "https://elastic.ac.cn/guide/en/logstash/current/index.html"
pluginInfo.pluginType      = "filter"
pluginInfo.pluginClass     = "JavaFilterExample"
pluginInfo.pluginName      = "java_filter_example"
// ===========================================================================

您应该为您的插件配置上述值。

version 值将自动从插件代码库根目录中的 VERSION 文件中读取。
pluginInfo.pluginType 应设置为 input、filter、codec 或 output 之一。
pluginInfo.pluginName 必须与主插件类上 @LogstashPlugin 注释中指定的名称匹配。Gradle 打包任务将验证这一点，如果它们不匹配，则返回错误。

运行 Gradle 打包任务

要将插件打包为 Ruby gem，需要多个 Ruby 源文件以及 gemspec 文件和 Gemfile。这些 Ruby 文件仅用于定义 Ruby gem 结构或在 Logstash 启动时注册 Java 插件。它们在运行时事件处理期间不使用。Gradle 打包任务会根据上一节中配置的值自动生成所有这些文件。

您可以使用以下命令运行 Gradle 打包任务

./gradlew gem

对于 Windows 平台：请在命令中将 ./gradlew 替换为 gradlew.bat（如适用）。

该任务将在插件代码库的根目录中生成一个 gem 文件，名称为 logstash-{plugintype}-<pluginName>-<version>.gem

在 Logstash 中安装 Java 插件

将 Java 插件打包为 Ruby gem 后，可以使用以下命令在 Logstash 中安装它

bin/logstash-plugin install --no-verify --local /path/to/javaPlugin.gem

对于 Windows 平台：请在命令中将正斜杠替换为反斜杠（如适用）。

使用 Java 编解码器插件运行 Logstash

要测试该插件，请使用以下命令启动 Logstash

echo "foo,bar" | bin/logstash -e 'input { java_stdin { codec => java_codec_example } }'

使用上述配置，预期的 Logstash 输出（不包括初始化）是

{
      "@version" => "1",
       "message" => "foo",
    "@timestamp" => yyyy-MM-ddThh:mm:ss.SSSZ,
          "host" => "<yourHostName>"
}
{
      "@version" => "1",
       "message" => "bar\n",
    "@timestamp" => yyyy-MM-ddThh:mm:ss.SSSZ,
          "host" => "<yourHostName>"
}

反馈

如果您对 Logstash 中的 Java 插件支持有任何反馈，请在我们的主要 Github 问题上评论，或在 Logstash 论坛中发帖。

« 如何编写 Java 输入插件如何编写 Java 过滤器插件 »