Skip to content

Commit

Permalink
Add comments about deadlock risk
Browse files Browse the repository at this point in the history
  • Loading branch information
TonyCTHsu committed Sep 6, 2024
1 parent 80356eb commit 9868ed2
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion lib/datadog/core/telemetry/logger.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,15 @@
module Datadog
module Core
module Telemetry
# Module for sending telemetry logs to the global telemetry instance
# === INTRENAL USAGE ONLY ===
#
# Report telemetry logs via delegating to the telemetry component instance via mutex.
#
# IMPORTANT: Invoking this method during the lifecycle of component initialization will
# cause a non-recoverable deadlock
#
# For developer using this module:
# read: lib/datadog/core/telemetry/logging.rb
module Logger
class << self
def report(exception, level: :error, description: nil)
Expand Down

0 comments on commit 9868ed2

Please sign in to comment.