gelf-pro
- Node.js 用の Graylog2 クライアント ライブラリ。
ログを GELF (Graylog Extended Log Format) 形式で Graylog2 サーバーに送信します。
特徴:
"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) があります。関連セクションを参照してください。
GELF UDP
GELF TCP
( Null frame delimiter
付き)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 ;
}
]
} ) ;
transforming
てbroadcasting
れる場合もございます。データを変更することはできNOT
。
log . setConfig ( {
broadcast : [
function ( message ) { // broadcasting to console
console [ message . level > 3 ? 'log' : 'error' ] ( message . short_message , message ) ;
}
]
} ) ;
デフォルト:
{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
マサチューセッツ工科大学