讀：本文主要討論如何在 Window 環境下構建 Logstash Java Output 插件的方式，并在服務器上安裝和使用。

Gradle 安裝

由于 Logstash 項目都是基于 Gradle 進行管理，所以我們需先在本地安裝Gradle，詳細步驟如下：

1、從 Gradle 官網下載 Gradle，官網提供了 binary-only（編譯后版本） 和 complete（包括doc和源碼） 兩種版本，這里我們選擇 binary-only 版本。

2、將下載下來 Gradle 壓縮包進行解壓

3、配置環境變量

• 新建系統環境 “GRADLE_HOME”，值為 D:\Program Files\gradle\gradle-6.7.1
• 修改path變量，在后面添加 %GRADLE_HOME%\bin;

4、在cmd命令里輸入gradle -v如果能打出版本號，說明環境配置完畢

5、gradle下載的jar包倉庫默認是在 C:\Users\Administrator\.gradle 目錄下，我們可另建一個 D:\.gradle 作為倉庫。

Logstash 編譯生成 logstash-core-x.y.z.jar

由于插件 API 是 Logstash 代碼庫的一部分，依賴于 logstash-core-x.y.z.jar ，所以我們需要拉取 Logstash 項目并進行編譯生成 logstash-core-x.y.z.jar 。

1、Logstash 代碼拉取

// Logstash GitHub 地址，如果拉取速度較慢，可以借助gitee同步github，本地再從gitee拉取
https://github.com/elastic/logstash

2、配置 Gradle

打開IDEA file->setting->Build,Execution,Deployment->Build Tools -> Gradle，兩處地方設置。

3、在項目的根目錄下執行 gradlew assemble 進行編譯，編譯完成之后在 G:\github\logstash\logstash-core\build\libs 目錄下會生成 logstash-core-8.0.0.jar

編譯、構建和安裝 Output 插件

1、拉取 logstash-output-java_output_example，并在 IDEA 中配置好 Gradle、JDK等。

// 官網提供的 logstash-output-java_output_example 地址
https://github.com/logstash-plugins/logstash-output-java_output_example

2、在該項目的根目錄下創建一個 gradle.properties 文件，寫入以下內容（這里的 <target_folder> 替換為 Logstash 項目根目錄路徑）

LOGSTASH_CORE_PATH=<target_folder>/logstash-core 

3、編譯、構建 Output 插件

執行以下命令將Java 插件將被打包為 Ruby gems，根據官方文檔描述：window 中使用 gradlew.bat 代替 ./gradlew。

gradlew.bat gem

如果出現下圖的異常，可參考 paul.devereux 的解決方案：修改 build.gradle 文件 102 行處，增加 ()。

構建成功后在項目根目錄下會生成 gem 文件

4、安裝插件

在部署了 Logstash 的服務器上創建 $LOGSTASH_HOME/plugin 文件夾（$LOGSTASH_HOME 為你所安裝的logstash路徑），將生成的 gem 上傳到該目錄中。之后在 $LOGSTASH_HOME/bin 目錄下執行以下命令安裝插件。

./logstash-plugin install --no-verify --local $LOGSTASH_HOME/plugin/logstash-output-java_output_example-1.0.1.gem

安裝成功后查看插件列表

./logstash-plugin list 

使用插件

// $LOGSTASH_HOME/config/ 目錄下復制模板文件
cp logstash-sample.conf logstash-test.conf
// 編輯
vim  logstash-test.conf

寫入以下內容

input {
  generator { message=> "Hello world!" count=> 10 }
}
output {
  java_output_example {}
}

在bin 目錄執行

./logstash -f  $LOGSTASH_HOME/config/logstash-test.conf

輸出結果

最后

以上便是將官方提供了簡單java-outup插件進行編譯構建和安裝，并使用的流程步驟。基于此，我們可以通過參考官方文檔關于該 demo 的詳細講解，并根據自身實際情況構建出符合需求的插件使用。

// 官網 how to write a Java output plungin 文檔
https://www.elastic.co/guide/en/logstash/7.x/java-output-plugin.html#_package_and_deploy_4

感謝您的閱讀，如果喜歡本文歡迎關注和轉發，本頭條號將堅持持續分享IT技術知識。對于文章內容有其他想法或意見建議等，歡迎提出共同討論共同進步。