AppSuite:Oxsysreport - Revision history

Schweigi at 15:39, 10 January 2020

2020-01-10T15:39:11Z

← Older revision		Revision as of 15:39, 10 January 2020
Line 6:		Line 6:
	<div class="title">Creating an OX Support Tarball</div>		<div class="title">Creating an OX Support Tarball</div>

	The <code>/opt/open-xchange/sbin/oxsysreport</code> tool will collect 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 fast effective 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.		The <code>/opt/open-xchange/sbin/oxsysreport</code> tool will collect 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 fast effective help. We always recommend to encrypt your e-mail with our [https://confluence-public.open-xchange.com/display/SKB/How+to+send+an+encrypted+email+to+Open-Xchange+Support Support Key] when attaching this tarball.
	__TOC__		__TOC__

Maurice.delaferte at 16:35, 14 June 2016

2016-06-14T16:35:54Z

← Older revision		Revision as of 16:35, 14 June 2016
Line 48:		Line 48:
	\| <code>true false</code>		\| <code>true false</code>
	\| OX heapdump or jmap and sudo (Only if not IBM Java)		\| OX heapdump or jmap and sudo (Only if not IBM Java)
			\|-
			\| <code>--report-client</code>
			\| <code>false</code>
			\| <code>true false</code>
			\| Runs the OX Report Client
	\|-		\|-
	\| <code>--skip-compression</code>		\| <code>--skip-compression</code>
			\| <code>false</code>
			\| <code>true false</code>
			\|
			\|-
			\|-
			\| <code>--skip-system-tools</code>
	\| <code>false</code>		\| <code>false</code>
	\| <code>true false</code>		\| <code>true false</code>
Line 142:		Line 153:

	On IBM Java Systems the <code>jmap</code> command is not available and '<code>kill -ABRT</code>' will do the job instead. This will kill the JVM completely by writing the heap dump. Afterwards the dump will be moved within the tarball and processed by the tool <code>jextract</code>. Depending on <code>--skip-compression</code> option jextract will compress it as zip or not. The heap dump will be located in <code>/tmp/core.<timestamp>.dmp.zip</code> within the tarball. The <code>stdout/stderr</code> of jextract will be written to '<code>/commands/jextract core.<timestamp>.dmp (heap-dump)</code>'. On IBM Java the OX groupware service will be restarted by this script.		On IBM Java Systems the <code>jmap</code> command is not available and '<code>kill -ABRT</code>' will do the job instead. This will kill the JVM completely by writing the heap dump. Afterwards the dump will be moved within the tarball and processed by the tool <code>jextract</code>. Depending on <code>--skip-compression</code> option jextract will compress it as zip or not. The heap dump will be located in <code>/tmp/core.<timestamp>.dmp.zip</code> within the tarball. The <code>stdout/stderr</code> of jextract will be written to '<code>/commands/jextract core.<timestamp>.dmp (heap-dump)</code>'. On IBM Java the OX groupware service will be restarted by this script.

			{{VersionFrom\|7.8.2}}
			== Run OX Report Client (<code>--report-client</code>) ==
			The [[OXReportClient]] generates an overview about features and users from your database. On larger
			installations this tool may take very long and so we disabled it by default.

	{{VersionFrom\|7.6.0}}		{{VersionFrom\|7.6.0}}

Maurice.delaferte at 11:11, 17 October 2014

2014-10-17T11:11:46Z

← Older revision		Revision as of 11:11, 17 October 2014
Line 3:		Line 3:
	[[Category: OX6]]		[[Category: OX6]]
	[[Category: Administrator]]		[[Category: Administrator]]
			[[Category: Support]]
	<div class="title">Creating an OX Support Tarball</div>		<div class="title">Creating an OX Support Tarball</div>

Maurice.delaferte: /* Parameter Overview */

2014-10-07T08:30:44Z

Parameter Overview

← Older revision		Revision as of 08:30, 7 October 2014
Line 59:		Line 59:
	\|-		\|-
	\| <code>--exclude-ox-secrets</code>		\| <code>--exclude-ox-secrets</code>
	\| <code>false (true ~~since~~ OX 7.6.1)</code>		\| <code>false (true up from OX 7.6.1)</code>
	\| <code>true false</code>		\| <code>true false</code>
	\|		\|

Maurice.delaferte: /* Parameter Overview */

2014-10-07T08:24:26Z

Parameter Overview

← Older revision		Revision as of 08:24, 7 October 2014
Line 46:		Line 46:
	\| <code>false</code>		\| <code>false</code>
	\| <code>true false</code>		\| <code>true false</code>
	\| jmap, sudo (Only if not IBM Java)		\| OX heapdump or jmap and sudo (Only if not IBM Java)
	\|-		\|-
	\| <code>--skip-compression</code>		\| <code>--skip-compression</code>

Maurice.delaferte: /* Required Tools */

2014-10-07T08:22:10Z

Required Tools

← Older revision		Revision as of 08:22, 7 October 2014
Line 70:		Line 70:

	== Required Tools ==		== Required Tools ==
	We recommend to check if all required tools are installed before an incident happens. In case you 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 usually get installed in a default installation.		We recommend to check if all required tools are installed before an incident happens. In case you 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 usually get installed in a default installation. Please note, up from OX 7.6.1 we will
			use instead of 'jmap' the '/opt/open-xchange/sbin/heapdump' tool for heap dump creation by default, if supported by your JVM.

	{\| border="1"		{\| border="1"

Maurice.delaferte: /* Parameter Overview */

2014-10-07T08:13:55Z

Parameter Overview

← Older revision		Revision as of 08:13, 7 October 2014
Line 59:		Line 59:
	\|-		\|-
	\| <code>--exclude-ox-secrets</code>		\| <code>--exclude-ox-secrets</code>
	\| <code>false</code>		\| <code>false (true since OX 7.6.1)</code>
	\| <code>true false</code>		\| <code>true false</code>
	\|		\|

Maurice.delaferte: /* Required Tools */

2014-06-12T12:14:43Z

Required Tools

← Older revision		Revision as of 12:14, 12 June 2014
Line 103:		Line 103:
	\|-		\|-
	\|}		\|}

			Please note, on Univention systems you have to enable the 'Unmaintained' Repositories checkbox via 'App Center' --> 'Repository Settings' to get access to package listed above.

	= Features =		= Features =

Antje: /* Exclude old OX Log Files from Support Tarball (--exclude-old-logs) */

2014-06-02T09:58:34Z

Exclude old OX Log Files from Support Tarball (--exclude-old-logs)

← Older revision		Revision as of 09:58, 2 June 2014
Line 146:		Line 146:
	{{VersionFrom\|7.6.0}}		{{VersionFrom\|7.6.0}}

	== Exclude ~~old~~ OX Log Files from Support Tarball (<code>--exclude-old-logs</code>) ==		== Exclude Old OX Log Files from Support Tarball (<code>--exclude-old-logs</code>) ==
	We recommend to use this option if you are able to locate the period of a specific issue or by handing over an follow up tarball. This option will exclude all separate log files beyond the modified period which are stored on your system in <code>/var/log/open-xchange</code> or <code>/var/log/univention</code>. This option does not affect mandatory files like e.g. <code>open-xchange-console.log</code>. If logs are dropped they are listed in the generated overview file <code>/modified-and-excluded-files.txt</code> of the tarball.		We recommend to use this option if you are able to locate the period of a specific issue or by handing over an follow up tarball. This option will exclude all separate log files beyond the modified period which are stored on your system in <code>/var/log/open-xchange</code> or <code>/var/log/univention</code>. This option does not affect mandatory files like e.g. <code>open-xchange-console.log</code>. If logs are dropped they are listed in the generated overview file <code>/modified-and-excluded-files.txt</code> of the tarball.

Antje: /* Skip Support Tarball Compression (--skip-compression) */

2014-06-02T09:54:26Z

Skip Support Tarball Compression (--skip-compression)

← Older revision		Revision as of 09:54, 2 June 2014
Line 142:		Line 142:

	== Skip Support Tarball Compression (<code>--skip-compression</code>) ==		== Skip Support Tarball Compression (<code>--skip-compression</code>) ==
	Please use this option only in case your system is affected by very high CPU usage and the <code>oxsysreport</code> compression stuck by the lack of resources. If this option is set, no compression takes place and this will ~~effect~~ the OX Support Tarball, as well as nested tarballs and possible heap dumps. The resulting tarball can get huge and we recommend to keep the <code>--exclude-old-logs</code> option in mind to also drop potentially outdated logs. Please always compress this tarball before handing it over to our support department.		Please use this option only in case your system is affected by very high CPU usage and the <code>oxsysreport</code> compression stuck by the lack of resources. If this option is set, no compression takes place and this will affect the OX Support Tarball, as well as nested tarballs and possible heap dumps. The resulting tarball can get huge and we recommend to keep the <code>--exclude-old-logs</code> option in mind to also drop potentially outdated logs. Please always compress this tarball before handing it over to our support department.

	{{VersionFrom\|7.6.0}}		{{VersionFrom\|7.6.0}}