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 ;
}
]
} ) ;
broadcasting
transforming
후에 발생합니다. 데이터를 수정할 수 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
MIT