從一份定義文件詳解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插件的實例。



后記

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



最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,333評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,491評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,263評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,946評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,708評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,186評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,255評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,409評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,939評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,774評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,976評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,518評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,209評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,641評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,872評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,650評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,958評論 2 373

推薦閱讀更多精彩內容

  • 這個周末我啥也沒做,在家靜靜地看了S7全球賽半決賽。很難過,全華班RNG2:3不敵SKT,止步四強;WE1:3輸給...
    三葉草青青閱讀 523評論 41 10
  • 來到曲阜,強烈感受到歷史文化的深厚,親眼見到孔廟、孔府,被那一組組具有東方建筑特色、規模宏大、氣勢雄偉的古代建筑群...
    七月風閱讀 542評論 0 7
  • 張壁古堡,號稱“中國星相第一村”,地面布局與天上的二十八星宿相對應,名氣雖遠不如與之毗鄰的平遙古城、王家大...
    一路向陽2021閱讀 540評論 1 0