feat: gLogger enables logs from ext libs only if level is debug and DIRAC not used as a lib

Author: aldbr

docs/source/AdministratorGuide/Resources/messagequeues.rst

@@ -95,9 +95,6 @@ like described in :ref:`development_use_mq`, for example::
      message = result['Value']
 
 
-In order not to spam the logs, the log output of Stomp is always silence, unless the environment variable `DIRAC_DEBUG_STOMP` is set to any value.
-
-
 Message Queue nomenclature in DIRAC
 -----------------------------------
 

docs/source/AdministratorGuide/ServerInstallations/environment_variable_configuration.rst

@@ -14,9 +14,6 @@ DIRAC_DEBUG_DENCODE_CALLSTACK
 DIRAC_DEBUG_M2CRYPTO
   If ``true`` or ``yes``, print a lot of SSL debug output
 
-DIRAC_DEBUG_STOMP
-  If set, the stomp library will print out debug information
-
 DIRAC_DEPRECATED_FAIL
   If set, the use of functions or objects that are marked ``@deprecated`` will fail. Useful for example in continuous
   integration tests against future versions of DIRAC

src/DIRAC/ConfigurationSystem/Client/LocalConfiguration.py

@@ -311,6 +311,7 @@ def initialize(self, *, returnErrors=False):
 
     def __initLogger(self, componentName, logSection, forceInit=False):
         gLogger.initialize(componentName, logSection, forceInit=forceInit)
+        gLogger.disableLogsFromExternalLibs()
 
         if self.__debugMode == 1:
             gLogger.setLevel("VERBOSE")
@@ -320,6 +321,7 @@ def __initLogger(self, componentName, logSection, forceInit=False):
         elif self.__debugMode >= 3:
             gLogger.setLevel("DEBUG")
             gLogger.showHeaders(True)
+            gLogger.enableLogsFromExternalLibs()
 
     def loadUserData(self):
         """

src/DIRAC/FrameworkSystem/private/standardLogging/LoggingRoot.py

@@ -36,7 +36,9 @@ def __init__(self):
         - update the format according to the command line argument
 
         """
-        # initialize the root logger, which turns out to be a child of root
+        # initialize the DIRAC root logger, which turns out to be a child of root
+        # it is strongly advised to use a logger with a unique and identifiable name:
+        # https://docs.python.org/3/howto/logging.html#configuring-logging-for-a-library
         super().__init__(name="dirac")
 
         # this line removes some useless information from log records and improves the performances
@@ -259,12 +261,20 @@ def __configureLevel(self):
     def enableLogsFromExternalLibs(self):
         """
         Enable the display of the logs coming from external libraries
+
+        .. warning::
+
+          This method should only be used for debugging purposes.
         """
         self.__enableLogsFromExternalLibs()
 
     def disableLogsFromExternalLibs(self):
         """
         Disable the display of the logs coming from external libraries
+
+        .. warning::
+
+          This method should only be used for debugging purposes.
         """
         self.__enableLogsFromExternalLibs(False)
 

src/DIRAC/Resources/Computing/BOINCComputingElement.py

@@ -48,8 +48,6 @@ def createClient(self):
             try:
                 from suds.client import Client
 
-                if self.log.getLevel() == "DEBUG":
-                    self.log.enableLogsFromExternalLibs()
                 self.BOINCClient = Client(self.wsdl)
             except Exception as x:
                 self.log.error("Creation of the soap client failed", f"{str(x)}")

src/DIRAC/Resources/MessageQueue/StompMQConnector.py

@@ -43,9 +43,6 @@ def __init__(self, parameters=None):
         super().__init__(parameters=parameters)
         self.connection = None
 
-        if "DIRAC_DEBUG_STOMP" in os.environ:
-            gLogger.enableLogsFromExternalLibs()
-
     def setupConnection(self, parameters=None):
         """
          Establishes a new connection to a Stomp server, e.g. RabbitMQ

src/DIRAC/Resources/Storage/GFAL2_StorageBase.py

@@ -135,7 +135,6 @@ def __init__(self, storageName: str, parameters: dict[str, str]):
 
         dlevel = self.log.getLevel()
         if dlevel == "DEBUG":
-            gLogger.enableLogsFromExternalLibs()
             gfal2.set_verbose(gfal2.verbose_level.trace)
 
         # # gfal2 API

src/DIRAC/WorkloadManagementSystem/scripts/dirac_wms_cpu_normalization.py

@@ -49,9 +49,6 @@ def main():
 
     gLogger.info("Computing benchmark measurements on", "%d processor(s)..." % numberOfProcessors)
 
-    # we want to get the logs coming from db12
-    gLogger.enableLogsFromExternalLibs()
-
     # multiprocessor allocations generally have a CPU Power lower than single core one.
     # in order to avoid having wrong estimations, we run multiple copies of the benchmark simultaneously
     result = multiple_dirac_benchmark(numberOfProcessors)