從一份定義文件詳解ELK中Logstash插件結構

Profile


概述

當下分佈式系統的 日誌收集、日誌分析、日誌處理、可視化 的熱門技術棧方案當然非 ELK(ElasticSearch、Logstash、Kibana)莫屬,從 L → E → K 構成了一條數據的 Pipeline管道:

  • Logstash:與數據源對接,用於收集、過濾處理你的日誌、事務或其他數據
  • ElasticSearch: 是一個開源的,分佈式 RESTful 搜索引擎,在 ELK中可以初略理解爲數據存儲的地方
  • Kibana:將 Elasticsearch 的數據分析並渲染爲可視化的報表,便於高效分析

而且在我的前文《利用 ELK搭建 Docker容器化應用日誌中心》之中,曾利用 ELK 搭建了一條數據管道,用作 Docker容器化應用的日誌中心。

注: 本文原載於 My Personal Blog:CodeSheep · 程序羊



爲什麼先講Logstash

作爲與數據源 “直接對接” 的 Logstash,位置處於 ELK 數據管道的 最前端,其主要作用是 收集、過濾分析、輸出 各種結構化或者非結構化的原始數據(典型的如日誌數據),原始數據從 “無序變有序” 的重擔就落在了Logstash的肩上了,因此其作用舉足輕重。

說到Logstash,不得不說其中的 插件機制,其幾乎所有的功能都是靠插件來實現的,因此靈活易用:

  • 關於 數據收集,Logstash 提供了輸入插件來支持各種不同的數據源
  • 關於 數據分析,Logstash 則提供了過濾器插件來支持對輸入原始數據的花式處理
  • 關於 數據輸出,Logstash 也提供了各種輸出插件,從而支持將結果數據輸出到各種地方,比如標準控制檯,文件,各種數據庫包括 ElasticSearch 等


Logstash的插件管理

Logstash 插件是使用 Ruby開發的,Logstash 從很早的1.5.0+版開始,其插件模塊和核心模塊便分開維護,其插件使用的是 RubyGems包管理器來管理維護。所以 Logstash插件本質上就是自包含的RubyGems。

RubyGems(簡稱 gems)是一個用於對 Ruby組件進行打包的 Ruby 打包系統。 它提供一個分發 Ruby 程序和庫的標準格式,還提供一個管理程序包安裝的工具。

可以在網址 rubygems.org上搜索所有Logstash插件:

rubygems.org

關於插件的常用操作如下:

  • 安裝插件

可以在線安裝:

bin/plugin install [插件名稱]

當然也可以將插件提前下載到本地,然後本地安裝:

bin/plugin install path/logstash-xxx-x.x.x.gem
  • 卸載插件
bin/plugin uninstall [插件名稱]
  • 更新插件
bin/plugin update [插件名稱]

其會將插件更新到最新的版本



Logstash的插件定義語法結構

Logstash 插件的定義其實使用的就是一套其自定義的 DSL語法,我還是習慣用圖來說明吧:

Logstash的插件結構

從圖中可以看出主要包含以下幾大部分內容:

1. 需要的依賴

該部分一般會用require語法引入如下依賴:

require "logstash/XXX/base"
require "logstash/namespace"
  • 前者引入 特定類型插件的依賴
  • 後者引入 模塊命名空間

2. 類定義

需要用 class語法給每一個插件定義一個類,後面我會用實際代碼說明

3. 配置插件名字

通過 config_name 語法來給插件取一個名字,這個名字將會用到 Logstash.conf 配置文件的插件配置之中

4. 配置選項設置

可以使用 config 語法來按需定義任意個配置項。可以設置配置選項的名字、數據類型、默認值以及是否爲必選項:

舉例:

config :percentage, :validate => :number, :default =>100
  • :percentage:定義配置項的名字
  • :validate:配置指定參數的數據類型,如此處爲 number類型
  • :default:指定配置項的默認值
  • :required:用於指定配置項是否必選

5. 插件方法

每一種類型的插件都需要實現一些方法,如下表所示:

插件類型 插件方法
輸入插件 register、 run
過濾器插件 register、 filter
輸出插件 register、 receive
編解碼插件 register、 encode、 decode

Logstash 插件所具備的業務處理功能就來源於上述插件方法業務邏輯實現!

好了,理論部分總結到這,下面結合一份Logstash插件定義的源碼來例析一下!



一份Logstash插件定義文件例析

我們以 Logstash 插件的官網給出的一個 Logstash 過濾器插件 logstash-filter-example 的源碼爲例來進行分析,麻雀雖小,五臟俱全!代碼解析已經標註於圖中,不再贅述。

logstash-filter-example插件源碼

當然此處的實例給出的是一個入門實例,畢竟不可能在一篇篇幅有限的文章裏給出一個太過複雜的 Logstash的插件源碼。對照該源碼和上一節的內容,我想應該不難理解Logstash的插件源碼結構了吧。

計劃後續展示一個 根據具體數據需求 來自定義開發一個滿足特定需求的 Logstash插件的實例。



後記

由於能力有限,若有錯誤或者不當之處,還請大家批評指正,一起學習交流!



發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章