Blame src/python-problem/doc/properties.rst

Packit 8ea169
.. _properties:
Packit 8ea169
Packit 8ea169
Problem object properties
Packit 8ea169
=========================
Packit 8ea169
Packit 8ea169
Currently, there is no strict specification of problem properties
Packit 8ea169
and you are free to add your own data as you see fit
Packit 8ea169
(log files, process data) provided you are planning to use
Packit 8ea169
them for reporting.
Packit 8ea169
Packit 8ea169
Mandatory properties required prior saving:
Packit 8ea169
Packit 8ea169
===================== ======================================================== ====================
Packit 8ea169
Property              Meaning                                                  Example
Packit 8ea169
===================== ======================================================== ====================
Packit 8ea169
``executable``        Executable path of the component which caused the        ``'/usr/bin/time'``
Packit 8ea169
                      problem.  Used by the server to determine
Packit 8ea169
                      ``component`` and ``package`` data.
Packit 8ea169
===================== ======================================================== ====================
Packit 8ea169
Packit 8ea169
Following properties are added by the server when new problem is
Packit 8ea169
created:
Packit 8ea169
Packit 8ea169
===================== ======================================================== ====================
Packit 8ea169
Property              Meaning                                                  Example
Packit 8ea169
===================== ======================================================== ====================
Packit 8ea169
``component``         Component which caused this problem.                     ``'time'``
Packit 8ea169
``hostname``          Hostname of the affected machine.                        ``'fiasco'``
Packit 8ea169
``os_release``        Operating system release string.                         ``'Fedora release 17 (Beefy Miracle)'``
Packit 8ea169
``uid``               User ID                                                  ``1000``
Packit 8ea169
``username``                                                                   ``'jeff'``
Packit 8ea169
``architecture``      Machine architecture string                              ``'x86_64'``
Packit 8ea169
``kernel``            Kernel version string                                    ``'3.6.6-1.fc17.x86_64'``
Packit 8ea169
``package``           Package string                                           ``'time-1.7-40.fc17.x86_64'``
Packit 8ea169
``time``              Time of the occurrence (unixtime)                        ``datetime.datetime(2012, 12, 2, 16, 18, 41)``
Packit 8ea169
``count``             Number of times this problem occurred                    ``1``
Packit 8ea169
===================== ======================================================== ====================
Packit 8ea169
Packit 8ea169
Parsed package data is also available:
Packit 8ea169
Packit 8ea169
===================== ======================================================== ====================
Packit 8ea169
Property              Meaning                                                  Example
Packit 8ea169
===================== ======================================================== ====================
Packit 8ea169
``pkg_name``          Package name                                             ``'time'``
Packit 8ea169
``pkg_epoch``         Package epoch                                            ``0``
Packit 8ea169
``pkg_version``       Package version                                          ``'1.7'``
Packit 8ea169
``pkg_release``       Package release                                          ``'40.fc17'``
Packit 8ea169
``pkg_arch``          Package architecture                                     ``'x86_64'``
Packit 8ea169
===================== ======================================================== ====================
Packit 8ea169
Packit 8ea169
Other common properties (presence differs based on problem type):
Packit 8ea169
Packit 8ea169
===================== ======================================================== ====================================== ===============================
Packit 8ea169
Property              Meaning                                                  Example                                Applicable
Packit 8ea169
===================== ======================================================== ====================================== ===============================
Packit 8ea169
``abrt_version``      ABRT version string                                      ``'2.0.18.84.g211c'``                  Crashes caught by ABRT
Packit 8ea169
``cgroup``            cgroup (control group) information for crashed process   ``'9:perf_event:/\n8:blkio:/\n...'``   C/C++
Packit 8ea169
``core_backtrace``    Machine readable backtrace with no private data                                                 C/C++, Python, Ruby, Kerneloops
Packit 8ea169
``backtrace``         Original backtrace or backtrace produced by retracing                                           C/C++ (after retracing), Python, Ruby, Xorg, Kerneloops
Packit 8ea169
                      process
Packit 8ea169
``dso_list``          List of dynamic libraries loaded at the time of crash                                           C/C++, Python
Packit 8ea169
``maps``              Copy of /proc/<pid>/maps file of the problem executable                                         C/C++
Packit 8ea169
``cmdline``           Copy of /proc/<pid>/cmdline file                         ``'/usr/bin/gtk-builder-convert'``     C/C++, Python, Ruby, Kerneloops
Packit 8ea169
``coredump``          Coredump of the crashing process                                                                C/C++
Packit 8ea169
``environ``           Runtime environment of the process                                                              C/C++, Python
Packit 8ea169
``open_fds``          List of file descriptors open at the time of crash                                              C/C++
Packit 8ea169
``pid``               Process ID                                               ``'42'``                               C/C++, Python, Ruby
Packit 8ea169
``proc_pid_status``   Copy of /proc/<pid>/status file                                                                 C/C++
Packit 8ea169
``limits``            Copy of /proc/<pid>/limits file                                                                 C/C++
Packit 8ea169
``var_log_messages``  Part of the /var/log/messages file which contains crash
Packit 8ea169
                      information                                                                                     C/C++
Packit 8ea169
``suspend_stats``     Copy of /sys/kernel/debug/suspend_stats                                                         Kerneloops
Packit 8ea169
``reported_to``       If the problem was already reported, this item contains                                         Reported problems
Packit 8ea169
                      URLs of the services where it was reported
Packit 8ea169
``event_log``         ABRT event log                                                                                  Reported problems
Packit 8ea169
``dmesg``             Copy of dmesg                                                                                   Kerneloops
Packit 8ea169
===================== ======================================================== ====================================== ===============================