class VumiRavenClient(raven.Client):
_registry = TransportRegistry(transports=[
VumiRavenHTTPTransport
])
def teardown(self):
return DeferredList(remaining_deferreds)
def _check_pid(cls):
global Raven
if cls._pid != os.getpid():
cls.logger = logging.getLogger('raven')
cls.protocol_version = '6'
cls._registry = TransportRegistry(transports=default_transports)
cls._pid = os.getpid()
Raven = None
class Client(object):
"""
The base Raven client.
Will read default configuration from the environment variable
``SENTRY_DSN`` if available.
>>> from raven import Client
>>> # Read configuration from ``os.environ['SENTRY_DSN']``
>>> client = Client()
>>> # Specify a DSN explicitly
>>> client = Client(dsn='https://*****:*****@sentry.local/project_id')
>>> # Record an exception
>>> try:
>>> 1/0
>>> except ZeroDivisionError:
>>> ident = client.get_ident(client.captureException())
>>> print "Exception caught; reference is %s" % ident
"""
logger = logging.getLogger('raven')
protocol_version = '6'
_registry = TransportRegistry(transports=default_transports)
def __init__(self,
dsn=None,
raise_send_errors=False,
transport=None,
install_sys_hook=True,
install_logging_hook=True,
hook_libraries=None,
enable_breadcrumbs=True,
**options):
global Raven
o = options
self.raise_send_errors = raise_send_errors
# configure loggers first
cls = self.__class__
self.state = ClientState()
self.logger = logging.getLogger('%s.%s' %
(cls.__module__, cls.__name__))
self.error_logger = logging.getLogger('sentry.errors')
self.uncaught_logger = logging.getLogger('sentry.errors.uncaught')
self._transport_cache = {}
self.set_dsn(dsn, transport)
self.include_paths = set(o.get('include_paths') or [])
self.exclude_paths = set(o.get('exclude_paths') or [])
self.name = text_type(
o.get('name') or o.get('machine') or defaults.NAME)
self.auto_log_stacks = bool(
o.get('auto_log_stacks') or defaults.AUTO_LOG_STACKS)
self.capture_locals = bool(
o.get('capture_locals', defaults.CAPTURE_LOCALS))
self.string_max_length = int(
o.get('string_max_length') or defaults.MAX_LENGTH_STRING)
self.list_max_length = int(
o.get('list_max_length') or defaults.MAX_LENGTH_LIST)
self.site = o.get('site')
self.include_versions = o.get('include_versions', True)
self.processors = o.get('processors')
if self.processors is None:
self.processors = defaults.PROCESSORS
context = o.get('context')
if context is None:
context = {'sys.argv': sys.argv[:]}
self.extra = context
self.tags = o.get('tags') or {}
self.environment = o.get('environment') or None
self.release = o.get('release') or os.environ.get('HEROKU_SLUG_COMMIT')
self.module_cache = ModuleProxyCache()
if not self.is_enabled():
self.logger.info(
'Raven is not configured (logging is disabled). Please see the'
' documentation for more information.')
if Raven is None:
Raven = self
# We want to remember the creating thread id here because this
# comes in useful for the context special handling
self.main_thread_id = get_thread_ident()
self.enable_breadcrumbs = enable_breadcrumbs
from raven.context import Context
self._context = Context(self)
if install_sys_hook:
self.install_sys_hook()
if install_logging_hook:
self.install_logging_hook()
self.hook_libraries(hook_libraries)
def set_dsn(self, dsn=None, transport=None):
if not dsn and os.environ.get('SENTRY_DSN'):
msg = "Configuring Raven from environment variable 'SENTRY_DSN'"
self.logger.debug(msg)
dsn = os.environ['SENTRY_DSN']
if dsn not in self._transport_cache:
if not dsn:
result = RemoteConfig(transport=transport)
else:
result = RemoteConfig.from_string(
dsn,
transport=transport,
transport_registry=self._registry,
)
self._transport_cache[dsn] = result
self.remote = result
else:
self.remote = self._transport_cache[dsn]
self.logger.debug("Configuring Raven for host: {0}".format(
self.remote))
def install_sys_hook(self):
global __excepthook__
if __excepthook__ is None:
__excepthook__ = sys.excepthook
def handle_exception(*exc_info):
self.captureException(exc_info=exc_info)
__excepthook__(*exc_info)
sys.excepthook = handle_exception
def install_logging_hook(self):
from raven.breadcrumbs import install_logging_hook
install_logging_hook()
def hook_libraries(self, libraries):
from raven.breadcrumbs import hook_libraries
hook_libraries(libraries)
@classmethod
def register_scheme(cls, scheme, transport_class):
cls._registry.register_scheme(scheme, transport_class)
def get_processors(self):
for processor in self.processors:
yield self.module_cache[processor](self)
def get_module_versions(self):
if not self.include_versions:
return {}
version_info = sys.version_info
modules = get_versions(self.include_paths)
modules['python'] = '{0}.{1}.{2}'.format(
version_info[0],
version_info[1],
version_info[2],
)
return modules
def get_ident(self, result):
"""
Returns a searchable string representing a message.
>>> result = client.capture(**kwargs)
>>> ident = client.get_ident(result)
"""
warnings.warn(
'Client.get_ident is deprecated. The event ID is now '
'returned as the result of capture.', DeprecationWarning)
return result
def get_handler(self, name):
return self.module_cache[name](self)
def get_public_dsn(self, scheme=None):
"""
Returns a public DSN which is consumable by raven-js
>>> # Return scheme-less DSN
>>> print client.get_public_dsn()
>>> # Specify a scheme to use (http or https)
>>> print client.get_public_dsn('https')
"""
if not self.is_enabled():
return
url = self.remote.get_public_dsn()
if not scheme:
return url
return '%s:%s' % (scheme, url)
def _get_exception_key(self, exc_info):
# On certain celery versions the tb_frame attribute might
# not exist or be `None`.
code_id = 0
last_id = 0
try:
code_id = id(exc_info[2] and exc_info[2].tb_frame.f_code)
last_id = exc_info[2] and exc_info[2].tb_lasti or 0
except (AttributeError, IndexError):
pass
return (
exc_info[0],
id(exc_info[1]),
code_id,
id(exc_info[2]),
last_id,
)
def skip_error_for_logging(self, exc_info):
key = self._get_exception_key(exc_info)
return key in self.context.exceptions_to_skip
def record_exception_seen(self, exc_info):
key = self._get_exception_key(exc_info)
self.context.exceptions_to_skip.add(key)
def build_msg(self,
event_type,
data=None,
date=None,
time_spent=None,
extra=None,
stack=None,
public_key=None,
tags=None,
fingerprint=None,
**kwargs):
"""
Captures, processes and serializes an event into a dict object
The result of ``build_msg`` should be a standardized dict, with
all default values available.
"""
# create ID client-side so that it can be passed to application
event_id = uuid.uuid4().hex
data = merge_dicts(self.context.data, data)
data.setdefault('tags', {})
data.setdefault('extra', {})
if '.' not in event_type:
# Assume it's a builtin
event_type = 'raven.events.%s' % event_type
handler = self.get_handler(event_type)
result = handler.capture(**kwargs)
# data (explicit) culprit takes over auto event detection
culprit = result.pop('culprit', None)
if data.get('culprit'):
culprit = data['culprit']
for k, v in iteritems(result):
if k not in data:
data[k] = v
# auto_log_stacks only applies to events that are not exceptions
# due to confusion about which stack is which and the automatic
# application of stacktrace to exception objects by Sentry
if stack is None and 'exception' not in data:
stack = self.auto_log_stacks
if stack and 'stacktrace' not in data:
if stack is True:
frames = iter_stack_frames()
else:
frames = stack
stack_info = get_stack_info(
frames,
transformer=self.transform,
capture_locals=self.capture_locals,
)
data.update({
'stacktrace': stack_info,
})
if self.include_paths:
for frame in self._iter_frames(data):
if frame.get('in_app') is not None:
continue
path = frame.get('module')
if not path:
continue
if path.startswith('raven.'):
frame['in_app'] = False
else:
frame['in_app'] = (any(
path.startswith(x)
for x in self.include_paths) and not any(
path.startswith(x) for x in self.exclude_paths))
if not culprit:
if 'stacktrace' in data:
culprit = get_culprit(data['stacktrace']['frames'])
elif 'exception' in data:
stacktrace = data['exception']['values'][0].get('stacktrace')
if stacktrace:
culprit = get_culprit(stacktrace['frames'])
if not data.get('level'):
data['level'] = kwargs.get('level') or logging.ERROR
if not data.get('server_name'):
data['server_name'] = self.name
if not data.get('modules'):
data['modules'] = self.get_module_versions()
if self.release is not None:
data['release'] = self.release
if self.environment is not None:
data['environment'] = self.environment
data['tags'] = merge_dicts(self.tags, data['tags'], tags)
data['extra'] = merge_dicts(self.extra, data['extra'], extra)
# Legacy support for site attribute
site = data.pop('site', None) or self.site
if site:
data['tags'].setdefault('site', site)
if culprit:
data['culprit'] = culprit
if fingerprint:
data['fingerprint'] = fingerprint
# Run the data through processors
for processor in self.get_processors():
data.update(processor.process(data))
if 'message' not in data:
data['message'] = kwargs.get('message', handler.to_string(data))
# tags should only be key=>u'value'
for key, value in iteritems(data['tags']):
data['tags'][key] = to_unicode(value)
# extra data can be any arbitrary value
for k, v in iteritems(data['extra']):
data['extra'][k] = self.transform(v)
# It's important date is added **after** we serialize
data.setdefault('project', self.remote.project)
data.setdefault('timestamp', date or datetime.utcnow())
data.setdefault('time_spent', time_spent)
data.setdefault('event_id', event_id)
data.setdefault('platform', PLATFORM_NAME)
data.setdefault('sdk', SDK_VALUE)
# insert breadcrumbs
if self.enable_breadcrumbs:
crumbs = self.context.breadcrumbs.get_buffer()
if crumbs:
# Make sure we send the crumbs here as "values" as we use the
# raven client internally in sentry and the alternative
# submission option of a list here is not supported by the
# internal sender.
data.setdefault('breadcrumbs', {'values': crumbs})
return data
def transform(self, data):
return transform(data,
list_max_length=self.list_max_length,
string_max_length=self.string_max_length)
@property
def context(self):
"""
Updates this clients thread-local context for future events.
>>> def view_handler(view_func, *args, **kwargs):
>>> client.context.merge(tags={'key': 'value'})
>>> try:
>>> return view_func(*args, **kwargs)
>>> finally:
>>> client.context.clear()
"""
return self._context
def user_context(self, data):
"""
Update the user context for future events.
>>> client.user_context({'email': '*****@*****.**'})
"""
return self.context.merge({
'user': data,
})
def http_context(self, data, **kwargs):
"""
Update the http context for future events.
>>> client.http_context({'url': 'http://example.com'})
"""
return self.context.merge({
'request': data,
})
def extra_context(self, data, **kwargs):
"""
Update the extra context for future events.
>>> client.extra_context({'foo': 'bar'})
"""
return self.context.merge({
'extra': data,
})
def tags_context(self, data, **kwargs):
"""
Update the tags context for future events.
>>> client.tags_context({'version': '1.0'})
"""
return self.context.merge({
'tags': data,
})
def capture(self,
event_type,
data=None,
date=None,
time_spent=None,
extra=None,
stack=None,
tags=None,
**kwargs):
"""
Captures and processes an event and pipes it off to SentryClient.send.
To use structured data (interfaces) with capture:
>>> capture('raven.events.Message', message='foo', data={
>>> 'request': {
>>> 'url': '...',
>>> 'data': {},
>>> 'query_string': '...',
>>> 'method': 'POST',
>>> },
>>> 'logger': 'logger.name',
>>> }, extra={
>>> 'key': 'value',
>>> })
The finalized ``data`` structure contains the following (some optional)
builtin values:
>>> {
>>> # the culprit and version information
>>> 'culprit': 'full.module.name', # or /arbitrary/path
>>>
>>> # all detectable installed modules
>>> 'modules': {
>>> 'full.module.name': 'version string',
>>> },
>>>
>>> # arbitrary data provided by user
>>> 'extra': {
>>> 'key': 'value',
>>> }
>>> }
:param event_type: the module path to the Event class. Builtins can use
shorthand class notation and exclude the full module
path.
:param data: the data base, useful for specifying structured data
interfaces. Any key which contains a '.' will be
assumed to be a data interface.
:param date: the datetime of this event
:param time_spent: a integer value representing the duration of the
event (in milliseconds)
:param extra: a dictionary of additional standard metadata
:param stack: a stacktrace for the event
:param tags: dict of extra tags
:return: a tuple with a 32-length string identifying this event
"""
if not self.is_enabled():
return
exc_info = kwargs.get('exc_info')
if exc_info is not None:
if self.skip_error_for_logging(exc_info):
return
self.record_exception_seen(exc_info)
data = self.build_msg(event_type,
data,
date,
time_spent,
extra,
stack,
tags=tags,
**kwargs)
self.send(**data)
return data['event_id']
def is_enabled(self):
"""
Return a boolean describing whether the client should attempt to send
events.
"""
return self.remote.is_active()
def _iter_frames(self, data):
if 'stacktrace' in data:
for frame in data['stacktrace']['frames']:
yield frame
if 'exception' in data:
for frame in data['exception']['values'][0]['stacktrace'][
'frames']:
yield frame
def _successful_send(self):
self.state.set_success()
def _failed_send(self, exc, url, data):
retry_after = 0
if isinstance(exc, APIError):
if isinstance(exc, RateLimited):
retry_after = exc.retry_after
self.error_logger.error(
'Sentry responded with an API error: %s(%s)',
type(exc).__name__, exc.message)
else:
self.error_logger.error(
'Sentry responded with an error: %s (url: %s)\n%s',
exc,
url,
pformat(data),
exc_info=True)
self._log_failed_submission(data)
self.state.set_fail(retry_after=retry_after)
def _log_failed_submission(self, data):
"""
Log a reasonable representation of an event that should have been sent
to Sentry
"""
message = data.pop('message', '<no message value>')
output = [message]
if 'exception' in data and 'stacktrace' in data['exception']['values'][
0]:
# try to reconstruct a reasonable version of the exception
for frame in data['exception']['values'][0]['stacktrace'][
'frames']:
output.append(
' File "%(fn)s", line %(lineno)s, in %(func)s' % {
'fn': frame['filename'],
'lineno': frame['lineno'],
'func': frame['function'],
})
self.uncaught_logger.error(output)
def send_remote(self, url, data, headers=None):
# If the client is configured to raise errors on sending,
# the implication is that the backoff and retry strategies
# will be handled by the calling application
if headers is None:
headers = {}
if not self.raise_send_errors and not self.state.should_try():
data = self.decode(data)
self._log_failed_submission(data)
return
self.logger.debug('Sending message of length %d to %s', len(data), url)
def failed_send(e):
self._failed_send(e, url, self.decode(data))
try:
transport = self.remote.get_transport()
if transport. async:
transport.async_send(data, headers, self._successful_send,
failed_send)
else:
transport.send(data, headers)
self._successful_send()
except Exception as e:
if self.raise_send_errors:
raise
failed_send(e)
def send(self, auth_header=None, **data):
"""
Serializes the message and passes the payload onto ``send_encoded``.
"""
message = self.encode(data)
return self.send_encoded(message, auth_header=auth_header)
def send_encoded(self, message, auth_header=None, **kwargs):
"""
Given an already serialized message, signs the message and passes the
payload off to ``send_remote``.
"""
client_string = 'raven-python/%s' % (raven.VERSION, )
if not auth_header:
timestamp = time.time()
auth_header = get_auth_header(
protocol=self.protocol_version,
timestamp=timestamp,
client=client_string,
api_key=self.remote.public_key,
api_secret=self.remote.secret_key,
)
headers = {
'User-Agent': client_string,
'X-Sentry-Auth': auth_header,
'Content-Encoding': self.get_content_encoding(),
'Content-Type': 'application/octet-stream',
}
return self.send_remote(url=self.remote.store_endpoint,
data=message,
headers=headers,
**kwargs)
def get_content_encoding(self):
return 'deflate'
def encode(self, data):
"""
Serializes ``data`` into a raw string.
"""
return zlib.compress(json.dumps(data).encode('utf8'))
def decode(self, data):
"""
Unserializes a string, ``data``.
"""
return json.loads(zlib.decompress(data).decode('utf8'))
def captureMessage(self, message, **kwargs):
"""
Creates an event from ``message``.
>>> client.captureMessage('My event just happened!')
"""
return self.capture('raven.events.Message', message=message, **kwargs)
def captureException(self, exc_info=None, **kwargs):
"""
Creates an event from an exception.
>>> try:
>>> exc_info = sys.exc_info()
>>> client.captureException(exc_info)
>>> finally:
>>> del exc_info
If exc_info is not provided, or is set to True, then this method will
perform the ``exc_info = sys.exc_info()`` and the requisite clean-up
for you.
``kwargs`` are passed through to ``.capture``.
"""
if exc_info is None or exc_info is True:
exc_info = sys.exc_info()
return self.capture('raven.events.Exception',
exc_info=exc_info,
**kwargs)
def capture_exceptions(self, function_or_exceptions=None, **kwargs):
"""
Wrap a function or code block in try/except and automatically call
``.captureException`` if it raises an exception, then the exception
is reraised.
By default, it will capture ``Exception``
>>> @client.capture_exceptions
>>> def foo():
>>> raise Exception()
>>> with client.capture_exceptions():
>>> raise Exception()
You can also specify exceptions to be caught specifically
>>> @client.capture_exceptions((IOError, LookupError))
>>> def bar():
>>> ...
>>> with client.capture_exceptions((IOError, LookupError)):
>>> ...
``kwargs`` are passed through to ``.captureException``.
"""
function = None
exceptions = (Exception, )
if isinstance(function_or_exceptions, FunctionType):
function = function_or_exceptions
elif function_or_exceptions is not None:
exceptions = function_or_exceptions
# In python3.2 contextmanager acts both as contextmanager and decorator
@contextlib.contextmanager
def make_decorator(exceptions):
try:
yield
except exceptions:
self.captureException(**kwargs)
raise
decorator = make_decorator(exceptions)
if function:
return decorator(function)
return decorator
def captureQuery(self, query, params=(), engine=None, **kwargs):
"""
Creates an event for a SQL query.
>>> client.captureQuery('SELECT * FROM foo')
"""
return self.capture('raven.events.Query',
query=query,
params=params,
engine=engine,
**kwargs)
def captureExceptions(self, **kwargs):
warnings.warn(
'captureExceptions is deprecated, used context() instead.',
DeprecationWarning)
return self.context(**kwargs)
def captureBreadcrumb(self, *args, **kwargs):
"""Records a breadcrumb with the current context. They will be
sent with the next event.
"""
# Note: framework integration should not call this method but
# instead use the raven.breadcrumbs.record_breadcrumb function
# which will record to the correct client automatically.
self.context.breadcrumbs.record(*args, **kwargs)
capture_breadcrumb = captureBreadcrumb
class Client(object):
"""
The base Raven client, which handles both local direct
communication with Sentry (through the GroupedMessage API), as
well as communicating over the HTTP API to multiple servers.
Will read default configuration from the environment variable
``SENTRY_DSN`` if available.
>>> from raven import Client
>>> # Read configuration from ``os.environ['SENTRY_DSN']``
>>> client = Client()
>>> # Specify a DSN explicitly
>>> client = Client(dsn='https://*****:*****@sentry.local/project_id')
>>> # Configure the client manually
>>> client = Client(
>>> servers=['http://sentry.local/api/store/'],
>>> include_paths=['my.package'],
>>> project='project_id',
>>> public_key='public_key',
>>> secret_key='secret_key',
>>> )
>>> # Record an exception
>>> try:
>>> 1/0
>>> except ZeroDivisionError:
>>> ident = client.get_ident(client.captureException())
>>> print "Exception caught; reference is %s" % ident
"""
logger = logging.getLogger('raven')
protocol_version = '2.0'
_registry = TransportRegistry(transports=default_transports)
def __init__(self, dsn=None, **options):
global Raven
o = options
# configure loggers first
cls = self.__class__
self.state = ClientState()
self.logger = logging.getLogger('%s.%s' % (cls.__module__,
cls.__name__))
self.error_logger = logging.getLogger('sentry.errors')
if dsn is None and os.environ.get('SENTRY_DSN'):
msg = "Configuring Raven from environment variable 'SENTRY_DSN'"
self.logger.debug(msg)
dsn = os.environ['SENTRY_DSN']
if dsn:
# TODO: should we validate other options werent sent?
urlparts = urlparse(dsn)
msg = "Configuring Raven for host: %s://%s:%s" % (urlparts.scheme,
urlparts.netloc, urlparts.path)
self.logger.debug(msg)
dsn_config = raven.load(dsn, transport_registry=self._registry)
servers = dsn_config['SENTRY_SERVERS']
project = dsn_config['SENTRY_PROJECT']
public_key = dsn_config['SENTRY_PUBLIC_KEY']
secret_key = dsn_config['SENTRY_SECRET_KEY']
else:
servers = o.get('servers')
project = o.get('project')
public_key = o.get('public_key')
secret_key = o.get('secret_key')
self.servers = servers
self.public_key = public_key
self.secret_key = secret_key
self.project = project or defaults.PROJECT
self.include_paths = set(o.get('include_paths') or [])
self.exclude_paths = set(o.get('exclude_paths') or [])
self.name = unicode(o.get('name') or defaults.NAME)
self.auto_log_stacks = bool(o.get('auto_log_stacks') or
defaults.AUTO_LOG_STACKS)
self.string_max_length = int(o.get('string_max_length') or
defaults.MAX_LENGTH_STRING)
self.list_max_length = int(o.get('list_max_length') or defaults.MAX_LENGTH_LIST)
self.site = o.get('site', defaults.SITE)
self.include_versions = o.get('include_versions', True)
self.processors = o.get('processors')
if self.processors is None:
self.processors = defaults.PROCESSORS
context = o.get('context')
if context is None:
context = {'sys.argv': sys.argv[:]}
self.extra = context
self.module_cache = ModuleProxyCache()
# servers may be set to a NoneType (for Django)
if not self.is_enabled():
self.logger.info('Raven is not configured (disabled). Please see documentation for more information.')
if Raven is None:
Raven = self
@classmethod
def register_scheme(cls, scheme, transport_class):
cls._registry.register_scheme(scheme, transport_class)
def get_processors(self):
for processor in self.processors:
yield self.module_cache[processor](self)
def get_module_versions(self):
if not self.include_versions:
return {}
return get_versions(self.include_paths)
def get_ident(self, result):
"""
Returns a searchable string representing a message.
>>> result = client.process(**kwargs)
>>> ident = client.get_ident(result)
"""
return '$'.join(result)
def get_handler(self, name):
return self.module_cache[name](self)
def _get_public_dsn(self):
url = urlparse(self.servers[0])
netloc = url.hostname
if url.port:
netloc += ':%s' % url.port
path = url.path.replace('api/store/', self.project)
return '//%s@%s%s' % (self.public_key, netloc, path)
def get_public_dsn(self, scheme=None):
"""
Returns a public DSN which is consumable by raven-js
>>> # Return scheme-less DSN
>>> print client.get_public_dsn()
>>> # Specify a scheme to use (http or https)
>>> print client.get_public_dsn('https')
"""
if not self.is_enabled():
return
url = self._get_public_dsn()
if not scheme:
return url
return '%s:%s' % (scheme, url)
def build_msg(self, event_type, data=None, date=None,
time_spent=None, extra=None, stack=None, public_key=None,
tags=None, **kwargs):
"""
Captures, processes and serializes an event into a dict object
The result of ``build_msg`` should be a standardized dict, with
all default values available.
"""
# create ID client-side so that it can be passed to application
event_id = uuid.uuid4().hex
if data is None:
data = {}
if extra is None:
extra = {}
if not date:
date = datetime.datetime.utcnow()
if stack is None:
stack = self.auto_log_stacks
if '.' not in event_type:
# Assume it's a builtin
event_type = 'raven.events.%s' % event_type
handler = self.get_handler(event_type)
result = handler.capture(**kwargs)
# data (explicit) culprit takes over auto event detection
culprit = result.pop('culprit', None)
if data.get('culprit'):
culprit = data['culprit']
for k, v in result.iteritems():
if k not in data:
data[k] = v
if stack and 'sentry.interfaces.Stacktrace' not in data:
if stack is True:
frames = iter_stack_frames()
else:
frames = stack
data.update({
'sentry.interfaces.Stacktrace': {
'frames': get_stack_info(frames,
list_max_length=self.list_max_length,
string_max_length=self.string_max_length)
},
})
if 'sentry.interfaces.Stacktrace' in data:
if self.include_paths:
for frame in data['sentry.interfaces.Stacktrace']['frames']:
if frame.get('in_app') is not None:
continue
path = frame.get('module')
if not path:
continue
if path.startswith('raven.'):
frame['in_app'] = False
else:
frame['in_app'] = (any(path.startswith(x)
for x in self.include_paths)
and not any(path.startswith(x)
for x in self.exclude_paths))
if not culprit:
culprit = get_culprit(data['sentry.interfaces.Stacktrace']['frames'])
if not data.get('level'):
data['level'] = kwargs.get('level') or logging.ERROR
if not data.get('server_name'):
data['server_name'] = self.name
if not data.get('modules'):
data['modules'] = self.get_module_versions()
data['tags'] = tags or {}
data.setdefault('extra', {})
data.setdefault('level', logging.ERROR)
# Add extra context
if self.extra:
for k, v in self.extra.iteritems():
data['extra'].setdefault(k, v)
for k, v in extra.iteritems():
data['extra'][k] = v
if culprit:
data['culprit'] = culprit
if not data.get('checksum'):
checksum_bits = handler.get_hash(data)
else:
checksum_bits = data['checksum']
if isinstance(checksum_bits, (list, tuple)):
checksum = hashlib.md5()
for bit in checksum_bits:
checksum.update(to_string(bit))
checksum = checksum.hexdigest()
else:
checksum = checksum_bits
data['checksum'] = checksum
# Run the data through processors
for processor in self.get_processors():
data.update(processor.process(data))
if 'message' not in data:
data['message'] = handler.to_string(data)
data.setdefault('project', self.project)
# Legacy support for site attribute
site = data.pop('site', None) or self.site
if site:
data['tags'].setdefault('site', site)
# Make sure all data is coerced
data = self.transform(data)
# It's important date is added **after** we serialize
data.update({
'timestamp': date,
'time_spent': time_spent,
'event_id': event_id,
'platform': PLATFORM_NAME,
})
return data
def transform(self, data):
return transform(data, list_max_length=self.list_max_length,
string_max_length=self.string_max_length)
def context(self, **kwargs):
"""
Create default context around a block of code for exception management.
>>> with client.context(tags={'key': 'value'}) as raven:
>>> # use the context manager's client reference
>>> raven.captureMessage('hello!')
>>>
>>> # uncaught exceptions also contain the context
>>> 1 / 0
"""
return Context(self, **kwargs)
def capture(self, event_type, data=None, date=None, time_spent=None,
extra=None, stack=None, tags=None, **kwargs):
"""
Captures and processes an event and pipes it off to SentryClient.send.
To use structured data (interfaces) with capture:
>>> capture('raven.events.Message', message='foo', data={
>>> 'sentry.interfaces.Http': {
>>> 'url': '...',
>>> 'data': {},
>>> 'query_string': '...',
>>> 'method': 'POST',
>>> },
>>> 'logger': 'logger.name',
>>> }, extra={
>>> 'key': 'value',
>>> })
The finalized ``data`` structure contains the following (some optional)
builtin values:
>>> {
>>> # the culprit and version information
>>> 'culprit': 'full.module.name', # or /arbitrary/path
>>>
>>> # all detectable installed modules
>>> 'modules': {
>>> 'full.module.name': 'version string',
>>> },
>>>
>>> # arbitrary data provided by user
>>> 'extra': {
>>> 'key': 'value',
>>> }
>>> }
:param event_type: the module path to the Event class. Builtins can use
shorthand class notation and exclude the full module
path.
:param data: the data base, useful for specifying structured data
interfaces. Any key which contains a '.' will be
assumed to be a data interface.
:param date: the datetime of this event
:param time_spent: a float value representing the duration of the event
:param event_id: a 32-length unique string identifying this event
:param extra: a dictionary of additional standard metadata
:param culprit: a string representing the cause of this event
(generally a path to a function)
:return: a 32-length string identifying this event
"""
if not self.is_enabled():
return
data = self.build_msg(event_type, data, date, time_spent,
extra, stack, tags=tags, **kwargs)
self.send(**data)
return (data['event_id'], data['checksum'])
def _send_remote(self, url, data, headers={}):
parsed = urlparse(url)
transport = self._registry.get_transport(parsed)
return transport.send(data, headers)
def _get_log_message(self, data):
# decode message so we can show the actual event
try:
data = self.decode(data)
except:
message = '<failed decoding data>'
else:
message = data.pop('message', '<no message value>')
return message
def is_enabled(self):
"""
Return a boolean describing whether the client should attempt to send
events.
"""
return bool(self.servers)
def send_remote(self, url, data, headers={}):
if not self.state.should_try():
message = self._get_log_message(data)
self.error_logger.error(message)
return
try:
self._send_remote(url=url, data=data, headers=headers)
except Exception, e:
if isinstance(e, urllib2.HTTPError):
body = e.read()
self.error_logger.error('Unable to reach Sentry log server: %s (url: %%s, body: %%s)' % (e,), url, body,
exc_info=True, extra={'data': {'body': body, 'remote_url': url}})
else:
tmpl = 'Unable to reach Sentry log server: %s (url: %%s)'
self.error_logger.error(tmpl % (e,), url, exc_info=True,
extra={'data': {'remote_url': url}})
message = self._get_log_message(data)
self.error_logger.error('Failed to submit message: %r', message)
self.state.set_fail()
else:
class Client(object):
"""
The base Raven client.
Will read default configuration from the environment variable
``SENTRY_DSN`` if available.
>>> from raven import Client
>>> # Read configuration from ``os.environ['SENTRY_DSN']``
>>> client = Client()
>>> # Specify a DSN explicitly
>>> client = Client(dsn='https://*****:*****@sentry.local/project_id')
>>> # Record an exception
>>> try:
>>> 1/0
>>> except ZeroDivisionError:
>>> ident = client.get_ident(client.captureException())
>>> print "Exception caught; reference is %s" % ident
"""
logger = logging.getLogger('raven')
protocol_version = '6'
_registry = TransportRegistry(transports=default_transports)
def __init__(self, dsn=None, raise_send_errors=False, **options):
global Raven
o = options
self.configure_logging()
self.raise_send_errors = raise_send_errors
# configure loggers first
cls = self.__class__
self.state = ClientState()
self.logger = logging.getLogger('%s.%s' %
(cls.__module__, cls.__name__))
self.error_logger = logging.getLogger('sentry.errors')
self.dsns = {}
self.set_dsn(dsn, **options)
self.include_paths = set(o.get('include_paths') or [])
self.exclude_paths = set(o.get('exclude_paths') or [])
self.name = six.text_type(o.get('name') or defaults.NAME)
self.auto_log_stacks = bool(
o.get('auto_log_stacks') or defaults.AUTO_LOG_STACKS)
self.capture_locals = bool(
o.get('capture_locals', defaults.CAPTURE_LOCALS))
self.string_max_length = int(
o.get('string_max_length') or defaults.MAX_LENGTH_STRING)
self.list_max_length = int(
o.get('list_max_length') or defaults.MAX_LENGTH_LIST)
self.site = o.get('site', defaults.SITE)
self.include_versions = o.get('include_versions', True)
self.processors = o.get('processors')
if self.processors is None:
self.processors = defaults.PROCESSORS
context = o.get('context')
if context is None:
context = {'sys.argv': sys.argv[:]}
self.extra = context
self.tags = o.get('tags') or {}
self.release = o.get('release')
self.module_cache = ModuleProxyCache()
# servers may be set to a NoneType (for Django)
if not self.is_enabled():
self.logger.info(
'Raven is not configured (logging is disabled). Please see the'
' documentation for more information.')
if Raven is None:
Raven = self
self._context = Context()
def set_dsn(self, dsn=None, **options):
o = options
if dsn is None and os.environ.get('SENTRY_DSN'):
msg = "Configuring Raven from environment variable 'SENTRY_DSN'"
self.logger.debug(msg)
dsn = os.environ['SENTRY_DSN']
try:
servers, public_key, secret_key, project, transport_options = self.dsns[
dsn]
except KeyError:
if dsn:
# TODO: should we validate other options weren't sent?
urlparts = urlparse(dsn)
self.logger.debug(
"Configuring Raven for host: %s://%s:%s" %
(urlparts.scheme, urlparts.netloc, urlparts.path))
dsn_config = raven.load(dsn, transport_registry=self._registry)
servers = dsn_config['SENTRY_SERVERS']
project = dsn_config['SENTRY_PROJECT']
public_key = dsn_config['SENTRY_PUBLIC_KEY']
secret_key = dsn_config['SENTRY_SECRET_KEY']
transport_options = dsn_config.get('SENTRY_TRANSPORT_OPTIONS',
{})
else:
servers = ()
project = None
public_key = None
secret_key = None
transport_options = {}
self.dsns[
dsn] = servers, public_key, secret_key, project, transport_options
self.servers = servers
self.public_key = public_key
self.secret_key = secret_key
self.project = project or defaults.PROJECT
self.transport_options = transport_options
@classmethod
def register_scheme(cls, scheme, transport_class):
cls._registry.register_scheme(scheme, transport_class)
def configure_logging(self):
for name in ('raven', 'sentry'):
logger = logging.getLogger(name)
if logger.handlers:
continue
logger.addHandler(logging.StreamHandler())
logger.setLevel(logging.INFO)
def get_processors(self):
for processor in self.processors:
yield self.module_cache[processor](self)
def get_module_versions(self):
if not self.include_versions:
return {}
return get_versions(self.include_paths)
def get_ident(self, result):
"""
Returns a searchable string representing a message.
>>> result = client.capture(**kwargs)
>>> ident = client.get_ident(result)
"""
return '$'.join(result)
def get_handler(self, name):
return self.module_cache[name](self)
def _get_public_dsn(self):
url = urlparse(self.servers[0])
netloc = url.hostname
if url.port:
netloc += ':%s' % url.port
path = url.path.replace('api/%s/store/' % (self.project, ),
self.project)
return '//%s@%s%s' % (self.public_key, netloc, path)
def get_public_dsn(self, scheme=None):
"""
Returns a public DSN which is consumable by raven-js
>>> # Return scheme-less DSN
>>> print client.get_public_dsn()
>>> # Specify a scheme to use (http or https)
>>> print client.get_public_dsn('https')
"""
if not self.is_enabled():
return
url = self._get_public_dsn()
if not scheme:
return url
return '%s:%s' % (scheme, url)
def build_msg(self,
event_type,
data=None,
date=None,
time_spent=None,
extra=None,
stack=None,
public_key=None,
tags=None,
**kwargs):
"""
Captures, processes and serializes an event into a dict object
The result of ``build_msg`` should be a standardized dict, with
all default values available.
"""
# create ID client-side so that it can be passed to application
event_id = uuid.uuid4().hex
data = merge_dicts(self.context.data, data)
data.setdefault('tags', {})
data.setdefault('extra', {})
if '.' not in event_type:
# Assume it's a builtin
event_type = 'raven.events.%s' % event_type
handler = self.get_handler(event_type)
result = handler.capture(**kwargs)
# data (explicit) culprit takes over auto event detection
culprit = result.pop('culprit', None)
if data.get('culprit'):
culprit = data['culprit']
for k, v in six.iteritems(result):
if k not in data:
data[k] = v
# auto_log_stacks only applies to events that are not exceptions
# due to confusion about which stack is which and the automatic
# application of stacktrace to exception objects by Sentry
if stack is None and 'exception' not in data:
stack = self.auto_log_stacks
if stack and 'stacktrace' not in data:
if stack is True:
frames = iter_stack_frames()
else:
frames = stack
stack_info = get_stack_info(
frames,
transformer=self.transform,
capture_locals=self.capture_locals,
)
data.update({
'stacktrace': stack_info,
})
if 'stacktrace' in data and self.include_paths:
for frame in data['stacktrace']['frames']:
if frame.get('in_app') is not None:
continue
path = frame.get('module')
if not path:
continue
if path.startswith('raven.'):
frame['in_app'] = False
else:
frame['in_app'] = (any(
path.startswith(x)
for x in self.include_paths) and not any(
path.startswith(x) for x in self.exclude_paths))
if not culprit:
if 'stacktrace' in data:
culprit = get_culprit(data['stacktrace']['frames'])
elif 'exception' in data:
stacktrace = data['exception']['values'][0].get('stacktrace')
if stacktrace:
culprit = get_culprit(stacktrace['frames'])
if not data.get('level'):
data['level'] = kwargs.get('level') or logging.ERROR
if not data.get('server_name'):
data['server_name'] = self.name
if not data.get('modules'):
data['modules'] = self.get_module_versions()
if self.release is not None:
data['release'] = self.release
data['tags'] = merge_dicts(self.tags, data['tags'], tags)
data['extra'] = merge_dicts(self.extra, data['extra'], extra)
# Legacy support for site attribute
site = data.pop('site', None) or self.site
if site:
data['tags'].setdefault('site', site)
if culprit:
data['culprit'] = culprit
# Run the data through processors
for processor in self.get_processors():
data.update(processor.process(data))
if 'message' not in data:
data['message'] = kwargs.get('message', handler.to_string(data))
# tags should only be key=>u'value'
for key, value in six.iteritems(data['tags']):
data['tags'][key] = to_unicode(value)
# extra data can be any arbitrary value
for k, v in six.iteritems(data['extra']):
data['extra'][k] = self.transform(v)
# It's important date is added **after** we serialize
data.setdefault('project', self.project)
data.setdefault('timestamp', date or datetime.utcnow())
data.setdefault('time_spent', time_spent)
data.setdefault('event_id', event_id)
data.setdefault('platform', PLATFORM_NAME)
return data
def transform(self, data):
return transform(data,
list_max_length=self.list_max_length,
string_max_length=self.string_max_length)
@property
def context(self):
"""
Updates this clients thread-local context for future events.
>>> def view_handler(view_func, *args, **kwargs):
>>> client.context.merge(tags={'key': 'value'})
>>> try:
>>> return view_func(*args, **kwargs)
>>> finally:
>>> client.context.clear()
"""
return self._context
def user_context(self, data):
"""
Update the user context for future events.
>>> client.user_context({'email': '*****@*****.**'})
"""
return self.context.merge({
'user': data,
})
def http_context(self, data, **kwargs):
"""
Update the http context for future events.
>>> client.http_context({'url': 'http://example.com'})
"""
return self.context.merge({
'request': data,
})
def extra_context(self, data, **kwargs):
"""
Update the extra context for future events.
>>> client.extra_context({'foo': 'bar'})
"""
return self.context.merge({
'extra': data,
})
def tags_context(self, data, **kwargs):
"""
Update the tags context for future events.
>>> client.tags_context({'version': '1.0'})
"""
return self.context.merge({
'tags': data,
})
def capture(self,
event_type,
data=None,
date=None,
time_spent=None,
extra=None,
stack=None,
tags=None,
**kwargs):
"""
Captures and processes an event and pipes it off to SentryClient.send.
To use structured data (interfaces) with capture:
>>> capture('raven.events.Message', message='foo', data={
>>> 'request': {
>>> 'url': '...',
>>> 'data': {},
>>> 'query_string': '...',
>>> 'method': 'POST',
>>> },
>>> 'logger': 'logger.name',
>>> }, extra={
>>> 'key': 'value',
>>> })
The finalized ``data`` structure contains the following (some optional)
builtin values:
>>> {
>>> # the culprit and version information
>>> 'culprit': 'full.module.name', # or /arbitrary/path
>>>
>>> # all detectable installed modules
>>> 'modules': {
>>> 'full.module.name': 'version string',
>>> },
>>>
>>> # arbitrary data provided by user
>>> 'extra': {
>>> 'key': 'value',
>>> }
>>> }
:param event_type: the module path to the Event class. Builtins can use
shorthand class notation and exclude the full module
path.
:param data: the data base, useful for specifying structured data
interfaces. Any key which contains a '.' will be
assumed to be a data interface.
:param date: the datetime of this event
:param time_spent: a integer value representing the duration of the
event (in milliseconds)
:param extra: a dictionary of additional standard metadata
:param stack: a stacktrace for the event
:param tags: list of extra tags
:return: a tuple with a 32-length string identifying this event
"""
if not self.is_enabled():
return
data = self.build_msg(event_type,
data,
date,
time_spent,
extra,
stack,
tags=tags,
**kwargs)
self.send(**data)
return (data.get('event_id'), )
def _get_log_message(self, data):
# decode message so we can show the actual event
try:
data = self.decode(data)
except Exception:
message = '<failed decoding data>'
else:
message = data.pop('message', '<no message value>')
return message
def is_enabled(self):
"""
Return a boolean describing whether the client should attempt to send
events.
"""
return bool(self.servers)
def _successful_send(self):
self.state.set_success()
def _failed_send(self, e, url, data):
retry_after = 0
if isinstance(e, APIError):
if isinstance(e, RateLimited):
retry_after = e.retry_after
self.error_logger.error('Unable to capture event: %s(%s)',
e.__class__.__name__, e.message)
elif isinstance(e, HTTPError):
body = e.read()
self.error_logger.error(
'Unable to reach Sentry log server: %s (url: %s, body: %s)',
e,
url,
body,
exc_info=True,
extra={'data': {
'body': body[:200],
'remote_url': url
}})
else:
self.error_logger.error(
'Unable to reach Sentry log server: %s (url: %s)',
e,
url,
exc_info=True,
extra={'data': {
'remote_url': url
}})
message = self._get_log_message(data)
self.error_logger.error('Failed to submit message: %r', message)
self.state.set_fail(retry_after=retry_after)
def send_remote(self, url, data, headers=None):
# If the client is configured to raise errors on sending,
# the implication is that the backoff and retry strategies
# will be handled by the calling application
if headers is None:
headers = {}
if not self.raise_send_errors and not self.state.should_try():
message = self._get_log_message(data)
self.error_logger.error(message)
return
self.logger.debug('Sending message of length %d to %s', len(data), url)
def failed_send(e):
self._failed_send(e, url, data)
try:
parsed = urlparse(url)
transport = self._registry.get_transport(parsed,
**self.transport_options)
if transport. async:
transport.async_send(data, headers, self._successful_send,
failed_send)
else:
transport.send(data, headers)
self._successful_send()
except Exception as e:
if self.raise_send_errors:
raise
failed_send(e)
def send(self, auth_header=None, **data):
"""
Serializes the message and passes the payload onto ``send_encoded``.
"""
message = self.encode(data)
return self.send_encoded(message, auth_header=auth_header)
def send_encoded(self, message, auth_header=None, **kwargs):
"""
Given an already serialized message, signs the message and passes the
payload off to ``send_remote`` for each server specified in the servers
configuration.
"""
client_string = 'raven-python/%s' % (raven.VERSION, )
if not auth_header:
timestamp = time.time()
auth_header = get_auth_header(
protocol=self.protocol_version,
timestamp=timestamp,
client=client_string,
api_key=self.public_key,
api_secret=self.secret_key,
)
for url in self.servers:
headers = {
'User-Agent': client_string,
'X-Sentry-Auth': auth_header,
'Content-Type': 'application/octet-stream',
}
self.send_remote(url=url, data=message, headers=headers)
def encode(self, data):
"""
Serializes ``data`` into a raw string.
"""
return base64.b64encode(zlib.compress(json.dumps(data).encode('utf8')))
def decode(self, data):
"""
Unserializes a string, ``data``.
"""
return json.loads(
zlib.decompress(base64.b64decode(data)).decode('utf8'))
def captureMessage(self, message, **kwargs):
"""
Creates an event from ``message``.
>>> client.captureMessage('My event just happened!')
"""
return self.capture('raven.events.Message', message=message, **kwargs)
def captureException(self, exc_info=None, **kwargs):
"""
Creates an event from an exception.
>>> try:
>>> exc_info = sys.exc_info()
>>> client.captureException(exc_info)
>>> finally:
>>> del exc_info
If exc_info is not provided, or is set to True, then this method will
perform the ``exc_info = sys.exc_info()`` and the requisite clean-up
for you.
``kwargs`` are passed through to ``.capture``.
"""
return self.capture('raven.events.Exception',
exc_info=exc_info,
**kwargs)
def capture_exceptions(self, function_or_exceptions, **kwargs):
"""
Wrap a function in try/except and automatically call ``.captureException``
if it raises an exception, then the exception is reraised.
By default, it will capture ``Exception``
>>> @client.capture_exceptions
>>> def foo():
>>> raise Exception()
You can also specify exceptions to be caught specifically
>>> @client.capture_exceptions((IOError, LookupError))
>>> def bar():
>>> ...
``kwargs`` are passed through to ``.captureException``.
"""
def make_decorator(exceptions):
def decorator(func):
@wraps(func)
def wrapper(*funcargs, **funckwargs):
try:
return func(*funcargs, **funckwargs)
except exceptions:
self.captureException(**kwargs)
raise
return wrapper
return decorator
if isinstance(function_or_exceptions, FunctionType):
return make_decorator((Exception, ))(function_or_exceptions)
return make_decorator(function_or_exceptions)
def captureQuery(self, query, params=(), engine=None, **kwargs):
"""
Creates an event for a SQL query.
>>> client.captureQuery('SELECT * FROM foo')
"""
return self.capture('raven.events.Query',
query=query,
params=params,
engine=engine,
**kwargs)
def captureExceptions(self, **kwargs):
warnings.warn(
'captureExceptions is deprecated, used context() instead.',
DeprecationWarning)
return self.context(**kwargs)
class Client(object):
logger = logging.getLogger('raven')
protocol_version = '6'
_registry = TransportRegistry(transports=default_transports)
def __init__(self, dsn = None, raise_send_errors = False, transport = None, install_sys_hook = True, install_logging_hook = True, hook_libraries = None, enable_breadcrumbs = True, **options):
global Raven
o = options
self.raise_send_errors = raise_send_errors
cls = self.__class__
self.state = ClientState()
self.logger = logging.getLogger('%s.%s' % (cls.__module__, cls.__name__))
self.error_logger = logging.getLogger('sentry.errors')
self.uncaught_logger = logging.getLogger('sentry.errors.uncaught')
self._transport_cache = {}
self.set_dsn(dsn, transport)
self.include_paths = set(o.get('include_paths') or [])
self.exclude_paths = set(o.get('exclude_paths') or [])
self.name = text_type(o.get('name') or o.get('machine') or defaults.NAME)
self.auto_log_stacks = bool(o.get('auto_log_stacks') or defaults.AUTO_LOG_STACKS)
self.capture_locals = bool(o.get('capture_locals', defaults.CAPTURE_LOCALS))
self.string_max_length = int(o.get('string_max_length') or defaults.MAX_LENGTH_STRING)
self.list_max_length = int(o.get('list_max_length') or defaults.MAX_LENGTH_LIST)
self.site = o.get('site')
self.include_versions = o.get('include_versions', True)
self.processors = o.get('processors')
if self.processors is None:
self.processors = defaults.PROCESSORS
context = o.get('context')
if context is None:
context = {'sys.argv': sys.argv[:]}
self.extra = context
self.tags = o.get('tags') or {}
self.environment = o.get('environment') or None
self.release = o.get('release') or os.environ.get('HEROKU_SLUG_COMMIT')
self.ignore_exceptions = set(o.get('ignore_exceptions') or ())
self.module_cache = ModuleProxyCache()
if not self.is_enabled():
self.logger.info('Raven is not configured (logging is disabled). Please see the documentation for more information.')
if Raven is None:
Raven = self
self.main_thread_id = get_thread_ident()
self.enable_breadcrumbs = enable_breadcrumbs
from raven.context import Context
self._context = Context(self)
if install_sys_hook:
self.install_sys_hook()
if install_logging_hook:
self.install_logging_hook()
self.hook_libraries(hook_libraries)
def set_dsn(self, dsn = None, transport = None):
if not dsn and os.environ.get('SENTRY_DSN'):
msg = "Configuring Raven from environment variable 'SENTRY_DSN'"
self.logger.debug(msg)
dsn = os.environ['SENTRY_DSN']
if dsn not in self._transport_cache:
if not dsn:
result = RemoteConfig(transport=transport)
else:
result = RemoteConfig.from_string(dsn, transport=transport, transport_registry=self._registry)
self._transport_cache[dsn] = result
self.remote = result
else:
self.remote = self._transport_cache[dsn]
self.logger.debug('Configuring Raven for host: {0}'.format(self.remote))
def install_sys_hook(self):
global __excepthook__
if __excepthook__ is None:
__excepthook__ = sys.excepthook
def handle_exception(*exc_info):
self.captureException(exc_info=exc_info, level='fatal')
__excepthook__(*exc_info)
handle_exception.raven_client = self
sys.excepthook = handle_exception
def install_logging_hook(self):
from raven.breadcrumbs import install_logging_hook
install_logging_hook()
def hook_libraries(self, libraries):
from raven.breadcrumbs import hook_libraries
hook_libraries(libraries)
@classmethod
def register_scheme(cls, scheme, transport_class):
cls._registry.register_scheme(scheme, transport_class)
def get_processors(self):
for processor in self.processors:
yield self.module_cache[processor](self)
def get_module_versions(self):
if not self.include_versions:
return {}
version_info = sys.version_info
modules = get_versions(self.include_paths)
modules['python'] = '{0}.{1}.{2}'.format(version_info[0], version_info[1], version_info[2])
return modules
def get_ident(self, result):
warnings.warn('Client.get_ident is deprecated. The event ID is now returned as the result of capture.', DeprecationWarning)
return result
def get_handler(self, name):
return self.module_cache[name](self)
def get_public_dsn(self, scheme = None):
if not self.is_enabled():
return
url = self.remote.get_public_dsn()
if not scheme:
return url
return '%s:%s' % (scheme, url)
def _get_exception_key(self, exc_info):
code_id = 0
last_id = 0
try:
code_id = id(exc_info[2] and exc_info[2].tb_frame.f_code)
last_id = exc_info[2] and exc_info[2].tb_lasti or 0
except (AttributeError, IndexError):
pass
return (exc_info[0],
id(exc_info[1]),
code_id,
id(exc_info[2]),
last_id)
def skip_error_for_logging(self, exc_info):
key = self._get_exception_key(exc_info)
return key in self.context.exceptions_to_skip
def record_exception_seen(self, exc_info):
key = self._get_exception_key(exc_info)
self.context.exceptions_to_skip.add(key)
def build_msg(self, event_type, data = None, date = None, time_spent = None, extra = None, stack = None, public_key = None, tags = None, fingerprint = None, **kwargs):
event_id = uuid.uuid4().hex
data = merge_dicts(self.context.data, data)
data.setdefault('tags', {})
data.setdefault('extra', {})
if '.' not in event_type:
event_type = 'raven.events.%s' % event_type
handler = self.get_handler(event_type)
result = handler.capture(**kwargs)
culprit = result.pop('culprit', None)
if data.get('culprit'):
culprit = data['culprit']
for k, v in iteritems(result):
if k not in data:
data[k] = v
if stack is None and 'exception' not in data:
stack = self.auto_log_stacks
if stack and 'stacktrace' not in data:
if stack is True:
frames = iter_stack_frames()
else:
frames = stack
stack_info = get_stack_info(frames, transformer=self.transform, capture_locals=self.capture_locals)
data.update({'stacktrace': stack_info})
if self.include_paths:
for frame in self._iter_frames(data):
if frame.get('in_app') is not None:
continue
path = frame.get('module')
if not path:
continue
if path.startswith('raven.'):
frame['in_app'] = False
else:
frame['in_app'] = any((path.startswith(x) for x in self.include_paths)) and not any((path.startswith(x) for x in self.exclude_paths))
if not culprit:
if 'stacktrace' in data:
culprit = get_culprit(data['stacktrace']['frames'])
elif 'exception' in data:
stacktrace = data['exception']['values'][0].get('stacktrace')
if stacktrace:
culprit = get_culprit(stacktrace['frames'])
if not data.get('level'):
data['level'] = kwargs.get('level') or logging.ERROR
if not data.get('server_name'):
data['server_name'] = self.name
if not data.get('modules'):
data['modules'] = self.get_module_versions()
if self.release is not None:
data['release'] = self.release
if self.environment is not None:
data['environment'] = self.environment
data['tags'] = merge_dicts(self.tags, data['tags'], tags)
data['extra'] = merge_dicts(self.extra, data['extra'], extra)
site = data.pop('site', None) or self.site
if site:
data['tags'].setdefault('site', site)
if culprit:
data['culprit'] = culprit
if fingerprint:
data['fingerprint'] = fingerprint
for processor in self.get_processors():
data.update(processor.process(data))
if 'message' not in data:
data['message'] = kwargs.get('message', handler.to_string(data))
for key, value in iteritems(data['tags']):
data['tags'][key] = to_unicode(value)
for k, v in iteritems(data['extra']):
data['extra'][k] = self.transform(v)
data.setdefault('project', self.remote.project)
data.setdefault('timestamp', date or datetime.utcnow())
data.setdefault('time_spent', time_spent)
data.setdefault('event_id', event_id)
data.setdefault('platform', PLATFORM_NAME)
data.setdefault('sdk', SDK_VALUE)
if self.enable_breadcrumbs:
crumbs = self.context.breadcrumbs.get_buffer()
if crumbs:
data.setdefault('breadcrumbs', {'values': crumbs})
return data
def transform(self, data):
return transform(data, list_max_length=self.list_max_length, string_max_length=self.string_max_length)
@property
def context(self):
return self._context
def user_context(self, data):
return self.context.merge({'user': data})
def http_context(self, data, **kwargs):
return self.context.merge({'request': data})
def extra_context(self, data, **kwargs):
return self.context.merge({'extra': data})
def tags_context(self, data, **kwargs):
return self.context.merge({'tags': data})
def capture(self, event_type, data = None, date = None, time_spent = None, extra = None, stack = None, tags = None, **kwargs):
if not self.is_enabled():
return
exc_info = kwargs.get('exc_info')
if exc_info is not None:
if self.skip_error_for_logging(exc_info):
return
self.record_exception_seen(exc_info)
data = self.build_msg(event_type, data, date, time_spent, extra, stack, tags=tags, **kwargs)
self.send(**data)
return data['event_id']
def is_enabled(self):
return self.remote.is_active()
def _iter_frames(self, data):
if 'stacktrace' in data:
for frame in data['stacktrace']['frames']:
yield frame
if 'exception' in data:
for frame in data['exception']['values'][0]['stacktrace']['frames']:
yield frame
def _successful_send(self):
self.state.set_success()
def _failed_send(self, exc, url, data):
retry_after = 0
if isinstance(exc, APIError):
if isinstance(exc, RateLimited):
retry_after = exc.retry_after
self.error_logger.error('Sentry responded with an API error: %s(%s)', type(exc).__name__, exc.message)
else:
self.error_logger.error('Sentry responded with an error: %s (url: %s)', exc, url, exc_info=True, extra={'data': data})
self._log_failed_submission(data)
self.state.set_fail(retry_after=retry_after)
def _log_failed_submission(self, data):
message = data.pop('message', '<no message value>')
output = [message]
if 'exception' in data and 'stacktrace' in data['exception']['values'][0]:
for frame in data['exception']['values'][0]['stacktrace']['frames']:
output.append(' File "%(fn)s", line %(lineno)s, in %(func)s' % {'fn': frame['filename'],
'lineno': frame['lineno'],
'func': frame['function']})
self.uncaught_logger.error(output)
def send_remote(self, url, data, headers = None):
if headers is None:
headers = {}
if not self.raise_send_errors and not self.state.should_try():
data = self.decode(data)
self._log_failed_submission(data)
return
self.logger.debug('Sending message of length %d to %s', len(data), url)
def failed_send(e):
self._failed_send(e, url, self.decode(data))
try:
transport = self.remote.get_transport()
if transport.async:
transport.async_send(data, headers, self._successful_send, failed_send)
else:
transport.send(data, headers)
self._successful_send()
except Exception as e:
if self.raise_send_errors:
raise
failed_send(e)
def send(self, auth_header = None, **data):
message = self.encode(data)
return self.send_encoded(message, auth_header=auth_header)
def send_encoded(self, message, auth_header = None, **kwargs):
client_string = 'raven-python/%s' % (raven.VERSION,)
if not auth_header:
timestamp = time.time()
auth_header = get_auth_header(protocol=self.protocol_version, timestamp=timestamp, client=client_string, api_key=self.remote.public_key, api_secret=self.remote.secret_key)
headers = {'User-Agent': client_string,
'X-Sentry-Auth': auth_header,
'Content-Encoding': self.get_content_encoding(),
'Content-Type': 'application/octet-stream'}
return self.send_remote(url=self.remote.store_endpoint, data=message, headers=headers, **kwargs)
def get_content_encoding(self):
return 'deflate'
def encode(self, data):
return zlib.compress(json.dumps(data).encode('utf8'))
def decode(self, data):
return json.loads(zlib.decompress(data).decode('utf8'))
def captureMessage(self, message, **kwargs):
return self.capture('raven.events.Message', message=message, **kwargs)
def captureException(self, exc_info = None, **kwargs):
if exc_info is None or exc_info is True:
exc_info = sys.exc_info()
if not self.should_capture(exc_info):
self.logger.info('Not capturing exception due to filters: %s', exc_info[0], exc_info=sys.exc_info())
return
return self.capture('raven.events.Exception', exc_info=exc_info, **kwargs)
def should_capture(self, exc_info):
exc_type = exc_info[0]
exc_name = '%s.%s' % (exc_type.__module__, exc_type.__name__)
exclusions = self.ignore_exceptions
if exc_type.__name__ in exclusions:
return False
if exc_name in exclusions:
return False
if any((exc_name.startswith(e[:-1]) for e in exclusions if e.endswith('*'))):
return False
return True
def capture_exceptions(self, function_or_exceptions = None, **kwargs):
function = None
exceptions = (Exception,)
if isinstance(function_or_exceptions, FunctionType):
function = function_or_exceptions
elif function_or_exceptions is not None:
exceptions = function_or_exceptions
@contextlib.contextmanager
def make_decorator(exceptions):
try:
yield
except exceptions:
self.captureException(**kwargs)
raise
decorator = make_decorator(exceptions)
if function:
return decorator(function)
return decorator
def captureQuery(self, query, params = (), engine = None, **kwargs):
return self.capture('raven.events.Query', query=query, params=params, engine=engine, **kwargs)
def captureExceptions(self, **kwargs):
warnings.warn('captureExceptions is deprecated, used context() instead.', DeprecationWarning)
return self.context(**kwargs)
def captureBreadcrumb(self, *args, **kwargs):
self.context.breadcrumbs.record(*args, **kwargs)
capture_breadcrumb = captureBreadcrumb
class Client(object):
"""
The base Raven client, which handles both local direct
communication with Sentry (through the GroupedMessage API), as
well as communicating over the HTTP API to multiple servers.
Will read default configuration from the environment variable
``SENTRY_DSN`` if available.
>>> from raven import Client
>>> # Read configuration from ``os.environ['SENTRY_DSN']``
>>> client = Client()
>>> # Specify a DSN explicitly
>>> client =
>>> Client(dsn='https://*****:*****@sentry.local/project_id')
>>> # Configure the client manually
>>> client = Client(
>>> servers=['http://sentry.local/api/store/'],
>>> include_paths=['my.package'],
>>> project='project_id',
>>> public_key='public_key',
>>> secret_key='secret_key',
>>> )
>>> # Record an exception
>>> try:
>>> 1/0
>>> except ZeroDivisionError:
>>> ident = client.get_ident(client.captureException())
>>> print "Exception caught; reference is %s" % ident
"""
logger = logging.getLogger('raven')
protocol_version = '2.0'
_registry = TransportRegistry(transports=default_transports)
def __init__(self,
servers=None,
include_paths=None,
exclude_paths=None,
name=None,
auto_log_stacks=None,
key=None,
string_max_length=None,
list_max_length=None,
site=None,
public_key=None,
secret_key=None,
processors=None,
project=None,
dsn=None,
**kwargs):
# configure loggers first
cls = self.__class__
self.state = ClientState()
self.logger = logging.getLogger('%s.%s' %
(cls.__module__, cls.__name__))
self.error_logger = logging.getLogger('sentry.errors')
if isinstance(servers, basestring):
# must be a DSN:
if dsn:
# TODO: this should indicate what the caller can do to correct
# the constructor
msg = "You seem to be incorrectly instantiating the " + \
"raven Client class"
raise ValueError(msg)
dsn = servers
servers = None
if dsn is None and os.environ.get('SENTRY_DSN'):
msg = "Configuring Raven from environment variable 'SENTRY_DSN'"
self.logger.info(msg)
dsn = os.environ['SENTRY_DSN']
if dsn:
# TODO: should we validate other options werent sent?
urlparts = urlparse(dsn)
msg = "Configuring Raven for host: %s://%s:%s" % (
urlparts.scheme, urlparts.netloc, urlparts.path)
self.logger.info(msg)
options = raven.load(dsn, transport_registry=self._registry)
servers = options['SENTRY_SERVERS']
project = options['SENTRY_PROJECT']
public_key = options['SENTRY_PUBLIC_KEY']
secret_key = options['SENTRY_SECRET_KEY']
# servers may be set to a NoneType (for Django)
if servers and not (key or (secret_key and public_key)):
self.logger.info(
'Raven is not configured (disabled). Please see documentation for more information.'
)
if kwargs.get('timeout') is not None:
warnings.warn(
'The ``timeout`` option no longer does anything. Pass the option to your transport instead.'
)
self.servers = servers
self.include_paths = set(include_paths or defaults.INCLUDE_PATHS)
self.exclude_paths = set(exclude_paths or defaults.EXCLUDE_PATHS)
self.name = unicode(name or defaults.NAME)
self.auto_log_stacks = bool(auto_log_stacks
or defaults.AUTO_LOG_STACKS)
self.key = str(key or defaults.KEY)
self.string_max_length = int(string_max_length
or defaults.MAX_LENGTH_STRING)
self.list_max_length = int(list_max_length or defaults.MAX_LENGTH_LIST)
if (site or defaults.SITE):
self.site = unicode(site or defaults.SITE)
else:
self.site = None
self.public_key = public_key
self.secret_key = secret_key
self.project = project or defaults.PROJECT
self.processors = processors or defaults.PROCESSORS
self.module_cache = ModuleProxyCache()
@classmethod
def register_scheme(cls, scheme, transport_class):
cls._registry.register_scheme(scheme, transport_class)
def get_processors(self):
for processor in self.processors:
yield self.module_cache[processor](self)
def get_ident(self, result):
"""
Returns a searchable string representing a message.
>>> result = client.process(**kwargs)
>>> ident = client.get_ident(result)
"""
return '$'.join(result)
def get_handler(self, name):
return self.module_cache[name](self)
def build_msg(self,
event_type,
data=None,
date=None,
time_spent=None,
extra=None,
stack=None,
public_key=None,
tags=None,
**kwargs):
"""
Captures, processes and serializes an event into a dict object
"""
# create ID client-side so that it can be passed to application
event_id = uuid.uuid4().hex
if data is None:
data = {}
if extra is None:
extra = {}
if not date:
date = datetime.datetime.utcnow()
if stack is None:
stack = self.auto_log_stacks
if '.' not in event_type:
# Assume it's a builtin
event_type = 'raven.events.%s' % event_type
handler = self.get_handler(event_type)
result = handler.capture(**kwargs)
# data (explicit) culprit takes over auto event detection
culprit = result.pop('culprit', None)
if data.get('culprit'):
culprit = data['culprit']
for k, v in result.iteritems():
if k not in data:
data[k] = v
if stack and 'sentry.interfaces.Stacktrace' not in data:
if stack is True:
frames = iter_stack_frames()
else:
frames = stack
data.update({
'sentry.interfaces.Stacktrace': {
'frames':
varmap(
lambda k, v: shorten(v,
string_length=self.
string_max_length,
list_length=self.list_max_length),
get_stack_info(frames))
},
})
if 'sentry.interfaces.Stacktrace' in data and not culprit:
culprit = get_culprit(
data['sentry.interfaces.Stacktrace']['frames'],
self.include_paths, self.exclude_paths)
if not data.get('level'):
data['level'] = kwargs.get('level') or logging.ERROR
data['modules'] = get_versions(self.include_paths)
data['server_name'] = self.name
data['tags'] = tags
data.setdefault('extra', {})
data.setdefault('level', logging.ERROR)
# Shorten lists/strings
for k, v in extra.iteritems():
data['extra'][k] = shorten(v,
string_length=self.string_max_length,
list_length=self.list_max_length)
if culprit:
data['culprit'] = culprit
if 'checksum' not in data:
checksum_bits = handler.get_hash(data)
else:
checksum_bits = data['checksum']
if isinstance(checksum_bits, (list, tuple)):
checksum = hashlib.md5()
for bit in checksum_bits:
checksum.update(to_string(bit))
checksum = checksum.hexdigest()
else:
checksum = checksum_bits
data['checksum'] = checksum
# Run the data through processors
for processor in self.get_processors():
data.update(processor.process(data))
if 'message' not in data:
data['message'] = handler.to_string(data)
data.setdefault('project', self.project)
data.setdefault('site', self.site)
data.setdefault('public_key', self.public_key)
# Make sure all data is coerced
data = self.transform(data)
# It's important date is added **after** we serialize
data.update({
'timestamp': date,
'time_spent': time_spent,
'event_id': event_id,
})
return data
def transform(self, data):
return transform(data)
def capture(self,
event_type,
data=None,
date=None,
time_spent=None,
extra=None,
stack=None,
public_key=None,
tags=None,
**kwargs):
"""
Captures and processes an event and pipes it off to SentryClient.send.
To use structured data (interfaces) with capture:
>>> capture('Message', message='foo', data={
>>> 'sentry.interfaces.Http': {
>>> 'url': '...',
>>> 'data': {},
>>> 'query_string': '...',
>>> 'method': 'POST',
>>> },
>>> 'logger': 'logger.name',
>>> 'site': 'site.name',
>>> }, extra={
>>> 'key': 'value',
>>> })
The finalized ``data`` structure contains the following (some optional)
builtin values:
>>> {
>>> # the culprit and version information
>>> 'culprit': 'full.module.name', # or /arbitrary/path
>>>
>>> # all detectable installed modules
>>> 'modules': {
>>> 'full.module.name': 'version string',
>>> },
>>>
>>> # arbitrary data provided by user
>>> 'extra': {
>>> 'key': 'value',
>>> }
>>> }
:param event_type: the module path to the Event class. Builtins can use
shorthand class notation and exclude the full module
path.
:param data: the data base, useful for specifying structured data
interfaces. Any key which contains a '.' will be
assumed to be a data interface.
:param date: the datetime of this event
:param time_spent: a float value representing the duration of the event
:param event_id: a 32-length unique string identifying this event
:param extra: a dictionary of additional standard metadata
:param culprit: a string representing the cause of this event
(generally a path to a function)
:param public_key: the public key to use for this message
(defaults to ``Client.public_key``)
:return: a 32-length string identifying this event
"""
if not self.is_enabled():
return
data = self.build_msg(event_type,
data,
date,
time_spent,
extra,
stack,
public_key=public_key,
tags=tags,
**kwargs)
self.send(**data)
return (data['event_id'], data['checksum'])
def _send_remote(self, url, data, headers={}):
parsed = urlparse(url)
transport = self._registry.get_transport(parsed)
return transport.send(data, headers)
def _get_log_message(self, data):
# decode message so we can show the actual event
try:
data = self.decode(data)
except:
message = '<failed decoding data>'
else:
message = data.pop('message', '<no message value>')
return message
def is_enabled(self):
"""
Return a boolean describing whether the client should attempt to send
events.
"""
return bool(self.servers)
def send_remote(self, url, data, headers={}):
if not self.state.should_try():
message = self._get_log_message(data)
self.error_logger.error(message)
return
try:
self._send_remote(url=url, data=data, headers=headers)
except Exception, e:
if isinstance(e, urllib2.HTTPError):
body = e.read()
self.error_logger.error(
'Unable to reach Sentry log server: %s (url: %%s, body: %%s)'
% (e, ),
url,
body,
exc_info=True,
extra={'data': {
'body': body,
'remote_url': url
}})
else:
tmpl = 'Unable to reach Sentry log server: %s (url: %%s)'
self.error_logger.error(tmpl % (e, ),
url,
exc_info=True,
extra={'data': {
'remote_url': url
}})
message = self._get_log_message(data)
self.error_logger.error('Failed to submit message: %r', message)
self.state.set_fail()
else: