Improved log messages and log levels

Author: niemyjski

packages/core/src/configuration/SettingsManager.ts

@@ -13,17 +13,17 @@ export class SettingsManager {
   private static _isUpdatingSettings: boolean = false;
 
   public static applySavedServerSettings(config: Configuration): void {
-    if (!config || !config.isValid) {
+    if (!config?.isValid) {
       return;
     }
 
     const savedSettings = this.getSavedServerSettings(config);
-    config.services.log.info(`Applying saved settings: v${savedSettings.version}`);
+    config.services.log.trace(`Applying saved settings: v${savedSettings.version}`);
     config.settings = merge(config.settings, savedSettings.settings);
   }
 
   public static getVersion(config: Configuration): number {
-    if (!config || !config.isValid) {
+    if (!config?.isValid) {
       return 0;
     }
 
@@ -42,22 +42,22 @@ export class SettingsManager {
   }
 
   public static async updateSettings(config: Configuration, version?: number): Promise<void> {
-    if (!config || !config.enabled || this._isUpdatingSettings) {
+    if (!config?.enabled || this._isUpdatingSettings) {
       return;
     }
 
     const { log } = config.services;
     const unableToUpdateMessage = "Unable to update settings";
     if (!config.isValid) {
-      log.error(`${unableToUpdateMessage}: ApiKey is not set.`);
+      log.error(`${unableToUpdateMessage}: ApiKey is not set`);
       return;
     }
 
     if (!version || version < 0) {
       version = this.getVersion(config);
     }
 
-    log.info(`Checking for updated settings from: v${version}.`);
+    log.trace(`Checking for updated settings from: v${version}`);
     this._isUpdatingSettings = true;
     const response = await config.services.submissionClient.getSettings(version);
     try {
@@ -66,13 +66,14 @@ export class SettingsManager {
         return;
       }
 
-      const settings = merge(config.settings, response.data.settings);
+      const data = JSON.parse(response.data);
+      const settings = merge(config.settings, data.settings);
 
       // TODO: Store snapshot of settings after reading from config and attributes and use that to revert to defaults.
       // Remove any existing server settings that are not in the new server settings.
       const savedServerSettings = SettingsManager.getSavedServerSettings(config);
       for (const key in savedServerSettings) {
-        if (response.data.settings[key]) {
+        if (data.settings[key]) {
           continue;
         }
 
@@ -81,7 +82,7 @@ export class SettingsManager {
 
       config.settings = settings;
       config.services.storage.settings.save(response.data);
-      log.info(`Updated settings: v${response.data.version}`);
+      log.trace(`Updated settings: v${data.version}`);
     } finally {
       this._isUpdatingSettings = false;
     }

packages/core/src/queue/DefaultEventQueue.ts

@@ -69,11 +69,11 @@ export class DefaultEventQueue implements IEventQueue {
     this.ensureQueueTimer();
 
     const timestamp = config.services.storage.queue.save(event);
-    const logText = `type=${event.type} ${event.reference_id ? "refid=" + event.reference_id : ""}`;
+    const logText = `type=${event.type} ${event.reference_id ? "refid=" + event.reference_id : ""} source=${event.source} message=${event.message}`;
     if (timestamp) {
       log.info(`Enqueuing event: ${timestamp} ${logText}`);
     } else {
-      log.error(`Could not enqueue event ${logText}`);
+      log.error(`Could not enqueue event: ${logText}`);
     }
   }
 
@@ -86,7 +86,7 @@ export class DefaultEventQueue implements IEventQueue {
       return;
     }
 
-    log.info("Processing queue...");
+    log.trace("Processing queue...");
     if (!this.config.enabled) {
       log.info(`Configuration is disabled: ${queueNotProcessed}`);
       return;
@@ -111,7 +111,7 @@ export class DefaultEventQueue implements IEventQueue {
       const response = await this.config.services.submissionClient.submitEvents(events.map((e) => e.value));
       this.processSubmissionResponse(response, events);
       this.eventsPosted(events.map((e) => e.value), response);
-      log.info("Finished processing queue.");
+      log.trace("Finished processing queue.");
       this._processingQueue = false;
     } catch (ex) {
       log.error(`Error processing queue: ${ex}`);
@@ -194,32 +194,28 @@ export class DefaultEventQueue implements IEventQueue {
     const log: ILog = config.services.log; // Optimization for minifier.
 
     if (response.status === 202) {
-      log.info(`Sent ${events.length} events.`);
+      log.info(`Sent ${events.length} events`);
       this.removeEvents(events);
       return;
     }
 
     if (response.status === 429 || response.rateLimitRemaining === 0 || response.status === 503) {
       // You are currently over your rate limit or the servers are under stress.
-      log.error("Server returned service unavailable.");
+      log.error("Server returned service unavailable");
       this.suspendProcessing();
       return;
     }
 
     if (response.status === 402) {
       // If the organization over the rate limit then discard the event.
-      log.info(
-        "Too many events have been submitted, please upgrade your plan.",
-      );
+      log.info("Too many events have been submitted, please upgrade your plan");
       this.suspendProcessing(null, true, true);
       return;
     }
 
     if (response.status === 401 || response.status === 403) {
       // The api key was suspended or could not be authorized.
-      log.info(
-        `Unable to authenticate, please check your configuration. ${noSubmission}`,
-      );
+      log.info(`Unable to authenticate, please check your configuration. ${noSubmission}`);
       this.suspendProcessing(15);
       this.removeEvents(events);
       return;