Add more configuration options for MobileReleaseLogger (#754)

## Summary: - Just adding more configurations options. Issue: XXX-XXXX ## Test plan: Author: jlauzy Reviewers: jeresig, somewhatabstract Required Reviewers: Approved By: jeresig, somewhatabstract Checks: ✅ codecov/project, ✅ Test (macos-latest, 16.x), ✅ CodeQL, ✅ Lint, typecheck, and coverage check (ubuntu-latest, 16.x), ✅ Analyze (javascript), ✅ Prime node_modules cache for primary configuration (ubuntu-latest, 16.x), ✅ gerald, ⏭ dependabot Pull Request URL: #754
Khan · Jun 8, 2023 · 76aaaaf · 76aaaaf
1 parent 7042c11
commit 76aaaaf
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 7 deletions.
diff --git a/.changeset/bright-cars-eat.md b/.changeset/bright-cars-eat.md
@@ -0,0 +1,5 @@
+---
+"@khanacademy/wonder-stuff-ci": minor
+---
+
+Add more configurations to the GCP logger
diff --git a/packages/wonder-stuff-ci/src/__tests__/get-gcp-log-transport.test.ts b/packages/wonder-stuff-ci/src/__tests__/get-gcp-log-transport.test.ts
@@ -8,7 +8,7 @@ describe("#getGCPLogTransport", () => {
             logName: "release-raccoon",
             level: "info",
             redirectToStdout: true,
-            labels: {},
+            labels: {test: "test"},
         });
 
         // Assert

diff --git a/packages/wonder-stuff-ci/src/get-mobile-release-logger.ts b/packages/wonder-stuff-ci/src/get-mobile-release-logger.ts
@@ -7,38 +7,50 @@ import {
 import * as winston from "winston";
 
 import {getGCPLogTransport} from "./get-gcp-log-transport";
+import {GCPLogLevels} from "./types";
 
 let logger: winston.Logger | null = null;
 
 /**
  * Logger for auditing mobile release events.
  * @param {boolean} redirectToStdout If true, logs will be written to stdout.
  * @param {{[key: string]: string}} labels K/V metadata that will be add to the logs
+ * @param {GCPLogLevels} logLevel The log level to send to GCP.
+ * @param {string} logName The name of the log to send logs to in GCP.
+ * @param {string} projectId The GCP project ID to send logs to.
  */
 export const getMobileReleaseLogger = (
     {
         redirectToStdout,
         labels,
+        logLevel,
+        logName,
+        projectId,
     }: {
         redirectToStdout: boolean;
         labels: {[key: string]: string};
+        logLevel: GCPLogLevels;
+        logName: string;
+        projectId: string;
     } = {
         redirectToStdout: false,
         labels: {},
+        logLevel: "info",
+        logName: "release-raccoon",
+        projectId: "mobile-365917",
     },
 ): winston.Logger => {
     if (!logger) {
         logger = createLogger({
             mode: Runtime.Production,
-            level: "info",
+            level: logLevel,
             defaultMetadata: {},
             transport: getGCPLogTransport({
-                // Hardcoded so that the client does not need to know these values
-                projectId: "mobile-365917",
-                logName: "release-raccoon",
-                level: "info",
+                projectId: projectId,
+                logName: logName,
+                level: logLevel,
                 redirectToStdout: redirectToStdout,
-                labels: {},
+                labels: labels,
             }),
         });
         setRootLogger(logger);

diff --git a/packages/wonder-stuff-ci/src/types.ts b/packages/wonder-stuff-ci/src/types.ts
@@ -31,3 +31,5 @@ export type GCPTransportOptions = {
      */
     labels: {[key: string]: string};
 };
+
+export type GCPLogLevels = "debug" | "info" | "warn" | "error";
-Original file line number
+Diff line change
@@ Expand Up / @@ -31,3 +31,5 @@ export type GCPTransportOptions = { @@
          */
         labels: {[key: string]: string};
     };
+    export type GCPLogLevels = "debug" | "info" | "warn" | "error";