exception-tracker: store event sending exception for easier event fail debugging.

rhodecode/integrations/__init__.py

@@ -1,70 +1,74 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2012-2018 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
-
+import sys
 import logging
 
 from rhodecode.integrations.registry import IntegrationTypeRegistry
 from rhodecode.integrations.types import webhook, slack, hipchat, email, base
+from rhodecode.lib.exc_tracking import store_exception
+
 log = logging.getLogger(__name__)
 
 
 # TODO: dan: This is currently global until we figure out what to do about
 # VCS's not having a pyramid context - move it to pyramid app configuration
 # includeme level later to allow per instance integration setup
 integration_type_registry = IntegrationTypeRegistry()
 
 integration_type_registry.register_integration_type(
     webhook.WebhookIntegrationType)
 integration_type_registry.register_integration_type(
     slack.SlackIntegrationType)
 integration_type_registry.register_integration_type(
     hipchat.HipchatIntegrationType)
 integration_type_registry.register_integration_type(
     email.EmailIntegrationType)
 
 
 # dummy EE integration to show users what we have in EE edition
 integration_type_registry.register_integration_type(
     base.EEIntegration('Jira Issues integration', 'jira'))
 integration_type_registry.register_integration_type(
     base.EEIntegration('Redmine Tracker integration', 'redmine'))
 integration_type_registry.register_integration_type(
     base.EEIntegration('Jenkins CI integration', 'jenkins'))
 
 
 def integrations_event_handler(event):
     """
     Takes an event and passes it to all enabled integrations
     """
     from rhodecode.model.integration import IntegrationModel
 
     integration_model = IntegrationModel()
     integrations = integration_model.get_for_event(event)
     for integration in integrations:
         try:
             integration_model.send_event(integration, event)
         except Exception:
+            exc_info = sys.exc_info()
+            store_exception(id(exc_info), exc_info)
             log.exception(
                 'failure occurred when sending event %s to integration %s' % (
                     event, integration))
 
 
 def includeme(config):
     config.include('rhodecode.integrations.routes')

rhodecode/lib/exc_tracking.py

@@ -1,146 +1,153 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2010-2018 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 import os
 import time
 import datetime
 import msgpack
 import logging
 import traceback
 import tempfile
 
 
 log = logging.getLogger(__name__)
 
 # NOTE: Any changes should be synced with exc_tracking at vcsserver.lib.exc_tracking
 global_prefix = 'rhodecode'
 
 
 def exc_serialize(exc_id, tb, exc_type):
 
     data = {
         'version': 'v1',
         'exc_id': exc_id,
         'exc_utc_date': datetime.datetime.utcnow().isoformat(),
         'exc_timestamp': repr(time.time()),
         'exc_message': tb,
         'exc_type': exc_type,
     }
     return msgpack.packb(data), data
 
 
 def exc_unserialize(tb):
     return msgpack.unpackb(tb)
 
 
 def get_exc_store():
     """
     Get and create exception store if it's not existing
     """
     exc_store_dir = 'rc_exception_store_v1'
     # fallback
     _exc_store_path = os.path.join(tempfile.gettempdir(), exc_store_dir)
 
     exc_store_dir = ''  # TODO: need a persistent cross instance store here
     if exc_store_dir:
         _exc_store_path = os.path.join(exc_store_dir, exc_store_dir)
 
     _exc_store_path = os.path.abspath(_exc_store_path)
     if not os.path.isdir(_exc_store_path):
         os.makedirs(_exc_store_path)
         log.debug('Initializing exceptions store at %s', _exc_store_path)
     return _exc_store_path
 
 
 def _store_exception(exc_id, exc_info, prefix):
     exc_type, exc_value, exc_traceback = exc_info
     tb = ''.join(traceback.format_exception(
         exc_type, exc_value, exc_traceback, None))
 
     exc_type_name = exc_type.__name__
     exc_store_path = get_exc_store()
     exc_data, org_data = exc_serialize(exc_id, tb, exc_type_name)
     exc_pref_id = '{}_{}_{}'.format(exc_id, prefix, org_data['exc_timestamp'])
     if not os.path.isdir(exc_store_path):
         os.makedirs(exc_store_path)
     stored_exc_path = os.path.join(exc_store_path, exc_pref_id)
     with open(stored_exc_path, 'wb') as f:
         f.write(exc_data)
     log.debug('Stored generated exception %s as: %s', exc_id, stored_exc_path)
 
 
 def store_exception(exc_id, exc_info, prefix=global_prefix):
+    """
+    Example usage::
+
+        exc_info = sys.exc_info()
+        store_exception(id(exc_info), exc_info)
+    """
+
     try:
         _store_exception(exc_id=exc_id, exc_info=exc_info, prefix=prefix)
     except Exception:
         log.exception('Failed to store exception `%s` information', exc_id)
         # there's no way this can fail, it will crash server badly if it does.
         pass
 
 
 def _find_exc_file(exc_id, prefix=global_prefix):
     exc_store_path = get_exc_store()
     if prefix:
         exc_id = '{}_{}'.format(exc_id, prefix)
     else:
         # search without a prefix
         exc_id = '{}'.format(exc_id)
 
     # we need to search the store for such start pattern as above
     for fname in os.listdir(exc_store_path):
         if fname.startswith(exc_id):
             exc_id = os.path.join(exc_store_path, fname)
             break
         continue
     else:
         exc_id = None
 
     return exc_id
 
 
 def _read_exception(exc_id, prefix):
     exc_id_file_path = _find_exc_file(exc_id=exc_id, prefix=prefix)
     if exc_id_file_path:
         with open(exc_id_file_path, 'rb') as f:
             return exc_unserialize(f.read())
     else:
         log.debug('Exception File `%s` not found', exc_id_file_path)
     return None
 
 
 def read_exception(exc_id, prefix=global_prefix):
     try:
         return _read_exception(exc_id=exc_id, prefix=prefix)
     except Exception:
         log.exception('Failed to read exception `%s` information', exc_id)
         # there's no way this can fail, it will crash server badly if it does.
     return None
 
 
 def delete_exception(exc_id, prefix=global_prefix):
     try:
         exc_id_file_path = _find_exc_file(exc_id, prefix=prefix)
         if exc_id_file_path:
             os.remove(exc_id_file_path)
 
     except Exception:
         log.exception('Failed to remove exception `%s` information', exc_id)
         # there's no way this can fail, it will crash server badly if it does.
         pass