def _request_data(request):
view_func = resolve(request.path)[0]
return {
'url' : request.build_absolute_uri(),
'component' : view_func.__module__,
'action' : view_func.__name__,
'params' : _parse_request(request).items(),
'session' : _parse_session(request.session).iteritems() if hasattr(request, 'session') else None,
'cgi-data' : _parse_environment(request).iteritems(),
}
def _request_data(request):
view_func = resolve(request.path)[0]
return {
'url':
request.build_absolute_uri(),
'component':
view_func.__module__,
'action':
view_func.__name__,
'params':
_parse_request(request).items(),
'session':
_parse_session(request.session).iteritems() if hasattr(
request, 'session') else None,
'cgi-data':
_parse_environment(request).iteritems(),
}
def generate_payload(request_tuple):
"""Generate an XML payload for a Hoptoad notification.
Parameters:
request_tuple -- A tuple containing a Django HTTPRequest and a possible
response code.
"""
request, response = request_tuple
hoptoad_settings = get_hoptoad_settings()
p_error_class, p_message = _handle_errors(request, response)
# api v2 from: http://help.hoptoadapp.com/faqs/api-2/notifier-api-v2
xdoc = getDOMImplementation().createDocument(None, "notice", None)
notice = xdoc.firstChild
# /notice/@version -- should be 2.0
notice.setAttribute('version', '2.0')
# /notice/api-key
api_key = xdoc.createElement('api-key')
api_key_data = xdoc.createTextNode(hoptoad_settings['HOPTOAD_API_KEY'])
api_key.appendChild(api_key_data)
notice.appendChild(api_key)
# /notice/notifier/name
# /notice/notifier/version
# /notice/notifier/url
notifier = xdoc.createElement('notifier')
for key, value in zip(["name", "version", "url"], [NAME, VERSION, URL]):
key = xdoc.createElement(key)
value = xdoc.createTextNode(str(value))
key.appendChild(value)
notifier.appendChild(key)
notice.appendChild(notifier)
# /notice/error/class
# /notice/error/message
error = xdoc.createElement('error')
for key, value in zip(["class", "message"], [p_error_class, p_message]):
key = xdoc.createElement(key)
value = xdoc.createTextNode(value)
key.appendChild(value)
error.appendChild(key)
# /notice/error/backtrace/error/line
backtrace = xdoc.createElement('backtrace')
# i do this here because I'm afraid of circular reference..
reversed_backtrace = list(
reversed(traceback.extract_tb(sys.exc_info()[2]))
)
if reversed_backtrace:
for filename, lineno, funcname, text in reversed_backtrace:
line = xdoc.createElement('line')
line.setAttribute('file', str(filename))
line.setAttribute('number', str(lineno))
line.setAttribute('method', str(funcname))
backtrace.appendChild(line)
else:
line = xdoc.createElement('line')
line.setAttribute('file', 'unknown')
line.setAttribute('number', '0')
line.setAttribute('method', 'unknown')
backtrace.appendChild(line)
error.appendChild(backtrace)
notice.appendChild(error)
# /notice/request
xrequest = xdoc.createElement('request')
# /notice/request/url -- request.build_absolute_uri()
xurl = xdoc.createElement('url')
xurl_data = xdoc.createTextNode(request.build_absolute_uri())
xurl.appendChild(xurl_data)
xrequest.appendChild(xurl)
# /notice/request/component -- not sure..
comp = xdoc.createElement('component')
#comp_data = xdoc.createTextNode('')
xrequest.appendChild(comp)
# /notice/request/action -- action which error occured
# ... no f*****g clue..
# sjl: "actions" are the Rails equivalent of Django's views
# Is there a way to figure out which view a request object went to
# (if any)? Anyway, it's not GET/POST so I'm commenting it for now.
#action = xdoc.createElement('action') # maybe GET/POST??
#action_data = u"%s %s" % (request.method, request.META['PATH_INFO'])
#action_data = xdoc.createTextNode(action_data)
#action.appendChild(action_data)
#xrequest.appendChild(action)
# /notice/request/params/var -- check request.GET/request.POST
req_params = _parse_request(request).items()
if req_params:
params = xdoc.createElement('params')
for key, value in req_params:
var = xdoc.createElement('var')
var.setAttribute('key', key)
value = xdoc.createTextNode(str(value))
var.appendChild(value)
params.appendChild(var)
xrequest.appendChild(params)
# /notice/request/session/var -- check if sessions is enabled..
sessions = xdoc.createElement('session')
for key, value in _parse_session(request.session).iteritems():
var = xdoc.createElement('var')
var.setAttribute('key', key)
value = xdoc.createTextNode(str(value))
var.appendChild(value)
sessions.appendChild(var)
xrequest.appendChild(sessions)
# /notice/request/cgi-data/var -- all meta data
cgidata = xdoc.createElement('cgi-data')
for key, value in _parse_environment(request).iteritems():
var = xdoc.createElement('var')
var.setAttribute('key', key)
value = xdoc.createTextNode(str(value))
var.appendChild(value)
cgidata.appendChild(var)
xrequest.appendChild(cgidata)
notice.appendChild(xrequest)
# /notice/server-environment
serverenv = xdoc.createElement('server-environment')
# /notice/server-environment/project-root -- default to sys.path[0]
projectroot = xdoc.createElement('project-root')
projectroot.appendChild(xdoc.createTextNode(sys.path[0]))
serverenv.appendChild(projectroot)
# /notice/server-environment/environment-name -- environment name? wtf..
envname = xdoc.createElement('environment-name')
# no idea...
# sjl: This is supposed to be set to something like "test", "staging",
# or "production" to help you group the errors in the web interface.
# I'm still thinking about the best way to support this.
# bmjames: Taking this from a settings variable. I personally have a
# different settings.py for every environment and my deploy
# script puts the correct one in place, so this makes sense.
# But even if one had a single settings.py shared among
# environments, it should be possible to set this variable
# dynamically. It would simply be the responsibility of
# settings.py to do it, rather than the hoptoad middleware.
envname_text = hoptoad_settings.get('HOPTOAD_ENV_NAME', 'Unknown')
envname_data = xdoc.createTextNode(envname_text)
envname.appendChild(envname_data)
serverenv.appendChild(envname)
notice.appendChild(serverenv)
return xdoc.toxml('utf-8')
def generate_payload(request, response=None, exception=None):
"""Generate an XML payload for a Hoptoad notification.
Arguments:
- `request`: The Django request object
- `response`: Optional. Response code that was received from the webserver
- `exception`: Optional. Can be a custom exception that implements
__str__ and has the class name of the error that is
required to be reported.
"""
hoptoad_settings = get_hoptoad_settings()
p_error_class, p_message = _handle_errors(request, response, exception)
# api v2 from: http://help.hoptoadapp.com/faqs/api-2/notifier-api-v2
xdoc = getDOMImplementation().createDocument(None, "notice", None)
notice = xdoc.firstChild
# /notice/@version -- should be 2.0
notice.setAttribute('version', '2.0')
# /notice/api-key
api_key = xdoc.createElement('api-key')
api_key_data = xdoc.createTextNode(hoptoad_settings['HOPTOAD_API_KEY'])
api_key.appendChild(api_key_data)
notice.appendChild(api_key)
# /notice/notifier/name
# /notice/notifier/version
# /notice/notifier/url
notifier = xdoc.createElement('notifier')
for key, value in zip(["name", "version", "url"], [NAME, VERSION, URL]):
key = xdoc.createElement(key)
value = xdoc.createTextNode(str(value))
key.appendChild(value)
notifier.appendChild(key)
notice.appendChild(notifier)
# /notice/error/class
# /notice/error/message
error = xdoc.createElement('error')
for key, value in zip(["class", "message"], [p_error_class, p_message]):
key = xdoc.createElement(key)
value = xdoc.createTextNode(value)
key.appendChild(value)
error.appendChild(key)
# /notice/error/backtrace/error/line
backtrace = xdoc.createElement('backtrace')
# i do this here because I'm afraid of circular reference..
reversed_backtrace = None
try:
reversed_backtrace = traceback.extract_tb(sys.exc_info()[2])
reversed_backtrace.reverse()
except AttributeError:
# if exception doesn't have a stack trace, then it might be a
# custom made exception.
# TODO: figure out how to do this cleanly
pass
if reversed_backtrace:
for filename, lineno, funcname, _text in reversed_backtrace:
line = xdoc.createElement('line')
line.setAttribute('file', str(filename))
line.setAttribute('number', str(lineno))
line.setAttribute('method', str(funcname))
backtrace.appendChild(line)
else:
line = xdoc.createElement('line')
line.setAttribute('file', 'unknown')
line.setAttribute('number', '0')
line.setAttribute('method', 'unknown')
backtrace.appendChild(line)
error.appendChild(backtrace)
notice.appendChild(error)
# /notice/request
xrequest = xdoc.createElement('request')
# /notice/request/url -- request.build_absolute_uri()
xurl = xdoc.createElement('url')
xurl_data = xdoc.createTextNode(request.build_absolute_uri())
xurl.appendChild(xurl_data)
xrequest.appendChild(xurl)
# /notice/request/component -- not sure..
comp = xdoc.createElement('component')
#comp_data = xdoc.createTextNode('')
xrequest.appendChild(comp)
# /notice/request/action -- action which error occured
# ... no f*****g clue..
# sjl: "actions" are the Rails equivalent of Django's views
# Is there a way to figure out which view a request object went to
# (if any)? Anyway, it's not GET/POST so I'm commenting it for now.
#action = xdoc.createElement('action') # maybe GET/POST??
#action_data = u"%s %s" % (request.method, request.META['PATH_INFO'])
#action_data = xdoc.createTextNode(action_data)
#action.appendChild(action_data)
#xrequest.appendChild(action)
# /notice/request/params/var -- check request.GET/request.POST
req_params = _parse_request(request).items()
if req_params:
params = xdoc.createElement('params')
for key, value in req_params:
var = xdoc.createElement('var')
var.setAttribute('key', key)
value = xdoc.createTextNode(str(value))
var.appendChild(value)
params.appendChild(var)
xrequest.appendChild(params)
# /notice/request/session/var -- check if sessions is enabled..
if hasattr(request, "session"):
sessions = xdoc.createElement('session')
for key, value in _parse_session(request.session).iteritems():
var = xdoc.createElement('var')
var.setAttribute('key', key)
value = xdoc.createTextNode(str(value))
var.appendChild(value)
sessions.appendChild(var)
xrequest.appendChild(sessions)
# /notice/request/cgi-data/var -- all meta data
cgidata = xdoc.createElement('cgi-data')
for key, value in _parse_environment(request).iteritems():
var = xdoc.createElement('var')
var.setAttribute('key', key)
value = xdoc.createTextNode(str(value))
var.appendChild(value)
cgidata.appendChild(var)
xrequest.appendChild(cgidata)
notice.appendChild(xrequest)
# /notice/server-environment
serverenv = xdoc.createElement('server-environment')
# /notice/server-environment/project-root -- default to sys.path[0]
projectroot = xdoc.createElement('project-root')
projectroot.appendChild(xdoc.createTextNode(sys.path[0]))
serverenv.appendChild(projectroot)
# /notice/server-environment/environment-name -- environment name? wtf..
envname = xdoc.createElement('environment-name')
# no idea...
# sjl: This is supposed to be set to something like "test", "staging",
# or "production" to help you group the errors in the web interface.
# I'm still thinking about the best way to support this.
# bmjames: Taking this from a settings variable. I personally have a
# different settings.py for every environment and my deploy
# script puts the correct one in place, so this makes sense.
# But even if one had a single settings.py shared among
# environments, it should be possible to set this variable
# dynamically. It would simply be the responsibility of
# settings.py to do it, rather than the hoptoad middleware.
envname_text = hoptoad_settings.get('HOPTOAD_ENV_NAME', 'Unknown')
envname_data = xdoc.createTextNode(envname_text)
envname.appendChild(envname_data)
serverenv.appendChild(envname)
notice.appendChild(serverenv)
return xdoc.toxml('utf-8')
def generate_payload(request, response=None, exception=None):
"""Generate an XML payload for a Hoptoad notification.
Arguments:
- `request`: The Django request object
- `response`: Optional. Response code that was received from the webserver
- `exception`: Optional. Can be a custom exception that implements
__str__ and has the class name of the error that is
required to be reported.
"""
hoptoad_settings = get_hoptoad_settings()
p_error_class, p_message = _handle_errors(request, response, exception)
# api v2 from: http://help.hoptoadapp.com/faqs/api-2/notifier-api-v2
xdoc = getDOMImplementation().createDocument(None, "notice", None)
notice = xdoc.firstChild
# /notice/@version -- should be 2.0
notice.setAttribute('version', '2.0')
# /notice/api-key
api_key = xdoc.createElement('api-key')
api_key_data = xdoc.createTextNode(hoptoad_settings['HOPTOAD_API_KEY'])
api_key.appendChild(api_key_data)
notice.appendChild(api_key)
# /notice/notifier/name
# /notice/notifier/version
# /notice/notifier/url
notifier = xdoc.createElement('notifier')
for key, value in zip(["name", "version", "url"], [NAME, VERSION, URL]):
key = xdoc.createElement(key)
value = xdoc.createTextNode(str(value))
key.appendChild(value)
notifier.appendChild(key)
notice.appendChild(notifier)
# /notice/error/class
# /notice/error/message
error = xdoc.createElement('error')
for key, value in zip(["class", "message"], [p_error_class, p_message]):
key = xdoc.createElement(key)
value = xdoc.createTextNode(value)
key.appendChild(value)
error.appendChild(key)
# /notice/error/backtrace/error/line
backtrace = xdoc.createElement('backtrace')
# i do this here because I'm afraid of circular reference..
reversed_backtrace = None
try:
reversed_backtrace = traceback.extract_tb(sys.exc_info()[2])
reversed_backtrace.reverse()
except AttributeError:
# if exception doesn't have a stack trace, then it might be a
# custom made exception.
# TODO: figure out how to do this cleanly
pass
if reversed_backtrace:
for filename, lineno, funcname, _text in reversed_backtrace:
line = xdoc.createElement('line')
line.setAttribute('file', str(filename))
line.setAttribute('number', str(lineno))
line.setAttribute('method', str(funcname))
backtrace.appendChild(line)
else:
line = xdoc.createElement('line')
line.setAttribute('file', 'unknown')
line.setAttribute('number', '0')
line.setAttribute('method', 'unknown')
backtrace.appendChild(line)
error.appendChild(backtrace)
notice.appendChild(error)
# /notice/request
xrequest = xdoc.createElement('request')
# /notice/request/url -- request.build_absolute_uri()
xurl = xdoc.createElement('url')
xurl_data = xdoc.createTextNode(request.build_absolute_uri())
xurl.appendChild(xurl_data)
xrequest.appendChild(xurl)
view_func = resolve(request.path)[0]
# /notice/request/component -- component where error occured
comp = xdoc.createElement('component')
comp_data = xdoc.createTextNode(view_func.__module__)
comp.appendChild(comp_data)
xrequest.appendChild(comp)
# /notice/request/action -- action which error occured
action = xdoc.createElement('action')
action_data = xdoc.createTextNode(view_func.__name__)
action.appendChild(action_data)
xrequest.appendChild(action)
# /notice/request/params/var -- check request.GET/request.POST
req_params = _parse_request(request).items()
if req_params:
params = xdoc.createElement('params')
for key, value in req_params:
var = xdoc.createElement('var')
var.setAttribute('key', key)
value = xdoc.createTextNode(str(value.encode('ascii', 'replace')))
var.appendChild(value)
params.appendChild(var)
xrequest.appendChild(params)
# /notice/request/session/var -- check if sessions is enabled..
if hasattr(request, "session"):
sessions = xdoc.createElement('session')
for key, value in _parse_session(request.session).iteritems():
var = xdoc.createElement('var')
var.setAttribute('key', key)
value = xdoc.createTextNode(str(value.encode('ascii', 'replace')))
var.appendChild(value)
sessions.appendChild(var)
xrequest.appendChild(sessions)
# /notice/request/cgi-data/var -- all meta data
cgidata = xdoc.createElement('cgi-data')
for key, value in _parse_environment(request).iteritems():
var = xdoc.createElement('var')
var.setAttribute('key', key)
value = xdoc.createTextNode(str(value.encode('ascii', 'replace')))
var.appendChild(value)
cgidata.appendChild(var)
xrequest.appendChild(cgidata)
notice.appendChild(xrequest)
# /notice/server-environment
serverenv = xdoc.createElement('server-environment')
# /notice/server-environment/project-root -- default to sys.path[0]
projectroot = xdoc.createElement('project-root')
projectroot.appendChild(xdoc.createTextNode(sys.path[0]))
serverenv.appendChild(projectroot)
# /notice/server-environment/environment-name -- environment name? wtf..
envname = xdoc.createElement('environment-name')
envname_text = getattr(settings, 'HOPTOAD_ENV_NAME', socket.gethostname())
envname_data = xdoc.createTextNode(envname_text)
envname.appendChild(envname_data)
serverenv.appendChild(envname)
appver = xdoc.createElement('app-version')
appver_text = getattr(settings, 'HOPTOAD_APP_VERSION', '0.0.0')
appver_data = xdoc.createTextNode(appver_text)
appver.appendChild(appver_data)
serverenv.appendChild(appver)
notice.appendChild(serverenv)
return xdoc.toxml('utf-8')
