AppSuite:Oxsysreport: Difference between revisions
From Open-Xchange
(Created page with "Test") |
(Initial WIP) |
||
| Line 1: | Line 1: | ||
<!-- Author: Maurice de la Ferté <maurice.delaferte@open-xchange.com> --> | |||
[[Category: Server]] | |||
[[Category: AppSuite]] | |||
[[Category: OX6]] | |||
[[Category: Admin]] | |||
<div class="title">Creating an OX Support Tarball</div> | |||
The 'oxsysreport' tool collects 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 help. | |||
__TOC__ | |||
= For Operators = | |||
== OLD Features == | |||
=== Directory for Temporary Process Data === | |||
=== Root Folder Name of the Support Tarball === | |||
=== OX Support Tarball Name and Storage Location === | |||
=== Keep Temporary Process Data === | |||
{{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 Heap Dump === | |||
=== Create Thread Dumps === | |||
=== Drop Older OX Logfiles from Support Tarball === | |||
=== Skip Support Tarball Compression === | |||
== Parameter Overview == | |||
{| border="1" | |||
|- | |||
| 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 | |||
| | |||
|- | |||
| --drop-older-logs-than | |||
| disabled | |||
| 0 ... n Days | |||
| | |||
|- | |||
| -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. | |||
{| border="1" | |||
|- | |||
| 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 | |||
| | |||
| | |||
| | |||
| | |||
|- | |||
|} | |||
== Examples == | |||
Revision as of 16:55, 22 May 2014
Creating an OX Support Tarball
The 'oxsysreport' tool collects 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 help.
For Operators
OLD Features
Directory for Temporary Process Data
Root Folder Name of the Support Tarball
OX Support Tarball Name and Storage Location
Keep Temporary Process Data
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.
Create Heap Dump
Create Thread Dumps
Drop Older OX Logfiles from Support Tarball
Skip Support Tarball Compression
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 | ||
| --drop-older-logs-than | disabled | 0 ... n Days | ||
| -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 |