node gelf pro

凝膠臨

gelf-pro - Node.js 的 Graylog2 用戶端程式庫.
以 GELF（Graylog 擴充日誌格式）格式將日誌傳送至 Graylog2 伺服器。

特徵：

• JS 物件編組
• UDP/TCP/TLS 支持
• 過濾、轉換、廣播。

安裝

 "dependencies": {
  "gelf-pro": "~1.3" // see the "releases" section
}

npm install gelf-pro （支援所有node.js 版本 [0.x 到 2x.x] :)

函式庫依賴： lodash#~4.17

初始化

 var log = require ( 'gelf-pro' ) ;

適配器

警告

為了確保行為一致，現有適配器都不會重複使用套接字連接。重複使用套接字連接可能會導致資源洩漏、狀態管理複雜性、並發問題、安全風險，並且可能無法始終提供顯著的效能優勢。根據需要建立新連線通常比重複使用現有連線更簡單、更安全，從而確保更好的資源利用率並減少網路通訊中潛在的複雜性。

有多種 (1, 2) 變體可供您借用並建立新的適配器。請參閱相關部分。

• UDP（有緊縮和分塊）
  • 輸入： GELF UDP
• 傳輸控制協定
  • 輸入： GELF TCP （附有Null frame delimiter ）
• 透過 TLS(SSL) 的 TCP
  • 輸入： GELF TCP （有空Null frame delimiter和Enable TLS ）

筆記

在或多或少穩定的網路中（這是最有可能的），我建議使用udp適配器。我也會推薦它用於平均負載到高負載的項目。對於敏感訊息，建議使用tcp-tls適配器。

配置

 // simple
log . setConfig ( { adapterOptions : { host : 'my.glog-server.net' } } ) ;

// advanced
log . setConfig ( {
  fields : { facility : "example" , owner : "Tom (a cat)" } , // optional; default fields for all messages
  filter : [ ] , // optional; filters to discard a message
  transform : [ ] , // optional; transformers for a message
  broadcast : [ ] , // optional; listeners of a message
  levels : { } , // optional; default: see the levels section below
  aliases : { } , // optional; default: see the aliases section below
  adapterName : 'udp' , // optional; currently supported "udp", "tcp" and "tcp-tls"; default: udp
  adapterOptions : { // this object is passed to the adapter.connect() method
    // common
    host : '127.0.0.1' , // optional; default: 127.0.0.1
    port : 12201 , // optional; default: 12201
    // ... and so on
    
    // tcp adapter example
    family : 4 , // tcp only; optional; version of IP stack; default: 4
    timeout : 1000 , // tcp only; optional; default: 10000 (10 sec)
    
    // udp adapter example
    protocol : 'udp4' , // udp only; optional; udp adapter: udp4, udp6; default: udp4
    
    // tcp-tls adapter example
    key : fs . readFileSync ( 'client-key.pem' ) , // tcp-tls only; optional; only if using the client certificate authentication
    cert : fs . readFileSync ( 'client-cert.pem' ) , // tcp-tls only; optional; only if using the client certificate authentication
    ca : [ fs . readFileSync ( 'server-cert.pem' ) ] // tcp-tls only; optional; only for the self-signed certificate
  }
} ) ;

log.setConfig合併資料。因此，您可以多次調用它。

基本功能

 var extra = { tom : 'cat' , jerry : 'mouse' , others : { spike : 1 , tyke : 1 } } ;

log . info ( "Hello world" , extra , function ( err , bytesSent ) { } ) ;
log . info ( "Hello world" , function ( err , bytesSent ) { } ) ;
log . info ( "Hello world" , extra ) ;
log . info ( "Hello world" ) ;

log . error ( 'Oooops.' , new Error ( 'An error message' ) ) ;
// ^-- extra becomes: {short_message: 'Oooops.', _error_message: 'An error message', _error_stack: Error's stack}

log . error ( new Error ( 'An error message' ) ) ;
// ^-- extra becomes: {short_message: 'An error message', full_message: Error's stack}

log . message ( new Error ( 'An error message' ) , 3 ) ; // same as previous 

額外的

如果extra是普通對象，程式庫會將其轉換為可讀格式。其他值轉換為字串。可接受的金鑰格式為： ^[w-]$

 log . info (
  'a new msg goes here' ,
  { me : { fname : 'k' , lname : 'k' , bdate : new Date ( 2000 , 01 , 01 ) } }
) ;
// ^-- extra becomes: {_me_fname: 'k', _me_lname: 'k', _me_bdate: 'Tue Feb 01 2000 00:00:00 GMT+0100 (CET)'} 

濾

有時我們不得不丟棄一條不適合當前環境的訊息。 NOT修改數據。

 log . setConfig ( {
  filter : [
    function ( message ) { // rejects a "debug" message
      return ( message . level < 7 ) ;
    }
  ]
} ) ; 

轉型

transforming發生在filtering之後。可以修改數據。

 log . setConfig ( {
  transform : [
    function ( message ) { // unwind an error
      if ( _ . isError ( message . error ) ) {
        message . error = { message : message . error . message , stack : message . error . stack } ;
      }
      return message ;
    }
  ]
} ) ; 

廣播

broadcasting發生在transforming之後。 NOT修改數據。

 log . setConfig ( {
  broadcast : [
    function ( message ) { // broadcasting to console
      console [ message . level > 3 ? 'log' : 'error' ] ( message . short_message , message ) ;
    }
  ]
} ) ;

級別（1、2、3）

預設:
{emergency: 0, alert: 1, critical: 2, error: 3, warning: 4, notice: 5, info: 6, debug: 7}
例： log.emergency(...) 、 log.critical(...)等。
自訂範例： {alert: 0, notice: 1, ...}

第三方適配器

您可以透過在初始化後立即設定adapter來強制使用自訂適配器。簽名可以在這裡找到。

  var log = require ( 'gelf-pro' ) ;
  var myFancyAdapter = require ( '...' ) ;
  log . adapter = myFancyAdapter ;
  // (!) adapterName and adapterOptions will be ignored

別名

預設值： {log: 'debug', warn: 'warning'}
範例： log.log(...) -> log.debug(...) 、 log.warn(...) -> log.warning(...)等。
自訂範例： {red: 'alert', yellow: 'notice', ...}

測試

克里

npm install
npm test 

碼頭工人

[sudo] docker build --no-cache -t node-gelf-pro .
[sudo] docker run -ti --rm -v " ${PWD} :/opt/app " -w " /opt/app " node-gelf-pro

貢獻者

• 科爾比努
• 喬爾哈克斯
• 姆卡拉姆阿拉米

執照

麻省理工學院