QcDiagnosticsBundle Namespace
A folder to hand in after a playtest (decision E-834): the logs of the newest sessions and all crash reports and dumps of <data>/logs, settings.ini and server.json without secrets, and info.txt with the build, the system, the mods and the worlds of the data folder (and the files that could not be copied). More...
| Header: | #include <common/diagnostics/QcDiagnosticsBundle.h> |
Classes
| struct | Contents |
Variables
| const char[12] | folderName |
| const int | keptSessions |
Functions
| QByteArray | cleanServerSettings(const QByteArray &json) |
| QByteArray | cleanSettings(const QByteArray &ini) |
| QcResult<QString> | write(const QcDiagnosticsBundle::Contents &contents) |
Detailed Description
Never the player key file, identities or worlds. A Windows memory dump holds memory of the process and so may hold a password typed in this session; the guide says so.
Variable Documentation
const char[12] QcDiagnosticsBundle::folderName
<data>/diagnostics: where the bundles go.
const int QcDiagnosticsBundle::keptSessions
Sessions per program whose logs the bundle carries (crash reports and dumps: all).
Function Documentation
QByteArray QcDiagnosticsBundle::cleanServerSettings(const QByteArray &json)
Returns server.json (json) with the values of such keys replaced by "<hidden>", at any depth.
QByteArray QcDiagnosticsBundle::cleanSettings(const QByteArray &ini)
Returns settings.ini (ini) without the values of keys that name a password, secret or token.
QcResult<QString> QcDiagnosticsBundle::write(const QcDiagnosticsBundle::Contents &contents)
Writes the bundle of contents into a new folder below <data>/diagnostics. Returns its path, or why it could not be written.