report-error.bbclass: new class to save build information when errors occur

Class is used to save data about errors after every task that failed.
Errors saved as json files in ERROR_REPORT_DIR (defaults to tmp/log/error-report).
To use this class one has to add INHERIT += "report-error" to local.conf.

scripts/send-error-report is a simple script that sends the json file
to a HTTP server that collects data (git://git.yoctoproject.org/error-report-web
is a Django web interface that can be used to receive and visualize
the error reports). The script will give you an URL where you can
find your report.

(From OE-Core rev: f186b4c7c6c975638e60b30a512d669dc6dc390f)

Signed-off-by: Andreea Proca <andreea.b.proca@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Andreea Proca 2014-02-14 13:58:43 +02:00 committed by Richard Purdie
parent 4cc0a43449
commit da0a4c7f8d
2 changed files with 144 additions and 0 deletions

View File

@ -0,0 +1,66 @@
#
# Collects debug information in order to create error report files.
#
# Copyright (C) 2013 Intel Corporation
# Author: Andreea Brandusa Proca <andreea.b.proca@intel.com>
#
# Licensed under the MIT license, see COPYING.MIT for details
ERR_REPORT_DIR ?= "${LOG_DIR}/error-report"
def errorreport_getdata(e):
logpath = e.data.getVar('ERR_REPORT_DIR', True)
datafile = os.path.join(logpath, "error-report.txt")
with open(datafile) as f:
data = f.read()
return data
def errorreport_savedata(e, newdata, file):
import json
logpath = e.data.getVar('ERR_REPORT_DIR', True)
bb.utils.mkdirhier(logpath)
datafile = os.path.join(logpath, file)
with open(datafile, "w") as f:
json.dump(newdata, f, indent=4, sort_keys=True)
return datafile
python errorreport_handler () {
import json
if isinstance(e, bb.event.BuildStarted):
data = {}
machine = e.data.getVar("MACHINE")
data['machine'] = machine
data['build_sys'] = e.data.getVar("BUILD_SYS", True)
data['nativelsb'] = e.data.getVar("NATIVELSBSTRING")
data['distro'] = e.data.getVar("DISTRO")
data['target_sys'] = e.data.getVar("TARGET_SYS", True)
data['failures'] = []
data['component'] = e.getPkgs()[0]
data['branch_commit'] = base_detect_branch(e.data) + ": " + base_detect_revision(e.data)
errorreport_savedata(e, data, "error-report.txt")
elif isinstance(e, bb.build.TaskFailed):
task = e.task
taskdata={}
log = e.data.getVar('BB_LOGFILE', True)
logFile = open(log, 'r')
taskdata['package'] = e.data.expand("${PF}")
taskdata['task'] = task
taskdata['log'] = logFile.read()
logFile.close()
jsondata = json.loads(errorreport_getdata(e))
jsondata['failures'].append(taskdata)
errorreport_savedata(e, jsondata, "error-report.txt")
elif isinstance(e, bb.event.BuildCompleted):
jsondata = json.loads(errorreport_getdata(e))
failures = jsondata['failures']
if(len(failures) > 0):
filename = "error_report_" + e.data.getVar("BUILDNAME")+".txt"
datafile = errorreport_savedata(e, jsondata, filename)
bb.note("The errors of this build are stored in: %s. You can send the errors to an upstream server by running: send-error-report %s [server]" % (datafile, datafile))
}
addhandler errorreport_handler
errorreport_handler[eventmask] = "bb.event.BuildStarted bb.event.BuildCompleted bb.build.TaskFailed"

78
scripts/send-error-report Executable file
View File

@ -0,0 +1,78 @@
#!/usr/bin/env python
# Sends an error report (if the report-error class was enabled) to a remote server.
#
# Copyright (C) 2013 Intel Corporation
# Author: Andreea Proca <andreea.b.proca@intel.com>
import httplib, urllib, os, sys, json
def sendData(json_file, server):
if os.path.isfile(json_file):
home = os.path.expanduser("~")
userfile = os.path.join(home, ".oe-send-error")
if os.path.isfile(userfile):
with open(userfile) as g:
username = g.readline()
email = g.readline()
else:
print("Please enter your name and your email (optionally), they'll be saved in the file you send.")
username = raw_input("Name: ")
email = raw_input("E-mail (not required): ")
if len(username) > 0 and len(username) < 50:
with open(userfile, "w") as g:
g.write(username + "\n")
g.write(email + "\n")
else:
print("Invalid inputs, try again.")
return
with open(json_file) as f:
data = f.read()
try:
jsondata = json.loads(data)
jsondata['username'] = username.strip()
jsondata['email'] = email.strip()
data = json.dumps(jsondata, indent=4, sort_keys=True)
except:
print("Invalid json data")
return
try:
params = urllib.urlencode({'data': data})
headers = {"Content-type": "application/json"}
conn = httplib.HTTPConnection(server)
conn.request("POST", "/ClientPost/", params, headers)
response = conn.getresponse()
print response.status, response.reason
res = response.read()
if response.status == 200:
print res
else:
print("There was a problem submiting your data")
conn.close()
except:
print("Server connection failed")
else:
print("No data file found.")
if __name__ == '__main__':
print ("\nSends an error report (if the report-error class was enabled) to a remote server.")
if len(sys.argv) < 2:
print("\nThis scripts sends the contents of a file to an upstream server.")
print("\nUsage: send-error-report <error_fileName> [server]")
print("\nIf this is the first when sending a report you'll be asked for your name and optionally your email address.")
print("They will be associated with your report.\n")
elif len(sys.argv) == 3:
sendData(sys.argv[1], sys.argv[2])
else:
sendData(sys.argv[1], "localhost:8000")