rich-core-dumper

Manual Reference Pages - RICH-CORE-DUMPER (1)

NAME

rich-core-dumper - Create a rich core or oopslog dump

Synopsis
Description
Options
Examples
Files
See Also
Copyright

SYNOPSIS

rich-core-dumper [ --no-section-header]

rich-core-dumper gathers some metadata from the system (including but not limited to syslog, amount of free space on various partitions, software version etc) and creates a compressed rich core dump from it and the original core dump which it receives from stdin. Rich-core-dumper can also be used to generate other kinds of dumps, which currently includes oopslog dumps and custom dumps. Oopslog dumps, are otherwise similar to rich core dumps, but contain kernel OOPS data in place of a core dump. Finally, custom dumps can be used to store any custom data instead of oopslog or core dump data.

While creating a rich core, an oopslog or custom dump, the rich-core-dumper expects that either /media/mmc1/core-dumps or /media/mmc2/core-dumps directory exists. If both are available /media/mmc1/core-dumps is preferred, unless it has less than 5 MB of space left (if both directories exist and have less than 5 MB of space left, the one with more space is chosen).

Please note that if neither directory exists, the cores are silently discarded; the rich-core-dumper does not attempt to create the directories by itself. I.e. the existence of these directories can be used to enable and disable core dumping. In case of of oopslogs, the dumping is attempted again when the rich-core initscript is executed, typically during a boot.

Rich-core-dumper also creates simple statistics about crashes by maintaining per-application counters for the amount of created rich cores. The counters are stored on filesystem (see FILES section below).

The rich-core-dumper has some privacy-related configurable options. The main configuration file can contain the following options in KEY=value format (lowercase should be used for the values):

INCLUDE_CORE	Valid values for this setting are true and false. With value of n, no actual core dumps from crashes are included in the resulting rich-core files. If this key is not set in configuration file, core dumps will be included by default.
INCLUDE_SYSLOG	Valid values for this setting are true and false. With value of n, no syslog files are included in the resulting rich-core files. If this key is not set in the configuration file, syslogs will be included by default.
INCLUDE_PKGLIST	Valid values for this setting are true and false. With value of n, no list of packages installed on the system is included in the resulting rich-core file. If this key is not set in the configuration file, the list of packages is included by default.

In addition to the above, there can be whitelist and/or blacklist files /etc/rich-core.include and /etc/rich-core.exclude respectively. The format of the filterlist file is simple; each line of the file should contain exactly one application binary name (without path) that should be filtered. A simple example filterlist file is given below.

OPTIONS

--no-section-header

With this option, the rich-core-dumper can be invoked from other scripts or applications. It will expect to receive via stdin both a custom section header (generally, the follwowing format should be used: [---rich-core: yoursectionname---]) and the corresponding data, which will then be stored in place of the oopslog or core dump data. Multiple custom sections can be appended to the dump as long as all data is pushed in during the same invocation of rich-core-dumper. It is also possible to control the naming of the dumps by setting environmental variables CORE_EXE, CORE_SIG and CORE_PID prior to the invocation of the dumper.

EXAMPLES

An example rich-core configuration file that prevents syslogs, core dumps and list of installed packages from being included in rich-core files to increase privacy:

INCLUDE_CORE=false
INCLUDE_SYSLOG=false
INCLUDE_PKGLIST=false

An example filterlist (see FILES section for filesystem location):

osso-media-server
hildon-input-method

If such a list is given as a whitelist, only the osso-media-server and hildon-input-method crashes will produce rich cores with the above example.

FILES

/usr/share/nitro-settings/nitro-privacy.conf	The NITRO (Crash Reporter) configuration file for privacy options.
$HOME/nitro-privacy.conf	User private copy of above, changed via configuration.
/etc/rich-core.include
/etc/rich-core.exclude	List of executables that are to be white- or blacklisted for rich-core dump generation.
/etc/init.d/rich-core	Script to enable and disable rich core and oopslog dumping
/proc/sys/kernel/core_pattern	Contains a pattern for core dump filenames. If it begins with a pipe character, specified command is executed with core dump passed into stdin.
/var/lib/dsme/rich-cores/	The per-application rich core counter file storage directory.

COPYRIGHT

This is free software. You may redistribute copies of it under the terms of the GNU General Public License v2 included with the software. There is NO WARRANTY, to the extent permitted by law.

Improve this page

Register