~james-w/python-oops/update-readme-dependencies

« back to all changes in this revision

Viewing changes to oops/config.py

  • Committer: Robert Collins
  • Date: 2011-08-16 21:17:35 UTC
  • Revision ID: robertc@robertcollins.net-20110816211735-mry2ircf50wt75yf
New reporter and topic keys described.

Show diffs side-by-side

added added

removed removed

Lines of Context:
43
43
the inclusion of binary data in the report, and provides cross-language
44
44
compatibility.
45
45
 
 
46
A minimal report can be empty, but this is fairly useless and may even be
 
47
rejected by some repositories.
 
48
 
46
49
Some well known keys used by Launchpad in its OOPS reports::
47
50
 
48
51
* id: The name of this error report.
50
53
* value: The value of the exception that occurred.
51
54
* time: The time at which the exception occurred.
52
55
* pageid: The identifier for the template/script that oopsed.
 
56
  [deprecated: This maps to the new topic key instead.]
53
57
* branch_nick: The branch nickname.
54
58
* revno: The revision number of the branch.
55
59
* tb_text: A text version of the traceback.
59
63
* branch_nick: A name for the branch of code that was running when the report
60
64
  was triggered.
61
65
* revno: The revision that the branch was at.
62
 
* Informational: A flag, True if the error wasn't fatal- if it was
63
 
  'informational'.
 
66
* reporter: Describes the program creating the report. For instance you might
 
67
  put the name of the program, or its website - as long as its distint from
 
68
  other reporters.
 
69
* topic: The subject or context for the report. With a command line tool you
 
70
  might put the subcommand here, with a web site you might put the template (as
 
71
  opposed to the url). This is used as a weak correlation hint: reports from the
 
72
  same topic are more likely to have the same cause than reports from different
 
73
  topics.
64
74
"""
65
75
 
66
76