Difference between revisions of "AppSuite:Oxsysreport"
(Initial WIP) |
|||
| Line 6: | Line 6: | ||
<div class="title">Creating an OX Support Tarball</div> | <div class="title">Creating an OX Support Tarball</div> | ||
| − | The 'oxsysreport' tool | + | The 'oxsysreport' tool is able to collect in a incident scenario a lot of useful log and system information into a tar archive. This so called OX Support Tarball contains Apache and OX configurations, OX logs and system information. This and a qualified Error Report makes sure that our support department get all needed details for a fast qualified help. We always recommend to encrypt your E-Mail with our [http://software.open-xchange.com/0x51E6AA1C-oxsupportkey.pubpublic| Support Key] when attaching this tarball. |
| − | for a fast help. | ||
__TOC__ | __TOC__ | ||
| − | + | = Parameter Overview = | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{| border="1" | {| border="1" | ||
| Line 49: | Line 22: | ||
| <directory> | | <directory> | ||
| | | | ||
| − | | | + | | |
|- | |- | ||
| --logdir | | --logdir | ||
| Line 81: | Line 54: | ||
| | | | ||
|- | |- | ||
| − | | -- | + | | --exclude-old-logs |
| disabled | | disabled | ||
| 0 ... n Days | | 0 ... n Days | ||
| + | | | ||
| + | |- | ||
| + | | --exclude-ox-secrets | ||
| + | | false | ||
| + | | true false | ||
| | | | ||
|- | |- | ||
| Line 92: | Line 70: | ||
|} | |} | ||
| − | + | == Required Tools == | |
We recommend to check if all required tools are installed before a incident happens. In case your are running IBM Java on e.g. SUSE Linux Enterprise, heap dumps will be created differently. Please note, we do not list package names which are usually get installed in a default installation. | We recommend to check if all required tools are installed before a incident happens. In case your are running IBM Java on e.g. SUSE Linux Enterprise, heap dumps will be created differently. Please note, we do not list package names which are usually get installed in a default installation. | ||
| Line 126: | Line 104: | ||
|- | |- | ||
|} | |} | ||
| + | |||
| + | == Features == | ||
| + | |||
| + | === Directory for Temporary Process Data --tempdir === | ||
| + | |||
| + | === Root Folder Name of the Support Tarbal --logdir === | ||
| + | |||
| + | === OX Support Tarball Name and Storage Location --log-archive === | ||
| + | |||
| + | === Keep Temporary Process Data --keep-tmp-files === | ||
| + | |||
| + | |||
| + | {{VersionFrom|7.6.0}} | ||
| + | == New Features == | ||
| + | By this new feautures it is possible to generate additional information which are potentially required to deal with high load, cpu or memory usage incidents. | ||
| + | |||
| + | === Create Thread Dumps --thread-dump === | ||
| + | |||
| + | === Create Heap Dumps --heap-dump === | ||
| + | |||
| + | === Skip Support Tarball Compression --skip-compression === | ||
| + | |||
| + | === Drop Older OX Logfiles from Support Tarball --exclude-old-logs === | ||
| + | |||
| + | === Removes Confidential Details from OX Config Files --exclude-ox-secrets === | ||
== Examples == | == Examples == | ||
Revision as of 11:18, 28 May 2014
Creating an OX Support Tarball
The 'oxsysreport' tool is able to collect in a incident scenario a lot of useful log and system information into a tar archive. This so called OX Support Tarball contains Apache and OX configurations, OX logs and system information. This and a qualified Error Report makes sure that our support department get all needed details for a fast qualified help. We always recommend to encrypt your E-Mail with our Support Key when attaching this tarball.
Parameter Overview
| Option | Default Values | Possible Values | Required Tools | |
| --tempdir | /tmp | <directory> | ||
| --logdir | ox_support_infos-<timestamp> | <folder name> | ||
| --log-archive | /tmp/ox_support_infos-<timestamp>.tar | <path to tarball> | ||
| --keep-tmp-files | false | true false | ||
| --thread-dump | false | true false | ||
| --heap-dump | false | true false | jmap, sudo (Only if not IBM Java) | |
| --skip-compression | false | true false | ||
| --exclude-old-logs | disabled | 0 ... n Days | ||
| --exclude-ox-secrets | false | true false | ||
| -h,--help | disabled |
Required Tools
We recommend to check if all required tools are installed before a incident happens. In case your are running IBM Java on e.g. SUSE Linux Enterprise, heap dumps will be created differently. Please note, we do not list package names which are usually get installed in a default installation.
| Tool | Debian | SUSE | Redhead | CentOS | Univention |
| bzip2 | bzip2 | ||||
| jmap | sun-java<version>-jdk openjdk-<version>-jdk | N/A | java-<version>-openjdk-devel | java-<version>-openjdk-devel | openjdk-<version>-jdk |
| sudo | sudo |
Features
Directory for Temporary Process Data --tempdir
Root Folder Name of the Support Tarbal --logdir
OX Support Tarball Name and Storage Location --log-archive
Keep Temporary Process Data --keep-tmp-files
This information is valid from 7.6.0 on.
New Features
By this new feautures it is possible to generate additional information which are potentially required to deal with high load, cpu or memory usage incidents.