gelf-pro
- biblioteca cliente Graylog2 para Node.js.
Envia logs para o servidor Graylog2 no formato GELF (Graylog Extended Log Format).
Características:
"dependencies": {
"gelf-pro": "~1.3" // see the "releases" section
}
npm install gelf-pro
( TODAS as versões node.js são suportadas [0.x a 2x.x] :)
Biblioteca depende de: lodash#~4.17
var log = require ( 'gelf-pro' ) ;
Aviso
Para garantir um comportamento consistente, nenhum dos adaptadores existentes reutiliza a conexão de soquete . A reutilização de conexões de soquete pode levar ao vazamento de recursos, à complexidade no gerenciamento de estado, a problemas de simultaneidade, a riscos de segurança e nem sempre pode fornecer benefícios significativos de desempenho. Muitas vezes é mais simples e seguro estabelecer novas conexões conforme necessário, em vez de reutilizar as existentes, garantindo uma melhor utilização dos recursos e reduzindo possíveis complicações na comunicação em rede.
Existem diversas (1, 2) variantes disponíveis para você emprestar e criar um novo adaptador. Consulte a seção relacionada.
GELF UDP
GELF TCP
(com Null frame delimiter
)GELF TCP
(com Null frame delimiter
e Enable TLS
) Observação
Dentro de uma rede mais ou menos estável (o que é mais provável), eu recomendaria usar o adaptador udp
. Eu também o recomendaria para um projeto de média a alta carga. Para informações confidenciais, o adaptador tcp-tls
é recomendado.
// 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
mescla os dados. Portanto, você pode chamá-lo várias vezes.
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
Caso extra
seja um objeto simples, a biblioteca o converte para um formato legível. Outros valores são convertidos em string. O formato aceitável de uma chave é: ^[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)'}
Às vezes temos que descartar uma mensagem que não é adequada ao ambiente atual. NOT
é possível modificar os dados.
log . setConfig ( {
filter : [
function ( message ) { // rejects a "debug" message
return ( message . level < 7 ) ;
}
]
} ) ;
transforming
acontece após filtering
. É possível modificar os dados.
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
acontece após transforming
. NOT
é possível modificar os dados.
log . setConfig ( {
broadcast : [
function ( message ) { // broadcasting to console
console [ message . level > 3 ? 'log' : 'error' ] ( message . short_message , message ) ;
}
]
} ) ;
Padrão:
{emergency: 0, alert: 1, critical: 2, error: 3, warning: 4, notice: 5, info: 6, debug: 7}
Exemplo: log.emergency(...)
, log.critical(...)
, etc.
Exemplo personalizado: {alert: 0, notice: 1, ...}
Você pode forçar o uso do adaptador personalizado configurando o adapter
logo após a inicialização. A assinatura pode ser encontrada aqui.
var log = require ( 'gelf-pro' ) ;
var myFancyAdapter = require ( '...' ) ;
log . adapter = myFancyAdapter ;
// (!) adapterName and adapterOptions will be ignored
Padrão: {log: 'debug', warn: 'warning'}
Exemplo: log.log(...) -> log.debug(...)
, log.warn(...) -> log.warning(...)
, etc.
Exemplo personalizado: {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