Add doc for get_check_logger (#7536)

Co-authored-by: Julia <[email protected]>
DataDog · Sep 9, 2020 · bb2c1d4 · bb2c1d4
1 parent 153bdfc
commit bb2c1d4
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/datadog_checks_base/datadog_checks/base/log.py b/datadog_checks_base/datadog_checks/base/log.py
@@ -165,6 +165,9 @@ def init_logging():
 def get_check_logger(default_logger=None):
     """
     Search the current AgentCheck log starting from closest stack frame.
+
+    Caveat: Frame lookup has a cost so the recommended usage is to retrieve and store the logger once
+    and avoid calling this method on every check run.
     """
     from datadog_checks.base import AgentCheck