Move logging to disk via bunyan
- Logging is available in main process as well as renderer process, and entries all go to one set of rotating files. Log entries in the renderer process go to DevTools as well as the console. Entries from the main process only show up in the console. - We save three days of logs, one day per file in %userData%/logs - The 'debug' object store is deleted in a new database migration - Timestamps and level included in the new log we generate for publish as well as the devtools - The bunyan API is exposed via windows.log (providing the ability to log at different levels, and save objects instead of just text), so we can move our code to it over time. FREEBIEpull/749/head
Scott Nonnenberg
8 years ago
parent
33f5a804fe
commit
6b11f67dc6
@ -0,0 +1,89 @@
|
||||
const path = require('path');
|
||||
const fs = require('fs');
|
||||
|
||||
const electron = require('electron')
|
||||
const bunyan = require('bunyan');
|
||||
const mkdirp = require('mkdirp');
|
||||
const _ = require('lodash');
|
||||
|
||||
|
||||
const app = electron.app;
|
||||
const ipc = electron.ipcMain;
|
||||
const LEVELS = ['fatal', 'error', 'warn', 'info', 'debug', 'trace'];
|
||||
|
||||
let logger;
|
||||
|
||||
|
||||
function dropFirst(args) {
|
||||
return Array.prototype.slice.call(args, 1);
|
||||
}
|
||||
|
||||
function initialize() {
|
||||
if (logger) {
|
||||
throw new Error('Already called initialize!');
|
||||
}
|
||||
|
||||
const basePath = app.getPath('userData');
|
||||
const logPath = path.join(basePath, 'logs');
|
||||
mkdirp.sync(logPath);
|
||||
|
||||
const logFile = path.join(logPath, 'log.log');
|
||||
|
||||
logger = bunyan.createLogger({
|
||||
name: 'log',
|
||||
streams: [{
|
||||
level: 'debug',
|
||||
stream: process.stdout
|
||||
}, {
|
||||
type: 'rotating-file',
|
||||
path: logFile,
|
||||
period: '1d',
|
||||
count: 3
|
||||
}]
|
||||
});
|
||||
|
||||
LEVELS.forEach(function(level) {
|
||||
ipc.on('log-' + level, function() {
|
||||
// first parameter is the event, rest are provided arguments
|
||||
var args = dropFirst(arguments);
|
||||
logger[level].apply(logger, args);
|
||||
});
|
||||
});
|
||||
|
||||
ipc.on('fetch-log', function(event) {
|
||||
event.returnValue = fetch(logPath);
|
||||
});
|
||||
}
|
||||
|
||||
function getLogger() {
|
||||
if (!logger) {
|
||||
throw new Error('Logger hasn\'t been initialized yet!');
|
||||
}
|
||||
|
||||
return logger;
|
||||
}
|
||||
|
||||
function fetch(logPath) {
|
||||
const files = fs.readdirSync(logPath);
|
||||
let contents = '';
|
||||
|
||||
files.forEach(function(file) {
|
||||
contents += fs.readFileSync(path.join(logPath, file), { encoding: 'utf8' });
|
||||
});
|
||||
|
||||
const lines = _.compact(contents.split('\n'));
|
||||
const data = _.compact(lines.map(function(line) {
|
||||
try {
|
||||
return JSON.parse(line);
|
||||
}
|
||||
catch (e) {}
|
||||
}));
|
||||
|
||||
return _.sortBy(data, 'time');
|
||||
}
|
||||
|
||||
|
||||
module.exports = {
|
||||
initialize,
|
||||
getLogger,
|
||||
};
|
||||
@ -1,90 +0,0 @@
|
||||
/*
|
||||
* vim: ts=4:sw=4:expandtab
|
||||
*/
|
||||
(function () {
|
||||
'use strict';
|
||||
|
||||
var LogEntry = Backbone.Model.extend({
|
||||
database: Whisper.Database,
|
||||
storeName: 'debug',
|
||||
printTime: function() {
|
||||
try {
|
||||
return new Date(this.get('time')).toISOString();
|
||||
} catch(e) {
|
||||
return '';
|
||||
}
|
||||
},
|
||||
printValue: function() {
|
||||
return this.get('value') || '';
|
||||
}
|
||||
});
|
||||
|
||||
var DebugLog = Backbone.Collection.extend({
|
||||
database: Whisper.Database,
|
||||
storeName: 'debug',
|
||||
model: LogEntry,
|
||||
comparator: 'time',
|
||||
initialize: function() {
|
||||
this.fetch({remove: false}).then(function() {
|
||||
console.log('Debug log: after fetch have', this.length, 'entries');
|
||||
}.bind(this));
|
||||
},
|
||||
log: function(str) {
|
||||
var entry = this.add({time: Date.now(), value: str});
|
||||
if (window.Whisper.Database.nolog) {
|
||||
entry.save();
|
||||
}
|
||||
|
||||
// Two separate iterations to deal with removal eventing wonkiness
|
||||
var toDrop = this.length - MAX_MESSAGES;
|
||||
var entries = [];
|
||||
for (var i = 0; i < toDrop; i += 1) {
|
||||
entries.push(this.at(i));
|
||||
}
|
||||
this.remove(entries);
|
||||
for (var j = 0, max = entries.length; j < max; j += 1) {
|
||||
entries[j].destroy();
|
||||
}
|
||||
},
|
||||
print: function() {
|
||||
return this.map(function(entry) {
|
||||
return entry.printTime() + ' ' + entry.printValue();
|
||||
}).join('\n');
|
||||
}
|
||||
});
|
||||
|
||||
var MAX_MESSAGES = 2000;
|
||||
var PHONE_REGEX = /\+\d{7,12}(\d{3})/g;
|
||||
var log = new DebugLog();
|
||||
if (window.console) {
|
||||
console._log = console.log;
|
||||
console.log = function() {
|
||||
console._log.apply(this, arguments);
|
||||
var args = Array.prototype.slice.call(arguments);
|
||||
var str = args.join(' ').replace(PHONE_REGEX, "+[REDACTED]$1");
|
||||
log.log(str);
|
||||
};
|
||||
console.get = function() {
|
||||
return window.navigator.userAgent +
|
||||
' node/' + window.config.node_version +
|
||||
'\n' + log.print();
|
||||
};
|
||||
console.post = function(log) {
|
||||
if (log === undefined) {
|
||||
log = console.get();
|
||||
}
|
||||
return new Promise(function(resolve) {
|
||||
$.post('https://api.github.com/gists', textsecure.utils.jsonThing({
|
||||
"files": { "debugLog.txt": { "content": log } }
|
||||
})).then(function(response) {
|
||||
console._log('Posted debug log to ', response.html_url);
|
||||
resolve(response.html_url);
|
||||
}).fail(resolve);
|
||||
});
|
||||
};
|
||||
|
||||
window.onerror = function(message, script, line, col, error) {
|
||||
console.log(error.stack);
|
||||
};
|
||||
}
|
||||
})();
|
||||
@ -0,0 +1,137 @@
|
||||
'use strict';
|
||||
|
||||
const electron = require('electron');
|
||||
const bunyan = require('bunyan');
|
||||
const _ = require('lodash');
|
||||
|
||||
|
||||
const ipc = electron.ipcRenderer;
|
||||
const PHONE_REGEX = /\+\d{7,12}(\d{3})/g;
|
||||
|
||||
// Default Bunyan levels: https://github.com/trentm/node-bunyan#levels
|
||||
// To make it easier to visually scan logs, we make all levels the same length
|
||||
const BLANK_LEVEL = ' ';
|
||||
const LEVELS = {
|
||||
60: 'fatal',
|
||||
50: 'error',
|
||||
40: 'warn ',
|
||||
30: 'info ',
|
||||
20: 'debug',
|
||||
10: 'trace',
|
||||
};
|
||||
|
||||
|
||||
// Backwards-compatible logging, simple strings and no level (defaulted to INFO)
|
||||
|
||||
function now() {
|
||||
const date = new Date();
|
||||
return date.toJSON();
|
||||
}
|
||||
|
||||
function log() {
|
||||
const args = Array.prototype.slice.call(arguments, 0);
|
||||
|
||||
const consoleArgs = ['INFO ', now()].concat(args);
|
||||
console._log.apply(console, consoleArgs);
|
||||
|
||||
const str = args.join(' ').replace(PHONE_REGEX, "+[REDACTED]$1");
|
||||
ipc.send('log-info', str)
|
||||
}
|
||||
|
||||
if (window.console) {
|
||||
console._log = console.log;
|
||||
console.log = log;
|
||||
};
|
||||
|
||||
|
||||
// The mechanics of preparing a log for publish
|
||||
|
||||
function getHeader() {
|
||||
return window.navigator.userAgent + ' node/' + window.config.node_version;
|
||||
}
|
||||
|
||||
function getLevel(level) {
|
||||
var text = LEVELS[level];
|
||||
if (!text) {
|
||||
return BLANK_LEVEL;
|
||||
}
|
||||
|
||||
return text.toUpperCase();
|
||||
}
|
||||
|
||||
function formatLine(entry) {
|
||||
return getLevel(entry.level) + ' ' + entry.time + ' ' + entry.msg;
|
||||
}
|
||||
|
||||
function format(entries) {
|
||||
return entries.map(formatLine).join('\n');
|
||||
}
|
||||
|
||||
function fetch() {
|
||||
return getHeader() + '\n' + format(ipc.sendSync('fetch-log'));
|
||||
};
|
||||
|
||||
function publish(log) {
|
||||
log = log || fetch();
|
||||
|
||||
return new Promise(function(resolve) {
|
||||
const payload = textsecure.utils.jsonThing({
|
||||
files: {
|
||||
'debugLog.txt': {
|
||||
content: log
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
$.post('https://api.github.com/gists', payload)
|
||||
.then(function(response) {
|
||||
console._log('Posted debug log to ', response.html_url);
|
||||
resolve(response.html_url);
|
||||
})
|
||||
.fail(resolve);
|
||||
});
|
||||
};
|
||||
|
||||
|
||||
// A modern logging interface for the browser
|
||||
|
||||
// We create our own stream because we don't want to output JSON to the devtools console.
|
||||
// Anyway, the default process.stdout stream goes to the command-line, not the devtools.
|
||||
const logger = bunyan.createLogger({
|
||||
name: 'log',
|
||||
streams: [{
|
||||
level: 'debug',
|
||||
stream: {
|
||||
write: function(entry) {
|
||||
console._log(formatLine(JSON.parse(entry)));
|
||||
}
|
||||
}
|
||||
}]
|
||||
});
|
||||
|
||||
// The Bunyan API: https://github.com/trentm/node-bunyan#log-method-api
|
||||
function logAtLevel() {
|
||||
const level = arguments[0];
|
||||
const args = Array.prototype.slice.call(arguments, 1);
|
||||
|
||||
const ipcArgs = ['log-' + level].concat(args);
|
||||
ipc.send.apply(ipc, ipcArgs);
|
||||
|
||||
logger[level].apply(logger, args);
|
||||
}
|
||||
|
||||
window.log = {
|
||||
fatal: _.partial(logAtLevel, 'fatal'),
|
||||
error: _.partial(logAtLevel, 'error'),
|
||||
warn: _.partial(logAtLevel, 'warn'),
|
||||
info: _.partial(logAtLevel, 'info'),
|
||||
debug: _.partial(logAtLevel, 'debug'),
|
||||
trace: _.partial(logAtLevel, 'trace'),
|
||||
fetch,
|
||||
publish,
|
||||
}
|
||||
|
||||
window.onerror = function(message, script, line, col, error) {
|
||||
log.error(error.stack);
|
||||
};
|
||||
|
||||
Loading…
Reference in New Issue