1ABRT-PYTHON(5) abrt-python ABRT-PYTHON(5)
2
6 abrt-python - abrt-python Documentation
7 High-level API for querying, creating and manipulating problems handled
9 by ABRT in Python.
10 It works on top of low-level DBus or socket API provided by ABRT.
12 Socket API serves only as a fallback option for systems without new
13 DBus problem API as it can only handle the creation of new problems.
14 This project lives in the abrt repository and is distributed under
16 GPLv2 license.
17 Contents:
19
21 Creating new problem
22 import problem
23 prob = problem.Runtime(
25 reason='egg_error_message: assertion "error" failed',
26 )
27 prob.add_current_process_data()
29 prob.add_current_environment()
30 prob.save()
31 Creating problem for different executable
34 import problem
35 prob = problem.Selinux(reason='Front fell off')
37 prob.executable = '/usr/bin/time'
39 prob.save()
41 Adding custom data
44 import problem
45 prob = problem.Runtime(
47 reason='Error getting devices:'
48 'GDBus.Error:org.freedesktop.DBus.Error.UnknownMethod: '
49 'No such interface `org.gnome.SettingsDaemon.Power` on object at path '
50 '/org/gnome/SettingsDaemon/Power'
51 )
52 prob.add_current_process_data()
54 prob.custom_data = 'any'
55 prob['dict_access_example'] = 'works'
56 print(prob)
58 print('')
59 for key, value in prob.items():
61 print('{0}={1}'.format(key, value))
62 print('Identifier:', prob.save())
64 Querying problems
67 import problem
68 for prob in problem.list():
70 print(prob)
71 print(repr(prob.time))
72 if hasattr(prob, 'pid'):
73 print(prob.pid)
74 Querying all problems
77 The list method used with auth=True parameter will try to authenticate
78 via polkit to gain access to all problems on the system.
79 If there is no authentication agent running or authentication is unsuc‐
81 cessful, the list of problems which belong to current user is returned
82 (same as returned by the list method).
83 import problem
85 for prob in problem.list(auth=True):
87 print(prob)
88 if hasattr(prob, 'username'):
89 print('Problem belongs to {0}'.format(prob.username))
90 Editing existing problems
93 import problem
94 for prob in problem.list():
96 if prob.type == problem.JAVA:
97 prob.delete()
98 if prob.type == problem.CCPP:
100 if 'password' in prob.backtrace:
101 del prob.backtrace
102 prob.save()
103 if prob.type == problem.KERNELOOPS:
105 prob.backtrace = prob.backtrace.replace(' ?', '')
106 prob.save()
107 Watching for new problems
110 import problem
111 import logging
112 logging.basicConfig(level=logging.DEBUG)
114 def monitor(prob):
116 print(prob)
117 prob.delete()
118 pwatch = problem.get_problem_watcher()
120 pwatch.add_callback(monitor)
121 try:
123 pwatch.run()
124 except KeyboardInterrupt:
125 pwatch.quit()
126 Watching for new problems in a thread
129 from __future__ import print_function
130 import sys
132 import time
133 import problem
134 import threading
135 class ProblemWatchThread(threading.Thread):
137 def __init__(self):
138 super(ProblemWatchThread, self).__init__()
139 self.pwatch = problem.get_problem_watcher()
140 self.pwatch.add_callback(self.handle)
141 self.probcount = 0
142 def handle(self, prob):
144 self.probcount += 1
145 print('{0}: {1}'.format(self.probcount, prob))
146 # prob.delete()
147 def run(self):
149 self.pwatch.run()
150 def stop(self):
152 self.pwatch.quit()
153 pwt = ProblemWatchThread()
155 pwt.start()
156 i = 0
158 print('Waiting for new problem to appear')
159 spinner = ['\\', '|', '/', '-']
160 try:
162 while True:
163 time.sleep(0.1)
164 print('{0}\r'.format(spinner[i]), end='')
165 i += 1
166 i = i % len(spinner)
167 sys.stdout.flush()
168 except KeyboardInterrupt:
169 pwt.stop()
170 pwt.stop()
172 Getting bug numbers of problems reported to bugzilla
175 import problem
176 bugs = set()
178 for prob in problem.list():
180 if not hasattr(prob, 'reported_to'):
181 continue
182 for line in prob.reported_to.splitlines():
184 if line.startswith('Bugzilla:'):
185 bug_num = int(line.split('=')[-1])
186 bugs.add(bug_num)
187 print(bugs)
189
192 class problem.Problem(typ, reason, analyzer=None)
193 Base class for the other problem types.
194 No need to use this class directly, use one of the specific
196 problem classes.
197 add_current_environment()
199 Add environment of current process to this problem object
200 add_current_process_data()
202 Add pid, gid and executable of current process to this
203 problem object
204 chown()
206 Assures ownership of a problem for the caller
207 delete()
209 Delete this problem
210 prefetch_data()
212 Prefetch possible data fields of this problem
213 save() Create this problem or update modified data
215 Create or update the project if some of its fields were
217 modified.
218 Return None in case of modification, identifier if new
220 problem was created.
221 problem.list(auth=False)
223 Return the list of the problems
224 Use auth=True if authentication should be attempted.
226 If authentication via polkit fails, function behaves as if
228 auth=False was specified (only users problems are returned).
229 problem.get(identifier, auth=False)
231 Return problem object matching identifier
232 Return None in case the problem does not exist. Use auth=True
234 if authentication should be attempted.
235 problem.get_problem_watcher(auth=False)
237 Return ProblemWatcher object which can be used to attach call‐
238 backs called when new problem is created
239 Use auth=True if authentication should be attempted for new
241 problem that doesn't belong to current user. If not set such a
242 problem is ignored.
243 Specific problem types
245 class problem.Ccpp(reason)
246 C, C++ problem
247 class problem.Java(reason)
249 Java problem
250 class problem.Kerneloops(reason)
252 Kerneloops problem
253 class problem.Python(reason)
255 Python problem
256 class problem.Python3(reason)
258 Python3 problem
259 class problem.Runtime(reason)
261 Runtime problem
262 class problem.Selinux(reason)
264 Selinux problem
265 class problem.Unknown(reason)
267 Unknown problem
268 class problem.Xorg(reason)
270 Xorg problem
271 ProblemWatcher
273 class problem.watch.ProblemWatcher(auth)
274 New problem signal handler attached to DBus signal
275 Use auth=True if authentication should be attempted for new
277 problem that doesn't belong to current user. If not set such a
278 problem is ignored.
279 add_callback(fun)
281 Add callback to be called when new problem occurs.
282 Each callback function receives Problem instance
284 quit() Stop event listener loop
286 run() Start event listener loop
288
290 Currently, there is no strict specification of problem properties and
291 you are free to add your own data as you see fit (log files, process
292 data) provided you are planning to use them for reporting.
293 Mandatory properties required prior saving:
295 ┌───────────┬─────────────────────┬─────────────────┐
297 │Property │ Meaning │ Example │
298 ├───────────┼─────────────────────┼─────────────────┤
299 │executable │ Executable path of │ '/usr/bin/time' │
300 │ │ the component which │ │
301 │ │ caused the problem. │ │
302 │ │ Used by the server │ │
303 │ │ to determine compo‐ │ │
304 │ │ nent and package │ │
305 │ │ data. │ │
306 └───────────┴─────────────────────┴─────────────────┘
307 Following properties are added by the server when new problem is cre‐
309 ated:
310 ┌─────────────┬─────────────────────┬───────────────────────────┐
312 │Property │ Meaning │ Example │
313 ├─────────────┼─────────────────────┼───────────────────────────┤
314 │component │ Component which │ 'time' │
315 │ │ caused this prob‐ │ │
316 │ │ lem. │ │
317 ├─────────────┼─────────────────────┼───────────────────────────┤
318 │hostname │ Hostname of the │ 'fiasco' │
319 │ │ affected machine. │ │
320 ├─────────────┼─────────────────────┼───────────────────────────┤
321 │os_release │ Operating system │ 'Fedora release 17 │
322 │ │ release string. │ (Beefy Miracle)' │
323 ├─────────────┼─────────────────────┼───────────────────────────┤
324 │uid │ User ID │ 1000 │
325 ├─────────────┼─────────────────────┼───────────────────────────┤
326 │username │ │ 'jeff' │
327 ├─────────────┼─────────────────────┼───────────────────────────┤
328 │architecture │ Machine architec‐ │ 'x86_64' │
329 │ │ ture string │ │
330 ├─────────────┼─────────────────────┼───────────────────────────┤
331 │kernel │ Kernel version │ '3.6.6-1.fc17.x86_64' │
332 │ │ string │ │
333 ├─────────────┼─────────────────────┼───────────────────────────┤
334 │package │ Package string │ 'time-1.7-40.fc17.x86_64' │
335 ├─────────────┼─────────────────────┼───────────────────────────┤
336 │time │ Time of the occur‐ │ datetime.datetime(2012, │
337 │ │ rence (unixtime) │ 12, 2, 16, 18, 41) │
338 ├─────────────┼─────────────────────┼───────────────────────────┤
339 │count │ Number of times │ 1 │
340 │ │ this problem │ │
341 │ │ occurred │ │
342 └─────────────┴─────────────────────┴───────────────────────────┘
343 Parsed package data is also available:
345 ┌────────────┬─────────────────────┬───────────┐
348 │Property │ Meaning │ Example │
349 ├────────────┼─────────────────────┼───────────┤
350 │pkg_name │ Package name │ 'time' │
351 ├────────────┼─────────────────────┼───────────┤
352 │pkg_epoch │ Package epoch │ 0 │
353 ├────────────┼─────────────────────┼───────────┤
354 │pkg_version │ Package version │ '1.7' │
355 ├────────────┼─────────────────────┼───────────┤
356 │pkg_release │ Package release │ '40.fc17' │
357 ├────────────┼─────────────────────┼───────────┤
358 │pkg_arch │ Package architec‐ │ 'x86_64' │
359 │ │ ture │ │
360 └────────────┴─────────────────────┴───────────┘
361 Other common properties (presence differs based on problem type):
363┌─────────────────┬──────────────────┬──────────────────────────────────┬──────────────────┐
365│Property │ Meaning │ Example │ Applicable │
366├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
367│abrt_version │ ABRT version │ '2.0.18.84.g211c' │ Crashes caught │
368│ │ string │ │ by ABRT │
369├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
370│cgroup │ cgroup (control │ '9:perf_event:/\n8:blkio:/\n...' │ C/C++ │
371│ │ group) informa‐ │ │ │
372│ │ tion for crashed │ │ │
373│ │ process │ │ │
374├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
375│core_backtrace │ Machine readable │ │ C/C++, Python, │
376│ │ backtrace with │ │ Ruby, Kerneloops │
377│ │ no private data │ │ │
378├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
379│backtrace │ Original back‐ │ │ C/C++ (after │
380│ │ trace or back‐ │ │ retracing), │
381│ │ trace produced │ │ Python, Ruby, │
382│ │ by retracing │ │ Xorg, Kerneloops │
383│ │ process │ │ │
384├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
385│dso_list │ List of dynamic │ │ C/C++, Python │
386│ │ libraries loaded │ │ │
387│ │ at the time of │ │ │
388│ │ crash │ │ │
389├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
390│maps │ Copy of │ │ C/C++ │
391│ │ /proc/<pid>/maps │ │ │
392│ │ file of the │ │ │
393│ │ problem exe‐ │ │ │
394│ │ cutable │ │ │
395├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
396│cmdline │ Copy of │ '/usr/bin/gtk-builder-convert' │ C/C++, Python, │
397│ │ /proc/<pid>/cmd‐ │ │ Ruby, Kerneloops │
398│ │ line file │ │ │
399├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
400│coredump │ Coredump of the │ │ C/C++ │
401│ │ crashing process │ │ │
402├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
403│environ │ Runtime environ‐ │ │ C/C++, Python │
404│ │ ment of the │ │ │
405│ │ process │ │ │
406├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
407│open_fds │ List of file │ │ C/C++ │
408│ │ descriptors open │ │ │
409│ │ at the time of │ │ │
410│ │ crash │ │ │
411├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
412│pid │ Process ID │ '42' │ C/C++, Python, │
413│ │ │ │ Ruby │
414└─────────────────┴──────────────────┴──────────────────────────────────┴──────────────────┘
415│proc_pid_status │ Copy of │ │ C/C++ │
419│ │ /proc/<pid>/sta‐ │ │ │
420│ │ tus file │ │ │
421├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
422│limits │ Copy of │ │ C/C++ │
423│ │ /proc/<pid>/lim‐ │ │ │
424│ │ its file │ │ │
425├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
426│var_log_messages │ Part of the │ │ C/C++ │
427│ │ /var/log/mes‐ │ │ │
428│ │ sages file which │ │ │
429│ │ contains crash │ │ │
430│ │ information │ │ │
431├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
432│suspend_stats │ Copy of │ │ Kerneloops │
433│ │ /sys/ker‐ │ │ │
434│ │ nel/debug/sus‐ │ │ │
435│ │ pend_stats │ │ │
436├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
437│reported_to │ If the problem │ │ Reported prob‐ │
438│ │ was already │ │ lems │
439│ │ reported, this │ │ │
440│ │ item contains │ │ │
441│ │ URLs of the ser‐ │ │ │
442│ │ vices where it │ │ │
443│ │ was reported │ │ │
444├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
445│event_log │ ABRT event log │ │ Reported prob‐ │
446│ │ │ │ lems │
447├─────────────────┼──────────────────┼──────────────────────────────────┼──────────────────┤
448│dmesg │ Copy of dmesg │ │ Kerneloops │
449└─────────────────┴──────────────────┴──────────────────────────────────┴──────────────────┘
450 · genindex
452 · modindex
454 · search
456
458 Richard Marko
459
461 2012, Richard Marko
4620.1 Aug 10, 2019 ABRT-PYTHON(5)