chore: docs

Author: dreamorosi

packages/logger/src/Logger.ts

@@ -215,8 +215,19 @@ class Logger extends Utility implements LoggerInterface {
    */
   #buffer?: CircularMap<string>;
 
-  #debugLogSampling = {
+  /**
+   * The debug sampling rate configuration.
+   */
+  readonly #debugLogSampling = {
+    /**
+     * The sampling rate value used to determine if the log level should be set to DEBUG.
+     */
     sampleRateValue: 0,
+    /**
+     * The number of times the debug sampling rate has been refreshed.
+     *
+     * We use this to determine if we should refresh it again.
+     */
     refreshedTimes: 0,
   };
 
@@ -569,13 +580,6 @@ class Logger extends Utility implements LoggerInterface {
     }
   }
 
-  #shouldEnableDebugSampling() {
-    return (
-      this.#debugLogSampling.sampleRateValue &&
-      randomInt(0, 100) / 100 <= this.#debugLogSampling.sampleRateValue
-    );
-  }
-
   /**
    * Remove temporary attributes based on provided keys to all log items generated by this Logger instance.
    *
@@ -915,6 +919,16 @@ class Logger extends Utility implements LoggerInterface {
     }
   }
 
+  /**
+   * Make a new debug log sampling decision based on the sample rate value.
+   */
+  #shouldEnableDebugSampling() {
+    return (
+      this.#debugLogSampling.sampleRateValue &&
+      randomInt(0, 100) / 100 <= this.#debugLogSampling.sampleRateValue
+    );
+  }
+
   /**
    * Check if a given key is reserved and warn the user if it is.
    *