Improve logging

qiskit/providers/ibmq/__init__.py

@@ -102,6 +102,14 @@
 IBMQ = IBMQFactory()
 """A global instance of an account manager that is used as the entry point for convenience."""
 
+# Constants used by the IBM Quantum logger.
+IBMQ_PROVIDER_LOGGER_NAME = 'qiskit.providers.ibmq'
+"""The name of the IBM Quantum logger."""
+QISKIT_IBMQ_PROVIDER_LOG_LEVEL = 'QISKIT_IBMQ_PROVIDER_LOG_LEVEL'
+"""The environment variable name that is used to set the level for the IBM Quantum logger."""
+QISKIT_IBMQ_PROVIDER_LOG_FILE = 'QISKIT_IBMQ_PROVIDER_LOG_FILE'
+"""The environment variable name that is used to set the file for the IBM Quantum logger."""
+
 
 def least_busy(backends: List[BaseBackend]) -> BaseBackend:
     """Return the least busy backend from a list.
@@ -121,13 +129,8 @@ def least_busy(backends: List[BaseBackend]) -> BaseBackend:
             does not have the ``pending_jobs`` attribute in its status.
     """
     try:
-        backends_to_filter = {}
-        for backend in backends:
-            backend_status = backend.status()
-            if backend_status.operational:
-                backends_to_filter[backend] = backend_status
-
-        return min(backends_to_filter.keys(), key=lambda b: backends_to_filter[b].pending_jobs)
+        return min([b for b in backends if b.status().operational],
+                   key=lambda b: b.status().pending_jobs)
     except (ValueError, TypeError):
         raise IBMQError('Unable to find the least_busy '
                         'backend from an empty list.') from None

qiskit/providers/ibmq/api/rest/job.py

@@ -14,6 +14,7 @@
 
 """Job REST adapter."""
 
+import logging
 import pprint
 import json
 from json.decoder import JSONDecodeError
@@ -28,6 +29,8 @@
 from ..session import RetrySession
 from ..exceptions import ApiIBMQProtocolError
 
+logger = logging.getLogger(__name__)
+
 
 class Job(RestAdapterBase):
     """Rest adapter for job related endpoints."""
@@ -170,6 +173,7 @@ def put_object_storage(self, url: str, qobj_dict: Dict[str, Any]) -> str:
         """
         data = json.dumps(qobj_dict, cls=json_encoder.IQXJsonEconder)
         response = self.session.put(url, data=data, bare=True)
+        logger.debug('Uploading Qobj to object storage.')
         return response.text
 
     def get_object_storage(self, url: str) -> Dict[str, Any]:
@@ -181,4 +185,6 @@ def get_object_storage(self, url: str) -> Dict[str, Any]:
         Returns:
             JSON response.
         """
-        return self.session.get(url, bare=True).json()
+        response = self.session.get(url, bare=True).json()
+        logger.debug('Downloading Qobj from object storage.')
+        return response

qiskit/providers/ibmq/api/session.py

@@ -226,7 +226,7 @@ def request(  # type: ignore[override]
         try:
             response = super().request(method, final_url, **kwargs)
             response.raise_for_status()
-            self._log_request_info(url, bare, method, kwargs)
+            self._log_request_info(url, method, kwargs)
         except RequestException as ex:
             # Wrap the requests exceptions into a IBM Q custom one, for
             # compatibility.
@@ -272,7 +272,6 @@ def _modify_chained_exception_messages(self, exc: BaseException) -> None:
     def _log_request_info(
             self,
             url: str,
-            bare: bool,
             method: str,
             request_data: Dict[str, Any]
     ) -> None:
@@ -290,7 +289,6 @@ def _log_request_info(
 
         Args:
             url: URL for the new request.
-            bare: Whether the input `url` is modified.
             method: Method for the new request (e.g. ``POST``)
             request_data:Additional arguments for the request.
 
@@ -311,36 +309,33 @@ def _log_request_info(
                     logger.debug('Endpoint: %s. Method: %s. Request Data: %s.',
                                  filtered_url, method, request_data)
                 else:
-                    if bare:
-                        if method == 'PUT':
-                            logger.debug('Uploading Qobj to object storage.')
-                        elif method == 'GET':
-                            logger.debug('Downloading Qobj from object storage.')
-                    else:
-                        logger.debug('Endpoint: %s. Method: %s.', filtered_url, method)
+                    logger.debug('Endpoint: %s. Method: %s.', filtered_url, method)
             except Exception as ex:  # pylint: disable=broad-except
                 # Catch general exception so as not to disturb the program if filtering fails.
                 logger.info('Filtering failed when logging request information: %s', str(ex))
 
     def _is_worth_logging(self, endpoint_url: str) -> bool:
         """Returns whether the endpoint URL should be logged.
 
-        The checks in place help filter out logs that would add noise and no helpful information.
+        The checks in place help filter out endpoint URL logs that would add noise
+        and no helpful information.
 
         Note:
             The following endpoint URLs are not logged: ``/devices/v/1`` and
             ``/devices/<device_name>/queue/status``. Likewise, the endpoint URLs that start
-            with ``/users`` and ``/version`` are not logged.
+            with ``/users`` or ``/version``, or contain 'objectstorage', are not logged.
 
         Args:
-            endpoint_url: The endpoint URL to log.
+            endpoint_url: The endpoint URL that will be logged.
 
         Returns:
             Whether the endpoint URL should be logged.
         """
+        if endpoint_url in ('/devices/.../queue/status', '/devices/v/1'):
+            return False
         if endpoint_url.startswith(('/users', '/version')):
             return False
-        if endpoint_url in ('/devices/.../queue/status', '/devices/v/1'):
+        if 'objectstorage' in endpoint_url:
             return False
 
         return True

test/ibmq/test_ibmq_logger.py

@@ -19,14 +19,11 @@
 from tempfile import NamedTemporaryFile
 from unittest import skipIf, mock
 
+from qiskit.providers.ibmq import (QISKIT_IBMQ_PROVIDER_LOG_LEVEL, QISKIT_IBMQ_PROVIDER_LOG_FILE)
 from qiskit.providers.ibmq.utils.utils import setup_logger
 
 from ..ibmqtestcase import IBMQTestCase
 
-# Constants used by `TestLogger`.
-QISKIT_IBMQ_PROVIDER_LOG_LEVEL = 'QISKIT_IBMQ_PROVIDER_LOG_LEVEL'
-QISKIT_IBMQ_PROVIDER_LOG_FILE = 'QISKIT_IBMQ_PROVIDER_LOG_FILE'
-
 
 class TestLogger(IBMQTestCase):
     """Tests related to logger setup via ``setup_logger()``."""

test/ibmqtestcase.py

@@ -19,8 +19,7 @@
 
 from qiskit.test import QiskitTestCase
 
-# Name of the ibmq provider modules logger.
-IBMQ_PROVIDER_LOGGER_NAME = 'qiskit.providers.ibmq'
+from qiskit.providers.ibmq import IBMQ_PROVIDER_LOGGER_NAME
 
 
 class IBMQTestCase(QiskitTestCase):