[DECO-317] Save logs to logPath provided by VSCode (#225)

VS Code provides a `logPath` for storing logs. We should store our full
`logs.json` file over there as well.



https://user-images.githubusercontent.com/88345179/201952782-d82a297c-fb48-4277-876a-3def7014ffde.mov

Author: kartikgupta-db

packages/databricks-vscode/package.json

@@ -55,6 +55,7 @@
         "onCommand:databricks.run.runEditorContentsAsWorkflow",
         "onCommand:databricks.run.runEditorContents",
         "onCommand:databricks.quickstart.open",
+        "onCommand:databricks.logs.openFolder",
         "onView:configurationView",
         "onView:clusterView",
         "onDebugResolve:databricks",
@@ -163,6 +164,11 @@
                 "title": "Show Quickstart",
                 "category": "Databricks"
             },
+            {
+                "command": "databricks.logs.openFolder",
+                "title": "Open full logs",
+                "category": "Databricks"
+            },
             {
                 "command": "databricks.cluster.start",
                 "title": "Start Cluster",

packages/databricks-vscode/src/extension.ts

@@ -15,9 +15,10 @@ import {ProjectConfigFileWatcher} from "./configuration/ProjectConfigFileWatcher
 import {QuickstartCommands} from "./quickstart/QuickstartCommands";
 import {showQuickStartOnFirstUse} from "./quickstart/QuickStart";
 import {PublicApi} from "@databricks/databricks-vscode-types";
-import {initLoggers} from "./logger";
+import {LoggerManager} from "./logger";
 import {UtilsCommands} from "./utils/UtilsCommands";
 import {NamedLogger} from "@databricks/databricks-sdk/dist/logging";
+import {workspaceConfigs} from "./WorkspaceConfigs";
 
 export function activate(context: ExtensionContext): PublicApi | undefined {
     if (
@@ -34,7 +35,19 @@ export function activate(context: ExtensionContext): PublicApi | undefined {
         */
         return undefined;
     }
-    initLoggers(workspace.workspaceFolders[0].uri.path);
+
+    const loggerManager = new LoggerManager(context);
+    if (!workspaceConfigs.loggingEnabled) {
+        loggerManager.initLoggers();
+    }
+
+    context.subscriptions.push(
+        commands.registerCommand(
+            "databricks.logs.openFolder",
+            loggerManager.openLogFolder,
+            loggerManager
+        )
+    );
 
     const cli = new CliWrapper(context);
     // Configuration group

packages/databricks-vscode/src/logger/LoggerManager.ts

@@ -0,0 +1,76 @@
+import {
+    NamedLogger,
+    ExposedLoggers,
+} from "@databricks/databricks-sdk/dist/logging";
+import {env, ExtensionContext, window} from "vscode";
+import {loggers, format, transports} from "winston";
+import {getOutputConsoleTransport} from "./outputConsoleTransport";
+import {unlink, access} from "fs/promises";
+
+export class LoggerManager {
+    constructor(readonly context: ExtensionContext) {}
+
+    private getFileTransport(filename: string) {
+        return new transports.File({
+            format: format.combine(format.timestamp(), format.json()),
+            filename: filename,
+        });
+    }
+
+    async initLoggers() {
+        const outputChannel = window.createOutputChannel("Databricks Logs");
+        const logFile = `${this.context.logUri.path}/logs.json`;
+        try {
+            await access(logFile);
+            await unlink(logFile);
+        } catch (e) {}
+
+        outputChannel.clear();
+
+        NamedLogger.getOrCreate(
+            ExposedLoggers.SDK,
+            {
+                factory: (name) => {
+                    return loggers.add(name, {
+                        level: "debug",
+                        transports: [
+                            getOutputConsoleTransport(outputChannel),
+                            this.getFileTransport(logFile),
+                        ],
+                    });
+                },
+            },
+            true
+        );
+
+        /** 
+        This logger collects all the logs in the extension.
+        
+        TODO Make this logger log to a seperate (or common?) output console in vscode
+        */
+        NamedLogger.getOrCreate(
+            "Extension",
+            {
+                factory: (name) => {
+                    return loggers.add(name, {
+                        level: "error",
+                        transports: [
+                            getOutputConsoleTransport(outputChannel),
+                            this.getFileTransport(logFile),
+                        ],
+                    });
+                },
+            },
+            true
+        );
+    }
+
+    openLogFolder() {
+        env.openExternal(this.context.logUri);
+    }
+}
+
+export enum Loggers {
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    Extension = "Extension",
+}

packages/databricks-vscode/src/logger/index.ts

@@ -1,2 +1,2 @@
-export * from "./loggers";
+export * from "./LoggerManager";
 export * as loggingUtils from "./utils";

packages/databricks-vscode/src/logger/loggers.ts

@@ -1,5 +1,5 @@
 import {NamedLogger} from "@databricks/databricks-sdk/dist/logging";
-import {Loggers} from "./loggers";
+import {Loggers} from "./LoggerManager";
 
 export interface TryAndLogErrorOpts {
     shouldThrow: boolean;