Merge pull request #2098 from gevent/issue2070

jamadden · web-flow · commit 892be4c90d9b · 2025-04-17T05:23:08.000-05:00
Add the 'print_blocking_reports'/'GEVENT_MONITOR_PRINT_BLOCKING_REPOR…TS' setting to control whether blocking reports are printed.
diff --git a/docs/changes/2070.feature.rst b/docs/changes/2070.feature.rst
@@ -0,0 +1,2 @@
+Add a new environment variable and configuration setting to control
+whether blocking reports are printed by the monitor thread.
diff --git a/src/gevent/_config.py b/src/gevent/_config.py
@@ -13,8 +13,6 @@
    This is handy to quickly look for environment variables.
 """
 
-from __future__ import print_function, absolute_import, division
-
 import importlib
 import os
 import textwrap
@@ -116,7 +114,7 @@ def validate_anything(value):
 
 convert_str_value_as_is = validate_anything
 
-class Setting(object):
+class Setting(metaclass=SettingType):
     name = None
     value = None
     validate = staticmethod(validate_invalid)
@@ -155,7 +153,6 @@ def set(self, val):
         self.value = self.validate(self._convert(val))
 
 
-Setting = SettingType('Setting', (Setting,), dict(Setting.__dict__))
 
 def make_settings():
     """
@@ -176,7 +173,8 @@ class Config(object):
     There is one instance of this object at ``gevent.config``. If you
     are going to make changes in code, instead of using the documented
     environment variables, you need to make the changes before using
-    any parts of gevent that might need those settings. For example::
+    any parts of gevent that might need those settings (unless otherwise
+    documented). For example::
 
         >>> from gevent import config
         >>> config.fileobject = 'thread'
@@ -351,6 +349,7 @@ class Threadpool(ImportableSetting, Setting):
 
     default = 'gevent.threadpool.ThreadPool'
 
+
 class ThreadpoolIdleTaskTimeout(FloatSettingMixin, Setting):
     document = True
     name = 'threadpool_idle_task_timeout'
@@ -546,6 +545,24 @@ class MaxBlockingTime(FloatSettingMixin, Setting):
     .. versionadded:: 1.3b1
     """
 
+
+class PrintBlockingReports(BoolSettingMixin, Setting):
+    name = 'print_blocking_reports'
+    default = True
+
+    environment_key = 'GEVENT_MONITOR_PRINT_BLOCKING_REPORTS'
+    desc = """\
+    If `monitor_thread` is enabled, and gevent detects a hub blocked
+    for more than `max_blocking_time`, should gevent print a detailed
+    report about the block?
+
+    The report is generated and notifications are broadcast whether
+    or not the report is printed.
+
+    .. versionadded:: NEXT
+    """
+
+
 class MonitorMemoryPeriod(FloatSettingMixin, Setting):
     name = 'memory_monitor_period'
 
diff --git a/src/gevent/_monitor.py b/src/gevent/_monitor.py
@@ -252,12 +252,13 @@ def monitor_blocking(self, hub):
 
 
     def _show_blocking_report(self, hub, report, active_greenlet):
-        stream = hub.exception_stream
-        for line in report:
-            # Printing line by line may interleave with other things,
-            # but it should also prevent a "reentrant call to print"
-            # when the report is large.
-            print(line, file=stream)
+        if GEVENT_CONFIG.print_blocking_reports:
+            stream = hub.exception_stream
+            for line in report:
+                # Printing line by line may interleave with other things,
+                # but it should also prevent a "reentrant call to print"
+                # when the report is large.
+                print(line, file=stream)
         return (active_greenlet, report)
 
     def ignore_current_greenlet_blocking(self):

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Add a new environment variable and configuration setting to control`
	`2`	`+whether blocking reports are printed by the monitor thread.`