Replaced console.log with sentry's logger

Author: zhiyan114

src/core/YoutubeClient.ts

@@ -5,6 +5,7 @@ import { youtube } from "../config.json";
 import type { DiscordClient } from "./DiscordClient";
 import type { ServiceClient } from "./ServiceClient";
 import type { TextChannel } from "discord.js";
+import { logger } from "@sentry/node-core";
 
 /*
 Example Reference
@@ -79,7 +80,7 @@ export class YoutubeClient extends YouTubeNotifier implements baseClient {
     this.service = service;
     this.dClient = dClient;
     service.express.use(Path, this.listener());
-    console.log(`Current PubSub URL: ${pubsuburl}`);
+    logger.info(`Configured PubSub URL: ${pubsuburl}`);
 
     // Register events
     new YoutubeEvents(this)

src/events/YoutubeEvents.ts

@@ -2,6 +2,7 @@ import type { NotifiedEvent, SubEvent, YoutubeClient } from "../core/YoutubeClie
 import { baseEvent } from "../core/baseEvent";
 import { youtube } from "../config.json";
 import { sendLog } from "../utils/eventLogger";
+import { logger } from "@sentry/node-core";
 
 
 export class YoutubeEvents extends baseEvent {
@@ -31,14 +32,16 @@ export class YoutubeEvents extends baseEvent {
       return;
 
     await this.client.service.redis.set(`youtube:${data.video.id}`, "true", "EX", 43200);
-    console.log(`Video (${data.video.id}) was notified with Publish: ${data.published} and Updated: ${data.updated}`);
+    logger.info(`Published Youtube Video ID: ${data.video.id}`, {
+      publishTime: data.published,
+      updateTime: data.updated
+    });
 
     const rolePing = this.config.pingRoleID !== "0" ? `<@&${this.config.pingRoleID}>` : "";
     this.client.alertChannel?.send({ content: `${rolePing} New Video is out!! Check it out here: ${data.video.link}` });
   }
 
   private async subscribe(data: SubEvent) {
-    console.log("Youtube Notification Service: PubSubHubbub has been Subscribed...");
     await sendLog({
       type: "Info",
       message: "Youtube Notification Service: PubSubHubbub has been Subscribed..."
@@ -56,7 +59,6 @@ export class YoutubeEvents extends baseEvent {
   }
 
   private async unsubscribe() {
-    console.log("Youtube Notification Service: Even has been unsubscribed, resubscribing...");
     await sendLog({
       type: "Warning",
       message: "Youtube Notification Service: Even has been unsubscribed, resubscribing..."

src/events/redisEvents.ts

@@ -1,6 +1,6 @@
 // Worked on after logger is added...
 
-import { captureException } from "@sentry/node-core";
+import { captureException, logger } from "@sentry/node-core";
 import { sendLog } from "../utils/eventLogger";
 import type Redis from "ioredis";
 
@@ -40,7 +40,7 @@ export class RedisEvents {
     this.alreadyReconWarned = false;
     this.errCount = 0;
 
-    console.log("Redis Connected");
+    logger.info("Redis Connected");
     sendLog({
       type: "Info",
       message: "Redis: Connection Established"
@@ -53,7 +53,7 @@ export class RedisEvents {
     if(this.alreadyReconWarned)
       return;
 
-    console.log("Redis reconnecting...");
+    logger.debug("Redis reconnecting...");
     sendLog({
       type: "Warning",
       message: "Redis: Connection Issue, Reconnecting..."

src/index.ts

@@ -1,5 +1,5 @@
 import { DiscordClient } from "./core/DiscordClient";
-import { flush } from "@sentry/node-core";
+import { logger, close } from "@sentry/node-core";
 import { sendLog } from "./utils/eventLogger";
 import { TwitchClient } from "./core/TwitchClient";
 import { YoutubeClient } from "./core/YoutubeClient";
@@ -25,7 +25,7 @@ const YoutubeCli = new YoutubeClient(svcClient, CoreClient);
 (async ()=>{
   await svcClient.start();
   await CoreClient.start(process.env["BOTTOKEN"]!);
-  console.log("Bot started");
+  logger.info("Bot started");
   await TwitchCli.start();
   CoreClient.setTwitchClient(TwitchCli);
   await YoutubeCli.start();
@@ -43,13 +43,12 @@ async function quitSignalHandler() {
     type: "Info",
     message: "Shutdown Initiated... View logs for shutdown completion."
   });
-  console.log("Shutdown Initiated...");
 
   // Perform cleanup
   await CoreClient.dispose();
   await TwitchCli.dispose();
   await TwitchCli.dispose();
-  await flush(15000);
+  await close(15000);
 
   // Complete the shutdown
   console.log("Shutdown Complete!");

src/loader.ts

@@ -1,11 +1,11 @@
 import type { Breadcrumb, ErrorEvent, EventHint, StackFrame } from "@sentry/node-core";
+import type { Log } from "@sentry/core";
 import { relative } from "path";
 import { DiscordAPIError, DiscordjsError } from "discord.js";
 import { APIErrors } from "./utils/discordErrorCode";
 import { Prisma } from "@prisma/client";
 import { errors } from 'undici';
 import {
-  consoleLoggingIntegration,
   extraErrorDataIntegration,
   rewriteFramesIntegration,
   SentryContextManager,
@@ -35,6 +35,7 @@ const cli = sentryInit({
 
   beforeBreadcrumb,
   beforeSend,
+  beforeSendLog,
   beforeSendTransaction: () => null,
 
   ignoreErrors: [
@@ -50,9 +51,6 @@ const cli = sentryInit({
   ],
 
   integrations: [
-    consoleLoggingIntegration({
-      levels: ["error", "warn", "log"],
-    }),
     extraErrorDataIntegration({
       depth: 5
     }),
@@ -116,6 +114,11 @@ function frameStackIteratee(frame: StackFrame) {
   return frame;
 }
 
+function beforeSendLog(log: Log) {
+  console.log(`[${log.level}]: ${log.message}`);
+  return log;
+}
+
 
 // OpenTelemetry Loader
 if(cli) {

src/utils/eventLogger.ts

@@ -22,7 +22,6 @@ export async function initialize(channel: Channel) {
       type: "Error",
       message: "System attempted to initialize log service twice"
     });
-    return console.log("Log channel already initialized!");
   }
   if(!(channel instanceof TextChannel))
     throw new Error("[Logger]: Attempted to initialize log channel with a non-text channel");
@@ -37,7 +36,7 @@ export async function initialize(channel: Channel) {
 export async function sendLog(log: LogData) {
   // Queue the log if the channel is not initialized
   if(!_channel) {
-    console.debug(`Log added to pre-initialization queue: ${log.message}`);
+    logger.debug(`Log added to pre-initialization queue: ${log.message}`);
     _logQueues.push(log);
     return;
   }