Difference between revisions of "AppSuite:Oxsysreport"
| 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 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. | + | 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.pub Support Key] when attaching this tarball. |
__TOC__ | __TOC__ | ||
| Line 107: | Line 107: | ||
= Features = | = Features = | ||
| − | == Directory for Temporary Process Data --tempdir == | + | == Directory for Temporary Process Data (--tempdir) == |
| − | == Root Folder Name of the Support Tarbal --logdir == | + | == Root Folder Name of the Support Tarbal (--logdir) == |
| − | == OX Support Tarball Name and Storage Location --log-archive == | + | == OX Support Tarball Name and Storage Location (--log-archive) == |
| − | == Keep Temporary Process Data --keep-tmp-files == | + | == Keep Temporary Process Data (--keep-tmp-files) == |
| + | 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. | ||
{{VersionFrom|7.6.0}} | {{VersionFrom|7.6.0}} | ||
| − | + | == Create Thread Dumps (--thread-dump) == | |
| − | + | {{VersionFrom|7.6.0}} | |
| − | + | == Create Heap Dumps (--heap-dump) == | |
| − | == Create Thread Dumps --thread-dump == | + | {{VersionFrom|7.6.0}} |
| − | + | == Skip Support Tarball Compression (--skip-compression) == | |
| − | == Create Heap Dumps --heap-dump == | + | {{VersionFrom|7.6.0}} |
| − | + | == Drop Older OX Logfiles from Support Tarball (--exclude-old-logs) == | |
| − | == Skip Support Tarball Compression --skip-compression == | + | {{VersionFrom|7.6.0}} |
| − | + | == Removes Confidential Details from OX Config Files (--exclude-ox-secrets) == | |
| − | == 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 13:50, 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.
Contents
- 1 Parameter Overview
- 2 Features
- 2.1 Directory for Temporary Process Data (--tempdir)
- 2.2 Root Folder Name of the Support Tarbal (--logdir)
- 2.3 OX Support Tarball Name and Storage Location (--log-archive)
- 2.4 Keep Temporary Process Data (--keep-tmp-files)
- 2.5 Create Thread Dumps (--thread-dump)
- 2.6 Create Heap Dumps (--heap-dump)
- 2.7 Skip Support Tarball Compression (--skip-compression)
- 2.8 Drop Older OX Logfiles from Support Tarball (--exclude-old-logs)
- 2.9 Removes Confidential Details from OX Config Files (--exclude-ox-secrets)
- 3 Examples
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)
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.
This information is valid from 7.6.0 on.
Create Thread Dumps (--thread-dump)
This information is valid from 7.6.0 on.
Create Heap Dumps (--heap-dump)
This information is valid from 7.6.0 on.
Skip Support Tarball Compression (--skip-compression)
This information is valid from 7.6.0 on.
Drop Older OX Logfiles from Support Tarball (--exclude-old-logs)
This information is valid from 7.6.0 on.