mirror of
https://github.com/log4js-node/log4js-node.git
synced 2025-12-08 19:26:01 +00:00
refactor: appenders/gelf.js
This commit is contained in:
e-cloud
parent
c80877e6b7
commit
2997fae3fc
@ -1,31 +1,31 @@
|
||||
"use strict";
|
||||
var zlib = require('zlib');
|
||||
var layouts = require('../layouts');
|
||||
var levels = require('../levels');
|
||||
var dgram = require('dgram');
|
||||
var util = require('util');
|
||||
var debug = require('../debug')('GELF Appender');
|
||||
'use strict';
|
||||
const zlib = require('zlib');
|
||||
const layouts = require('../layouts');
|
||||
const levels = require('../levels');
|
||||
const dgram = require('dgram');
|
||||
const OS = require('os');
|
||||
const debug = require('../debug')('GELF Appender');
|
||||
|
||||
var LOG_EMERG = 0; // system is unusable
|
||||
var LOG_ALERT = 1; // action must be taken immediately
|
||||
var LOG_CRIT = 2; // critical conditions
|
||||
var LOG_ERR = 3; // error conditions
|
||||
var LOG_ERROR = 3; // because people WILL typo
|
||||
var LOG_WARNING = 4; // warning conditions
|
||||
var LOG_NOTICE = 5; // normal, but significant, condition
|
||||
var LOG_INFO = 6; // informational message
|
||||
var LOG_DEBUG = 7; // debug-level message
|
||||
/* eslint no-unused-vars:0 */
|
||||
const LOG_EMERG = 0; // system is unusable(unused)
|
||||
const LOG_ALERT = 1; // action must be taken immediately(unused)
|
||||
const LOG_CRIT = 2; // critical conditions
|
||||
const LOG_ERROR = 3; // error conditions
|
||||
const LOG_WARNING = 4; // warning conditions
|
||||
const LOG_NOTICE = 5; // normal, but significant, condition(unused)
|
||||
const LOG_INFO = 6; // informational message
|
||||
const LOG_DEBUG = 7; // debug-level message
|
||||
|
||||
var levelMapping = {};
|
||||
const levelMapping = {};
|
||||
levelMapping[levels.ALL] = LOG_DEBUG;
|
||||
levelMapping[levels.TRACE] = LOG_DEBUG;
|
||||
levelMapping[levels.DEBUG] = LOG_DEBUG;
|
||||
levelMapping[levels.INFO] = LOG_INFO;
|
||||
levelMapping[levels.WARN] = LOG_WARNING;
|
||||
levelMapping[levels.ERROR] = LOG_ERR;
|
||||
levelMapping[levels.ERROR] = LOG_ERROR;
|
||||
levelMapping[levels.FATAL] = LOG_CRIT;
|
||||
|
||||
var client;
|
||||
let client;
|
||||
|
||||
/**
|
||||
* GELF appender that supports sending UDP packets to a GELF compatible server such as Graylog
|
||||
@ -33,12 +33,13 @@ var client;
|
||||
* @param layout a function that takes a logevent and returns a string (defaults to none).
|
||||
* @param host - host to which to send logs (default:localhost)
|
||||
* @param port - port at which to send logs to (default:12201)
|
||||
* @param hostname - hostname of the current host (default:os hostname)
|
||||
* @param hostname - hostname of the current host (default:OS hostname)
|
||||
* @param facility - facility to log to (default:nodejs-server)
|
||||
*/
|
||||
/* jshint maxstatements:21 */
|
||||
/* eslint no-underscore-dangle:0 */
|
||||
function gelfAppender(layout, host, port, hostname, facility) {
|
||||
var config, customFields;
|
||||
let config;
|
||||
let customFields;
|
||||
if (typeof(host) === 'object') {
|
||||
config = host;
|
||||
host = config.host;
|
||||
@ -50,18 +51,18 @@ function gelfAppender(layout, host, port, hostname, facility) {
|
||||
|
||||
host = host || 'localhost';
|
||||
port = port || 12201;
|
||||
hostname = hostname || require('os').hostname();
|
||||
hostname = hostname || OS.hostname();
|
||||
layout = layout || layouts.messagePassThroughLayout;
|
||||
|
||||
var defaultCustomFields = customFields || {};
|
||||
const defaultCustomFields = customFields || {};
|
||||
|
||||
if (facility) {
|
||||
defaultCustomFields._facility = facility;
|
||||
}
|
||||
|
||||
client = dgram.createSocket("udp4");
|
||||
client = dgram.createSocket('udp4');
|
||||
|
||||
process.on('exit', function () {
|
||||
process.on('exit', () => {
|
||||
if (client) client.close();
|
||||
});
|
||||
|
||||
@ -73,26 +74,25 @@ function gelfAppender(layout, host, port, hostname, facility) {
|
||||
* @param msg
|
||||
*/
|
||||
function addCustomFields(loggingEvent, msg) {
|
||||
|
||||
/* append defaultCustomFields firsts */
|
||||
Object.keys(defaultCustomFields).forEach(function (key) {
|
||||
Object.keys(defaultCustomFields).forEach(key => {
|
||||
// skip _id field for graylog2, skip keys not starts with UNDERSCORE
|
||||
if (key.match(/^_/) && key !== "_id") {
|
||||
if (key.match(/^_/) && key !== '_id') {
|
||||
msg[key] = defaultCustomFields[key];
|
||||
}
|
||||
});
|
||||
|
||||
/* append custom fields per message */
|
||||
var data = loggingEvent.data;
|
||||
const data = loggingEvent.data;
|
||||
if (!Array.isArray(data) || data.length === 0) return;
|
||||
var firstData = data[0];
|
||||
const firstData = data[0];
|
||||
|
||||
if (!firstData.GELF) return; // identify with GELF field defined
|
||||
// Remove the GELF key, some gelf supported logging systems drop the message with it
|
||||
delete firstData.GELF;
|
||||
Object.keys(firstData).forEach(function (key) {
|
||||
Object.keys(firstData).forEach(key => {
|
||||
// skip _id field for graylog2, skip keys not starts with UNDERSCORE
|
||||
if (key.match(/^_/) || key !== "_id") {
|
||||
if (key.match(/^_/) || key !== '_id') {
|
||||
msg[key] = firstData[key];
|
||||
}
|
||||
});
|
||||
@ -102,11 +102,11 @@ function gelfAppender(layout, host, port, hostname, facility) {
|
||||
}
|
||||
|
||||
function preparePacket(loggingEvent) {
|
||||
var msg = {};
|
||||
const msg = {};
|
||||
addCustomFields(loggingEvent, msg);
|
||||
msg.short_message = layout(loggingEvent);
|
||||
|
||||
msg.version = "1.1";
|
||||
msg.version = '1.1';
|
||||
msg.timestamp = msg.timestamp || new Date().getTime() / 1000; // log should use millisecond
|
||||
msg.host = hostname;
|
||||
msg.level = levelMapping[loggingEvent.level || levels.DEBUG];
|
||||
@ -117,17 +117,18 @@ function gelfAppender(layout, host, port, hostname, facility) {
|
||||
try {
|
||||
client.send(packet, 0, packet.length, port, host);
|
||||
} catch (e) {
|
||||
// do nothing
|
||||
}
|
||||
}
|
||||
|
||||
return function (loggingEvent) {
|
||||
var message = preparePacket(loggingEvent);
|
||||
zlib.gzip(new Buffer(JSON.stringify(message)), function (err, packet) {
|
||||
return loggingEvent => {
|
||||
const message = preparePacket(loggingEvent);
|
||||
zlib.gzip(new Buffer(JSON.stringify(message)), (err, packet) => {
|
||||
if (err) {
|
||||
console.error(err.stack);
|
||||
} else {
|
||||
if (packet.length > 8192) {
|
||||
debug("Message packet length (" + packet.length + ") is larger than 8k. Not sending");
|
||||
debug(`Message packet length (${packet.length}) is larger than 8k. Not sending`);
|
||||
} else {
|
||||
sendPacket(packet);
|
||||
}
|
||||
@ -137,7 +138,7 @@ function gelfAppender(layout, host, port, hostname, facility) {
|
||||
}
|
||||
|
||||
function configure(config) {
|
||||
var layout;
|
||||
let layout;
|
||||
if (config.layout) {
|
||||
layout = layouts.layout(config.layout.type, config.layout);
|
||||
}
|
||||
@ -151,6 +152,6 @@ function shutdown(cb) {
|
||||
}
|
||||
}
|
||||
|
||||
exports.appender = gelfAppender;
|
||||
exports.configure = configure;
|
||||
exports.shutdown = shutdown;
|
||||
module.exports.appender = gelfAppender;
|
||||
module.exports.configure = configure;
|
||||
module.exports.shutdown = shutdown;
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user