From 9c6509d17ed256756c836644f513c2b0fc15b7e8 Mon Sep 17 00:00:00 2001
From: Eric Bailey <git@esb.lol>
Date: Fri, 28 Feb 2025 11:50:19 -0600
Subject: [PATCH] Clarify types

(cherry picked from commit 422b150deb158a70ef37e8a456d91bf26cd0b1bc)
---
 src/logger/transports/bitdrift.ts | 1 -
 src/logger/transports/sentry.ts   | 1 -
 src/logger/types.ts               | 9 +++++++--
 3 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/src/logger/transports/bitdrift.ts b/src/logger/transports/bitdrift.ts
index e180e9421f..a407f94854 100644
--- a/src/logger/transports/bitdrift.ts
+++ b/src/logger/transports/bitdrift.ts
@@ -18,7 +18,6 @@ export const bitdriftTransport: Transport = (
 ) => {
   const log = logFunctions[level]
   log(message.toString(), {
-    // match Sentry payload
     __context__: context,
     ...prepareMetadata(metadata),
   })
diff --git a/src/logger/transports/sentry.ts b/src/logger/transports/sentry.ts
index 9429e113fb..33dd78ec21 100644
--- a/src/logger/transports/sentry.ts
+++ b/src/logger/transports/sentry.ts
@@ -11,7 +11,6 @@ export const sentryTransport: Transport = (
   timestamp,
 ) => {
   const meta = {
-    // match Bitdrift payload
     __context__: context,
     ...prepareMetadata(metadata),
   }
diff --git a/src/logger/types.ts b/src/logger/types.ts
index 47c7644016..9110a8c6f2 100644
--- a/src/logger/types.ts
+++ b/src/logger/types.ts
@@ -5,11 +5,16 @@
  */
 export enum LogContext {
   Default = 'logger',
-  Metric = 'metric',
   Session = 'session',
   Notifications = 'notifications',
   ConversationAgent = 'conversation-agent',
   DMsAgent = 'dms-agent',
+
+  /**
+   * METRIC IS FOR INTERNAL USE ONLY, don't create any other loggers using this
+   * context
+   */
+  Metric = 'metric',
 }
 
 export enum LogLevel {
@@ -34,7 +39,7 @@ export type Transport = (
  */
 export type Metadata = {
   /**
-   * Reserved for appending `LogContext` to logging payloads
+   * Reserved for appending `LogContext` in logging payloads
    */
   __context__?: undefined