feat: Normalized server logging (#2567)

* feat: Normalize logging

* Remove scattered console.error + Sentry.captureException

* Remove mention of debug

* cleanup dev output

* Edge cases, docs

* Refactor: Move logger, metrics, sentry under 'logging' folder.
Trying to reduce the amount of things under generic 'utils'

* cleanup, last few console calls

server/collaboration/logger.js

@@ -1,22 +1,19 @@
 // @flow
-import debug from "debug";
-
-const log = debug("server");
-
-export default class Logger {
+import Logger from "../logging/logger";
+export default class CollaborationLogger {
   async onCreateDocument(data: { documentName: string }) {
-    log(`Created document "${data.documentName}"`);
+    Logger.info("collaboration", `Created document "${data.documentName}"`);
   }
 
   async onConnect(data: { documentName: string }) {
-    log(`New connection to "${data.documentName}"`);
+    Logger.info("collaboration", `New connection to "${data.documentName}"`);
   }
 
   async onDisconnect(data: { documentName: string }) {
-    log(`Connection to "${data.documentName}" closed`);
+    Logger.info("collaboration", `Connection to "${data.documentName}" closed`);
   }
 
   async onUpgrade() {
-    log("Upgrading connection");
+    Logger.info("collaboration", "Upgrading connection");
   }
 }

server/collaboration/persistence.js

@@ -1,12 +1,11 @@
 // @flow
-import debug from "debug";
 import { debounce } from "lodash";
 import * as Y from "yjs";
 import documentUpdater from "../commands/documentUpdater";
+import Logger from "../logging/logger";
 import { Document, User } from "../models";
 import markdownToYDoc from "./utils/markdownToYDoc";
 
-const log = debug("server");
 const DELAY = 3000;
 
 export default class Persistence {
@@ -30,12 +29,18 @@ export default class Persistence {
 
     if (document.state) {
       const ydoc = new Y.Doc();
-      log(`Document ${documentId} is already in state`);
+      Logger.info(
+        "collaboration",
+        `Document ${documentId} is in database state`
+      );
       Y.applyUpdate(ydoc, document.state);
       return ydoc;
     }
 
-    log(`Document ${documentId} is not in state, creating state from markdown`);
+    Logger.info(
+      "collaboration",
+      `Document ${documentId} is not in state, creating from markdown`
+    );
     const ydoc = markdownToYDoc(document.text, fieldName);
     const state = Y.encodeStateAsUpdate(ydoc);
 
@@ -55,7 +60,7 @@ export default class Persistence {
     }) => {
       const [, documentId] = documentName.split(".");
 
-      log(`persisting ${documentId}`);
+      Logger.info("collaboration", `Persisting ${documentId}`);
 
       await documentUpdater({
         documentId,

server/collaboration/tracing.js

@@ -1,40 +1,40 @@
 // @flow
-import * as metrics from "../utils/metrics";
+import Metrics from "../logging/metrics";
 
 let count = 0;
 
 export default class Tracing {
   async onCreateDocument({ documentName }: { documentName: string }) {
-    metrics.increment("collaboration.create_document", { documentName });
+    Metrics.increment("collaboration.create_document", { documentName });
 
     // TODO: Waiting for `instance` available in payload
-    // metrics.gaugePerInstance(
+    // Metrics.gaugePerInstance(
     //   "collaboration.documents_count",
     //   instance.documents.size()
     // );
   }
 
   async onAuthenticationFailed({ documentName }: { documentName: string }) {
-    metrics.increment("collaboration.authentication_failed", { documentName });
+    Metrics.increment("collaboration.authentication_failed", { documentName });
   }
 
   async onConnect({ documentName }: { documentName: string }) {
-    metrics.increment("collaboration.connect", { documentName });
-    metrics.gaugePerInstance("collaboration.connections_count", ++count);
+    Metrics.increment("collaboration.connect", { documentName });
+    Metrics.gaugePerInstance("collaboration.connections_count", ++count);
   }
 
   async onDisconnect({ documentName }: { documentName: string }) {
-    metrics.increment("collaboration.disconnect", { documentName });
-    metrics.gaugePerInstance("collaboration.connections_count", --count);
+    Metrics.increment("collaboration.disconnect", { documentName });
+    Metrics.gaugePerInstance("collaboration.connections_count", --count);
 
     // TODO: Waiting for `instance` available in payload
-    // metrics.gaugePerInstance(
+    // Metrics.gaugePerInstance(
     //   "collaboration.documents_count",
     //   instance.documents.size()
     // );
   }
 
   async onChange({ documentName }: { documentName: string }) {
-    metrics.increment("collaboration.change", { documentName });
+    Metrics.increment("collaboration.change", { documentName });
   }
 }