Merge pull request #3236 from rtfd/fix-more-logging

Clean up logging around exceptions

Author: ericholscher

readthedocs/builds/models.py

@@ -155,7 +155,7 @@ def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
         try:
             self.project.sync_supported_versions()
         except Exception:
-            log.error('failed to sync supported versions', exc_info=True)
+            log.exception('failed to sync supported versions')
         broadcast(type='app', task=tasks.symlink_project, args=[self.project.pk])
         return obj
 
@@ -224,7 +224,7 @@ def clean_build_path(self):
                     path, self))
                 rmtree(path)
         except OSError:
-            log.error('Build path cleanup failed', exc_info=True)
+            log.exception('Build path cleanup failed')
 
     def get_github_url(self, docroot, filename, source_suffix='.rst', action='view'):
         """

readthedocs/core/management/commands/reindex_elasticsearch.py

@@ -53,4 +53,4 @@ def handle(self, *args, **options):
                 update_search(version.pk, commit,
                               delete_non_commit_files=False)
             except Exception:
-                log.error('Reindex failed for %s', version, exc_info=True)
+                log.exception('Reindex failed for {}'.format(version))

readthedocs/core/management/commands/set_metadata.py

@@ -23,4 +23,4 @@ def handle(self, *args, **options):
             try:
                 broadcast(type='app', task=tasks.update_static_metadata, args=[p.pk])
             except Exception:
-                log.error('Build failed for %s', p, exc_info=True)
+                log.exception('Build failed for %s', p)

readthedocs/core/views/hooks.py

@@ -178,7 +178,7 @@ def github_build(request):  # noqa: D205
             ssh_search_url = ssh_url.replace('git@', '').replace('.git', '')
             branches = [data['ref'].replace('refs/heads/', '')]
         except (ValueError, TypeError, KeyError):
-            log.error('Invalid GitHub webhook payload', exc_info=True)
+            log.exception('Invalid GitHub webhook payload')
             return HttpResponse('Invalid request', status=400)
         try:
             repo_projects = get_project_from_url(http_search_url)
@@ -198,7 +198,7 @@ def github_build(request):  # noqa: D205
             projects = repo_projects | ssh_projects
             return _build_url(http_search_url, projects, branches)
         except NoProjectException:
-            log.error('Project match not found: url=%s', http_search_url)
+            log.exception('Project match not found: url=%s', http_search_url)
             return HttpResponseNotFound('Project not found')
     else:
         return HttpResponse('Method not allowed, POST is required', status=405)
@@ -222,7 +222,7 @@ def gitlab_build(request):  # noqa: D205
             search_url = re.sub(r'^https?://(.*?)(?:\.git|)$', '\\1', url)
             branches = [data['ref'].replace('refs/heads/', '')]
         except (ValueError, TypeError, KeyError):
-            log.error('Invalid GitLab webhook payload', exc_info=True)
+            log.exception('Invalid GitLab webhook payload')
             return HttpResponse('Invalid request', status=400)
         log.info(
             'GitLab webhook search: url=%s branches=%s',
@@ -281,7 +281,7 @@ def bitbucket_build(request):
                     data['repository']['full_name']
                 )
         except (TypeError, ValueError, KeyError):
-            log.error('Invalid Bitbucket webhook payload', exc_info=True)
+            log.exception('Invalid Bitbucket webhook payload')
             return HttpResponse('Invalid request', status=400)
 
         log.info(
@@ -320,7 +320,7 @@ def generic_build(request, project_id_or_slug=None):
         try:
             project = Project.objects.get(slug=project_id_or_slug)
         except (Project.DoesNotExist, ValueError):
-            log.error(
+            log.exception(
                 "(Incoming Generic Build) Repo not found:  %s",
                 project_id_or_slug)
             return HttpResponseNotFound(

readthedocs/doc_builder/environments.py

@@ -433,7 +433,7 @@ def update_build(self, state=None):
         except HttpClientError as e:
             log.error("Unable to post a new build: %s", e.content)
         except Exception:
-            log.error("Unknown build exception", exc_info=True)
+            log.exception("Unknown build exception")
 
 
 class LocalEnvironment(BuildEnvironment):

readthedocs/oauth/services/github.py

@@ -289,5 +289,5 @@ def get_token_for_project(cls, project, force_local=False):
                     if tokens.exists():
                         token = tokens[0].token
         except Exception:
-            log.error('Failed to get token for project', exc_info=True)
+            log.exception('Failed to get token for project')
         return token

readthedocs/projects/models.py

@@ -315,29 +315,29 @@ def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
                     latest.identifier = self.default_branch
                     latest.save()
         except Exception:
-            log.error('Failed to update latest identifier', exc_info=True)
+            log.exception('Failed to update latest identifier')
 
         # Add exceptions here for safety
         try:
             self.sync_supported_versions()
         except Exception:
-            log.error('failed to sync supported versions', exc_info=True)
+            log.exception('failed to sync supported versions')
         try:
             if not first_save:
                 broadcast(type='app', task=tasks.symlink_project, args=[self.pk])
         except Exception:
-            log.error('failed to symlink project', exc_info=True)
+            log.exception('failed to symlink project')
         try:
             if not first_save:
                 broadcast(type='app', task=tasks.update_static_metadata, args=[self.pk])
         except Exception:
-            log.error('failed to update static metadata', exc_info=True)
+            log.exception('failed to update static metadata')
         try:
             branch = self.default_branch or self.vcs_repo().fallback_branch
             if not self.versions.filter(slug=LATEST).exists():
                 self.versions.create_latest(identifier=branch)
         except Exception:
-            log.error('Error creating default branches', exc_info=True)
+            log.exception('Error creating default branches')
 
     def get_absolute_url(self):
         return reverse('projects_detail', args=[self.slug])

readthedocs/projects/tasks.py

@@ -624,7 +624,7 @@ def move_files(version_pk, hostname, html=False, localmedia=False, search=False,
     """
     version = Version.objects.get(pk=version_pk)
     log.debug(LOG_TEMPLATE.format(project=version.project.slug, version=version.slug,
-                                  msg='Moving files: {}'.format(locals())))
+                                  msg='Moving files'))
 
     if html:
         from_path = version.project.artifact_path(

readthedocs/projects/utils.py

@@ -84,7 +84,7 @@ def run(*commands):
                 command = ' '.join(command)
             except TypeError:
                 run_command = command
-        log.info('Running command: cwd=%s command=%s', cwd, command)
+        log.debug('Running command: cwd=%s command=%s', cwd, command)
         try:
             p = subprocess.Popen(
                 run_command,
@@ -100,7 +100,7 @@ def run(*commands):
             out = ''
             err = traceback.format_exc()
             ret = -1
-            log.error("Command failed", exc_info=True)
+            log.exception("Command failed")
 
     return (ret, out, err)
 

readthedocs/search/utils.py

@@ -266,7 +266,7 @@ def parse_mkdocs_sections(content):
     # we're unsure which exceptions can be raised
     # pylint: disable=bare-except
     except:
-        log.error('Failed indexing', exc_info=True)
+        log.exception('Failed indexing')
 
 
 def parse_sections(documentation_type, content):

readthedocs/vcs_support/utils.py

@@ -57,8 +57,7 @@ def __exit__(self, exc, value, tb):
             log.info("Lock (%s): Releasing", self.name)
             os.remove(self.fpath)
         except OSError:
-            log.error("Lock (%s): Failed to release, ignoring...", self.name,
-                      exc_info=True)
+            log.exception("Lock (%s): Failed to release, ignoring...", self.name)
 
 
 class NonBlockingLock(object):