Skip to content

ZMS-19: improve gelf logging exception consitency #483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NickOvt merged 2 commits into from
Mar 12, 2026
Merged

ZMS-19: improve gelf logging exception consitency #483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de985e1
ZMS-19: improve gelf logging exception consitency and add levels
NickOvt Feb 27, 2026
07648f9
remove levels, use _error + full_message for critical errors, _failur…
NickOvt Mar 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions app.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ let startSMTPInterfaces = done => {
log.loggelf({
short_message: `${gelfCode('SMTP_START_FAILED')} Could not start SMTP interface`,
full_message: err && err.stack ? err.stack : undefined,
_error: err.message,
_logger: 'SMTP/' + smtpProxy.interface,
_smtp_interface: smtpProxy.interface,
_smtp_key: key,
Expand Down Expand Up @@ -114,6 +115,7 @@ startSMTPInterfaces(err => {
log.loggelf({
short_message: `${gelfCode('QUEUE_SERVER_START_FAILED')} Could not start queue server`,
full_message: err && err.stack ? err.stack : undefined,
_error: err.message,
_logger: 'QS',
_port: config.queueServer && config.queueServer.port,
_host: config.queueServer && (config.queueServer.host || config.queueServer.hostname)
Expand All @@ -130,6 +132,7 @@ startSMTPInterfaces(err => {
log.loggelf({
short_message: `${gelfCode('API_START_FAILED')} Could not start API server`,
full_message: err && err.stack ? err.stack : undefined,
_error: err.message,
_logger: 'API',
_port: config.api && config.api.port,
_host: config.api && (config.api.host || config.api.hostname)
Expand All @@ -149,6 +152,7 @@ startSMTPInterfaces(err => {
log.loggelf({
short_message: `${gelfCode('SETGID_FAILED')} Failed to change group`,
full_message: E && E.stack ? E.stack : undefined,
_error: E.message,
_logger: 'Service',
_group: config.group
});
Expand All @@ -164,6 +168,7 @@ startSMTPInterfaces(err => {
log.loggelf({
short_message: `${gelfCode('SETUID_FAILED')} Failed to change user`,
full_message: E && E.stack ? E.stack : undefined,
_error: E.message,
_logger: 'Service',
_user: config.user
});
Expand All @@ -177,6 +182,7 @@ startSMTPInterfaces(err => {
log.loggelf({
short_message: `${gelfCode('QUEUE_INIT_FAILED')} Could not initialize sending queue`,
full_message: err && err.stack ? err.stack : undefined,
_error: err.message,
_logger: 'Queue'
});
log.error('Queue', err);
Expand Down Expand Up @@ -268,6 +274,7 @@ process.on('uncaughtException', err => {
log.loggelf({
short_message: `${gelfCode('UNCAUGHT_EXCEPTION')} Uncaught exception`,
full_message: err && err.stack ? err.stack : undefined,
_error: err.message,
_logger: 'Process'
});
log.error('Process', err);
Expand Down
4 changes: 2 additions & 2 deletions lib/api-server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,10 +434,10 @@ class APIServer {
log.error('FETCH', '%s LOADFAIL error="%s"', err.message);
emitGelf({
short_message: `${gelfCode('FETCH_LOAD_FAILED')} Failed to load message`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: 'FETCH',
_message_id: req.params.id,
_error: err.message
_failure_msg: err.message
});
res.emit('error', err);
});
Expand Down
4 changes: 2 additions & 2 deletions lib/bounces.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ function reloadBounces() {
log.error('Bounces/' + process.pid, 'Invalid bounce rule regex /%s/ on line %s', parts[0], nr + 1);
emitGelf({
short_message: `${gelfCode('BOUNCE_RULE_REGEX_INVALID')} Invalid bounce rule regex`,
full_message: E && E.stack ? E.stack : undefined,
_stack: E && E.stack ? E.stack : undefined,
_logger: 'Bounces/' + process.pid,
_pattern: parts[0],
_line: nr + 1,
_error: E.message
_failure_msg: E.message
});
}

Expand Down
4 changes: 2 additions & 2 deletions lib/db.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ let getRedisConnection = callback => {
log.error('Redis/' + process.pid, '%s', err.message);
emitGelf({
short_message: `${gelfCode('REDIS_CONNECTION_ERROR')} Redis connection error`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: 'Redis/' + process.pid,
_pid: process.pid,
_error: err.message
_failure_msg: err.message
});
if (!redisReturned) {
redisReturned = true;
Expand Down
8 changes: 4 additions & 4 deletions lib/ip-tools.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ class RedisCache {
log.error(logKey, 'DNSREDISERR SET key=%s error=%s', key, args[0].message);
emitGelf({
short_message: `${gelfCode('DNS_REDIS_SET_FAILED')} Failed to set DNS cache`,
full_message: args[0] && args[0].stack ? args[0].stack : undefined,
_stack: args[0] && args[0].stack ? args[0].stack : undefined,
_logger: logKey,
_key: key,
_error: args[0].message
_failure_msg: args[0].message
});
}
callback(...args);
Expand Down Expand Up @@ -79,10 +79,10 @@ class RedisCache {
log.error(logKey, 'DNSREDISERR GET key=%s error=%s', key, err.message);
emitGelf({
short_message: `${gelfCode('DNS_REDIS_GET_FAILED')} Failed to get DNS cache`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: logKey,
_key: key,
_error: err.message
_failure_msg: err.message
});
// treat errors as a MISS
return callback();
Expand Down
12 changes: 6 additions & 6 deletions lib/mail-drop.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,11 +179,11 @@ class MailDrop {
log.error('Queue/' + process.pid, 'id=%s %s NOQUEUE store "%s" (%s)', envelope.sessionId, id, err.message, messageInfo.format());
emitGelf({
short_message: `${gelfCode('QUEUE_STORE_FAILED')} Failed to store queued message`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: 'Queue/' + process.pid,
_session_id: envelope.sessionId,
_message_id: id,
_error: err.message,
_failure_msg: err.message,
_message_info: messageInfo.format()
});
let keys = messageInfo.keys();
Expand Down Expand Up @@ -219,11 +219,11 @@ class MailDrop {
log.error('Queue/' + process.pid, 'id=%s %s NOQUEUE meta "%s" (%s)', envelope.sessionId, id, err.message, messageInfo.format());
emitGelf({
short_message: `${gelfCode('QUEUE_META_FAILED')} Failed to store queue metadata`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: 'Queue/' + process.pid,
_session_id: envelope.sessionId,
_message_id: id,
_error: err.message,
_failure_msg: err.message,
_message_info: messageInfo.format()
});
let keys = messageInfo.keys();
Expand Down Expand Up @@ -251,11 +251,11 @@ class MailDrop {
log.error('Queue/' + process.pid, 'id=%s %s NOQUEUE push "%s" (%s)', envelope.sessionId, id, err.message, messageInfo.format());
emitGelf({
short_message: `${gelfCode('QUEUE_PUSH_FAILED')} Failed to push message to queue`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: 'Queue/' + process.pid,
_session_id: envelope.sessionId,
_message_id: id,
_error: err.message,
_failure_msg: err.message,
_message_info: messageInfo.format()
});
keys.error = err.message;
Expand Down
28 changes: 14 additions & 14 deletions lib/mail-queue.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -642,12 +642,12 @@ class MailQueue {
log.error('Delete', '%s.%s DELERROR %s', delivery.id, delivery.seq, err.message);
emitGelf({
short_message: `${gelfCode('QUEUE_DELETE_FAILED')} Failed to delete delivery`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: 'Delete',
_delivery_id: delivery.id,
_delivery_seq: delivery.seq,
_zone: delivery.zoneName,
_error: err.message
_failure_msg: err.message
});
} else {
log.info('Delete', '%s.%s DELSUCCESS Delivery entry deleted', delivery.id, delivery.seq);
Expand Down Expand Up @@ -868,11 +868,11 @@ class MailQueue {
log.error('Queue', '%s.%s GET META %s', delivery.id, delivery.seq, err.message);
emitGelf({
short_message: `${gelfCode('QUEUE_META_FETCH_FAILED')} Failed to fetch delivery metadata`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: 'Queue',
_delivery_id: delivery.id,
_delivery_seq: delivery.seq,
_error: err.message
_failure_msg: err.message
});
return callback(null, true);
}
Expand Down Expand Up @@ -905,11 +905,11 @@ class MailQueue {
log.error('Queue', '%s.%s queue:delayed %s', deliveryEntry.id, deliveryEntry.seq, err.message);
emitGelf({
short_message: `${gelfCode('QUEUE_DELAYED_HOOK_FAILED')} queue:delayed hook failed`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: 'Queue',
_delivery_id: deliveryEntry.id,
_delivery_seq: deliveryEntry.seq,
_error: err.message
_failure_msg: err.message
});
}

Expand Down Expand Up @@ -1122,10 +1122,10 @@ class MailQueue {
log.error('GC', '[%ss] %s', timeDiff, err.message);
emitGelf({
short_message: `${gelfCode('QUEUE_GC_FAILED')} Garbage collection failed`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: 'GC',
_duration_s: timeDiff,
_error: err.message
_failure_msg: err.message
});
this.garbageTimer = setTimeout(() => this.checkGarbage(), 5 * 60 * 1000);
this.garbageTimer.unref();
Expand Down Expand Up @@ -1161,9 +1161,9 @@ class MailQueue {
log.error('Queue', 'Error fetching counters: %s', err.message);
emitGelf({
short_message: `${gelfCode('QUEUE_COUNTERS_FAILED')} Failed to fetch queue counters`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: 'Queue',
_error: err.message
_failure_msg: err.message
});
return next();
}
Expand All @@ -1179,9 +1179,9 @@ class MailQueue {
log.error('Queue', 'Error fetching counters: %s', err.message);
emitGelf({
short_message: `${gelfCode('QUEUE_COUNTERS_FAILED')} Failed to fetch queue counters`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: 'Queue',
_error: err.message
_failure_msg: err.message
});
return next();
}
Expand Down Expand Up @@ -1382,12 +1382,12 @@ class MailQueue {
log.error('mongo', 'Failed creating index %s %s. %s', indexpos, JSON.stringify(collection + '.' + index.index.name), err.message);
emitGelf({
short_message: `${gelfCode('QUEUE_INDEX_CREATE_FAILED')} Failed to create MongoDB index`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: 'mongo',
_index_pos: indexpos,
_collection: collection,
_index_name: index.index && index.index.name,
_error: err.message
_failure_msg: err.message
});
} else if (r.numIndexesAfter !== r.numIndexesBefore) {
log.verbose('mongo', 'Created index %s %s', indexpos, JSON.stringify(collection + '.' + index.index.name));
Expand Down
8 changes: 5 additions & 3 deletions lib/receiver/smtp-proxy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,9 @@ class SMTPProxy {
_child_id: childId,
_pid: pid,
_exit_code: code,
_signal: signal
_signal: signal,
full_message: 'Receiver process exited unexpectedly',
_error: 'Receiver process exited unexpectedly'
});

// Respawn after 5 seconds
Expand Down Expand Up @@ -95,10 +97,10 @@ class SMTPProxy {
log.error('SMTP/' + this.name, 'Failed setting up TLS. %s', err.message);
emitGelf({
short_message: `${gelfCode('SMTP_TLS_SETUP_FAILED')} Failed to set up TLS`,
full_message: err && err.stack ? err.stack : undefined,
_stack: err && err.stack ? err.stack : undefined,
_logger: 'SMTP/' + this.name,
_interface: this.name,
_error: err.message
_failure_msg: err.message
});
}
if (tlsSocket) {
Expand Down
Loading