feat(rpc): SetLogLevel (#1955)

This adds a new rpc call to change the logging level of a running
xud instance.

Closes #835.

Author: sangaman

docs/api.md

@@ -23,6 +23,16 @@ const LevelPriorities = {
   trace: 6,
 };
 
+enum LevelPriority {
+  alert,
+  error,
+  warn,
+  info,
+  verbose,
+  debug,
+  trace,
+}
+
 export enum Context {
   Global = 'GLOBAL',
   DB = 'DB',
@@ -138,6 +148,12 @@ class Logger {
     });
   }
 
+  public setLogLevel = (level: Level) => {
+    this.logger?.transports.forEach((transport) => {
+      transport.level = level;
+    });
+  }
+
   private getLogFormat = (colorize: boolean, dateFormat?: string) => {
     const { format } = winston;
 
@@ -219,4 +235,4 @@ class Logger {
 }
 
 export default Logger;
-export { Level, Loggers };
+export { Level, Loggers, LevelPriority };

lib/Logger.ts

@@ -213,6 +213,13 @@ class Xud extends EventEmitter {
         shutdown: this.beginShutdown,
       });
 
+      this.service.on('logLevel', (level) => {
+        this.swapClientManager?.setLogLevel(level);
+        Object.values(loggers).forEach((logger) => {
+          logger.setLogLevel(level);
+        });
+      });
+
       if (this.swapClientManager.connextClient?.isOperational()) {
         this.httpServer = new HttpServer(loggers.http, this.service);
         await this.httpServer.listen(

lib/Xud.ts

@@ -0,0 +1,29 @@
+import { Arguments, Argv } from 'yargs';
+import { LogLevel, SetLogLevelRequest } from '../../proto/xudrpc_pb';
+import { callback, loadXudClient } from '../command';
+import { LevelPriority } from '../../Logger';
+
+export const command = 'loglevel <level>';
+
+export const describe = 'set the logging level for xud';
+
+export const builder = (argv: Argv) => argv
+  .positional('level', {
+    description: 'the logging level',
+    type: 'string',
+    choices: ['alert', 'error', 'warn', 'verbose', 'info', 'debug', 'trace'],
+    coerce: (logLevelStr: string) => {
+      const logLevelLower = logLevelStr.toLowerCase();
+      return logLevelLower;
+    },
+  })
+  .example('$0 loglevel trace', 'set log level to trace')
+  .example('$0 loglevel info', 'set log level to info');
+
+export const handler = async (argv: Arguments<any>) => {
+  const request = new SetLogLevelRequest();
+  const levelPriority = LevelPriority[argv.level] as unknown as number;
+  const logLevel: LogLevel = levelPriority as LogLevel;
+  request.setLogLevel(logLevel);
+  (await loadXudClient(argv)).setLogLevel(request, callback(argv));
+};

lib/cli/commands/loglevel.ts

@@ -843,6 +843,20 @@ class GrpcService {
     }
   }
 
+  public setLogLevel: grpc.handleUnaryCall<xudrpc.SetLogLevelRequest, xudrpc.SetLogLevelResponse> = async (call, callback) => {
+    if (!this.isReady(this.service, callback)) {
+      return;
+    }
+    try {
+      await this.service.setLogLevel(call.request.toObject());
+
+      const response = new xudrpc.SetLogLevelResponse();
+      callback(null, response);
+    } catch (err) {
+      callback(getGrpcError(err), null);
+    }
+  }
+
   public shutdown: grpc.handleUnaryCall<xudrpc.ShutdownRequest, xudrpc.ShutdownResponse> = (_, callback) => {
     if (!this.isReady(this.service, callback)) {
       return;