add per-plugin log level config

Author: ross-weir

ergomatic.example.yaml

@@ -1,6 +1,7 @@
-logLevel: DEBUG
+logLevel: INFO
 plugins:
   - id: example_plugin
+    logLevel: DEBUG # this is optional, will fallback to top-level `logLevel` value if not defined
     enabled: true # defaults to true, can be set to false to disable plugin.
     config:
       tokenId: c7e22029868ecba3d43c385bb42b8a1c96d0114ad5261ec7e0d27a6f24254f92

plugins/example_plugin/mod.ts

@@ -18,7 +18,7 @@ export class ExamplePlugin extends Plugin<ExamplePluginConfig> {
   }
 
   async onStart(): Promise<void> {
-    this.logger.info(
+    this.logger.debug(
       `Example plugin started with config: ${JSON.stringify(this.config)}`,
     );
 

src/config.ts

@@ -1,16 +1,26 @@
 import { z } from "zod/mod.ts";
 import merge from "lodash.merge";
 
+const logLevelSchema = z.enum([
+  "NOTSET",
+  "DEBUG",
+  "INFO",
+  "WARNING",
+  "ERROR",
+  "CRITICAL",
+]);
+
 const pluginConfigEntrySchema = z.object({
   id: z.string(),
+  logLevel: logLevelSchema.optional(),
   enabled: z.boolean().default(true),
   config: z.object({}).optional(),
 });
 
 export type PluginConfigEntry = z.infer<typeof pluginConfigEntrySchema>;
 
 const ergomaticConfigSchema = z.object({
-  logLevel: z.enum(["NOTSET", "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]),
+  logLevel: logLevelSchema,
   node: z.object({
     endpoint: z.string().url(),
   }),

src/ergomatic.ts

@@ -49,7 +49,7 @@ export class Ergomatic extends Component<ErgomaticEvent> {
       return;
     }
 
-    this.logger.debug("Starting Ergomatic");
+    this.logger.info("Starting Ergomatic");
 
     const promises = this.#components.map(async (component) => {
       try {
@@ -73,7 +73,7 @@ export class Ergomatic extends Component<ErgomaticEvent> {
       return;
     }
 
-    this.logger.debug("Stopping Ergomatic");
+    this.logger.info("Stopping Ergomatic");
 
     const promises = this.#components.map(async (component) => {
       try {

src/plugins/plugin_manager.ts

@@ -108,23 +108,27 @@ export class PluginManager extends Component<PluginManagerEvent> {
   }
 
   #createPlugin(
-    config: ErgomaticConfig,
+    ergomaticConfig: ErgomaticConfig,
     pluginEntry: PluginConfigEntry,
   ): Plugin {
-    const pluginCtor = this.#pluginConstructorMap[pluginEntry.id];
+    const { id, logLevel } = pluginEntry;
+    const pluginCtor = this.#pluginConstructorMap[id];
 
     this.logger.debug(
       `Creating plugin from config: ${JSON.stringify(pluginEntry)}`,
     );
 
     if (!pluginCtor) {
-      throw new ErgomaticConfigError(`Unknown plugin ID: '${pluginEntry.id}'`);
+      throw new ErgomaticConfigError(`Unknown plugin ID: '${id}'`);
     }
 
     return new pluginCtor({
       config: pluginEntry.config,
       blockchainProvider: this.#blockchainProvider,
-      logger: createLogger(pluginEntry.id, config.logLevel),
+      logger: createLogger(
+        pluginEntry.id,
+        logLevel ?? ergomaticConfig.logLevel,
+      ),
     });
   }