Allow to completely disable logging.

This commit is contained in:
baldo 2021-08-23 21:05:17 +02:00
parent b2e2d93bb0
commit 12a13f47bf
4 changed files with 94 additions and 74 deletions

View file

@ -114,6 +114,8 @@ Dann die `config.json` anpassen nach belieben. Es gibt die folgenden Konfigurati
* **`server.databaseFile`** Pfad zur Datenbank-Datei, z. B.: `"$FFFFNG_HOME/ffffng.sqlite"` * **`server.databaseFile`** Pfad zur Datenbank-Datei, z. B.: `"$FFFFNG_HOME/ffffng.sqlite"`
* **`server.peersPath`** Verzeichnis unter dem die `fastd` Key-Files angelegt werden, z. B.: `"$FFFFNG_HOME/fastdkeys"` * **`server.peersPath`** Verzeichnis unter dem die `fastd` Key-Files angelegt werden, z. B.: `"$FFFFNG_HOME/fastdkeys"`
* **`server.logging.enabled`** Ob geloggt werden soll (Achtung: `false` sorgt dafür, dass überhaupt kein Output mehr auf
`stdout` oder in den Logs erscheint und überschreibt damit alle anderen Logging-Optionen!), z. B.: `false`
* **`server.logging.directory`** Verzeichnis unter dem Log-Files abgelegt werden, z. B.: `"$FFFFNG_HOME/logs"` * **`server.logging.directory`** Verzeichnis unter dem Log-Files abgelegt werden, z. B.: `"$FFFFNG_HOME/logs"`
* **`server.logging.debug`** Gibt an, ob Debug-Output geloggt werden soll (Achtung, viel!), z. B.: `false` * **`server.logging.debug`** Gibt an, ob Debug-Output geloggt werden soll (Achtung, viel!), z. B.: `false`
* **`server.logging.profile`** Gibt an, ob Profiling-Output geloggt werden soll (Achtung, viel!), z. B.: `false` * **`server.logging.profile`** Gibt an, ob Profiling-Output geloggt werden soll (Achtung, viel!), z. B.: `false`

View file

@ -7,6 +7,7 @@
"peersPath": "/tmp/peers", "peersPath": "/tmp/peers",
"logging": { "logging": {
"enabled": true,
"directory": "/tmp/logs", "directory": "/tmp/logs",
"debug": false, "debug": false,
"profile": false, "profile": false,

View file

@ -5,10 +5,24 @@ function procConsole() {
return process.console; return process.console;
} }
function init(): void { const noopTaggedLogger: TaggedLogger = {
debug(...args: any): void {},
info(...args: any): void {},
warn(...args: any): void {},
error(...args: any): void {},
profile(...args: any): void {},
};
class ActivatableLogger implements Logger {
private enabled: boolean = false;
init(): void {
const app = require('./app').app; const app = require('./app').app;
const config = require('./config').config; const config = require('./config').config;
const enabled = config.server.logging.enabled;
this.enabled = enabled;
// Hack to allow proper logging of Error. // Hack to allow proper logging of Error.
Object.defineProperty(Error.prototype, 'message', { Object.defineProperty(Error.prototype, 'message', {
configurable: true, configurable: true,
@ -19,13 +33,12 @@ function init(): void {
enumerable: true enumerable: true
}); });
const scribe = require('scribe-js')({ const scribe = require('scribe-js')({
rootPath: config.server.logging.directory, rootPath: config.server.logging.directory,
}); });
function addLogger(name: string, color: string, active: boolean) { function addLogger(name: string, color: string, active: boolean) {
if (active) { if (enabled && active) {
procConsole().addLogger(name, color, { procConsole().addLogger(name, color, {
logInConsole: false logInConsole: false
}); });
@ -40,7 +53,7 @@ function init(): void {
addLogger('debug', 'grey', config.server.logging.debug); addLogger('debug', 'grey', config.server.logging.debug);
addLogger('profile', 'blue', config.server.logging.profile); addLogger('profile', 'blue', config.server.logging.profile);
if (config.server.logging.logRequests) { if (enabled && config.server.logging.logRequests) {
app.use(scribe.express.logger()); app.use(scribe.express.logger());
} }
if (config.server.internal.active) { if (config.server.internal.active) {
@ -65,13 +78,12 @@ function init(): void {
// @ts-ignore // @ts-ignore
for (const key of Object.keys(procConsole())) { for (const key of Object.keys(procConsole())) {
// @ts-ignore // @ts-ignore
module.exports[key] = procConsole()[key]; module.exports[key] = enabled ? procConsole()[key] : (...args: any) => {};
}
} }
}
const logger: Logger = { tag(...tags: any): TaggedLogger {
init, if (this.enabled) {
tag(...tags): TaggedLogger {
return { return {
debug(...args: any): void { debug(...args: any): void {
procConsole().tag(...tags).debug(...args); procConsole().tag(...tags).debug(...args);
@ -89,6 +101,10 @@ const logger: Logger = {
procConsole().tag(...tags).profile(...args); procConsole().tag(...tags).profile(...args);
}, },
} }
} else {
return noopTaggedLogger;
} }
}; }
export default logger; }
export default new ActivatableLogger() as Logger;

View file

@ -6,6 +6,7 @@ export type Version = string;
export class LoggingConfig { export class LoggingConfig {
constructor( constructor(
@Field("enabled") public enabled: boolean,
@Field("directory") public directory: string, @Field("directory") public directory: string,
@Field("debug") public debug: boolean, @Field("debug") public debug: boolean,
@Field("profile") public profile: boolean, @Field("profile") public profile: boolean,