OS4X create log dumps - Revision history

Admin: /* Requirements */

2012-09-26T16:42:53Z

Requirements

Admin at 16:42, 26 September 2012

2012-09-26T16:42:25Z

Admin: /* Configuration */

2012-09-26T16:37:36Z

Configuration

Admin at 16:35, 26 September 2012

2012-09-26T16:35:02Z

Admin at 16:32, 26 September 2012

2012-09-26T16:32:49Z

Admin: /* Generating a dump */

2012-09-26T16:27:20Z

Generating a dump

Admin: /* Dumping log via command line */

2012-09-26T16:26:22Z

Dumping log via command line

Admin at 16:25, 26 September 2012

2012-09-26T16:25:14Z

Admin: New page: == What are OS4X dumps? == OS4X log dumps are binary files containing deep information about the system, like SQL statements, their results, network traffic, OFTP status information etc. E...

2012-09-26T16:20:43Z

New page: == What are OS4X dumps? == OS4X log dumps are binary files containing deep information about the system, like SQL statements, their results, network traffic, OFTP status information etc. E...

New page

== What are OS4X dumps? ==
OS4X log dumps are binary files containing deep information about the system, like SQL statements, their results, network traffic, OFTP status information etc. Every OS4X program generates OS4X log messages, which are organized by the daemon "<code>os4xdebugd</code>" (OS4X debug daemon).

== Requirements ==
In order to get an OS4X debug dump file, the daemon must be running. Verify this by [[OS4X_check_running_daemons#checking_OS4X_debug_daemon|checking the daemon's running state]]. The daemon must be running at least for three seconds in order to gather all needed information.

== Normal behaviour ==
All OS4X programs send their log information to the OS4X debug daemon. The daemon uses a ring buffer to save the logged messages, so with a limited amount of entries, the daemon will overwrite old entries when the buffer is full. The daemon process size depends on the amount of entries saved in memory. The more entries are configured, the bigger the process grows. A normal state should be about 2-5 MB in memory.

== Generating a dump ==
When a critical situation occurs, the daemon should be initialized to dump its content to an OS4X debug dump file. This can be in two ways:
*via web GUI
*via command line

=== Dumping log via web GUI ===

=== Dumping log via command line ===

== Customizing ==

=== Event script ===
=== Configuration ===

@@ Line 30: / Line 30: @@
   root@os4xbox:~# /opt/os4x/bin/os4xdebugd -d
   initiating dump...OK
 If the previous step fails, it may help to dump a log to the directory "<code>/tmp</code>", since the [[OS4X_Core_configuration#temporary_directory|OS4X's configurable temporary directory]] may be not available. Use the parameter "-D":
@@ Line 56: / Line 58: @@
 *The TCP/IP listening port of the debug daemon is [[OS4X_Core_configuration#TCP.2FIP_port_of_OS4X_debug_daemon|configurable]] at "Configuration" -> "TCP/IP" -> "TCP/IP port of OS4X debug daemon".
 *The OS4X debug daemon supports a "[[OS4X_Core_configuration#Enable_continuous_write_of_OS4X_debug_daemon_output.3F|continous debug write]]" mode which writes a logfile (and executes the event script) every time the ring buffer is full. Use with care, enable only when requested. This feature could fill up your filesystem quite fast: "Configuration" -> "Logging" -> "Enable continous write of OS4X debug daemon output?".

← Older revision		Revision as of 16:37, 26 September 2012
Line 54:		Line 54:

	=== Configuration ===		=== Configuration ===
−	*~~the~~ TCP/IP listening port of the debug daemon is [[OS4X_Core_configuration#TCP.2FIP_port_of_OS4X_debug_daemon\|configurable]] at "Configuration" -> "TCP/IP" -> "TCP/IP port of OS4X debug daemon"	+	*The TCP/IP listening port of the debug daemon is [[OS4X_Core_configuration#TCP.2FIP_port_of_OS4X_debug_daemon\|configurable]] at "Configuration" -> "TCP/IP" -> "TCP/IP port of OS4X debug daemon".
		+	*The OS4X debug daemon supports a "[[OS4X_Core_configuration#Enable_continuous_write_of_OS4X_debug_daemon_output.3F\|continous debug write]]" mode which writes a logfile (and executes the event script) every time the ring buffer is full. Use with care, enable only when requested. This feature could fill up your filesystem quite fast: "Configuration" -> "Logging" -> "Enable continous write of OS4X debug daemon output?".

← Older revision		Revision as of 16:35, 26 September 2012
Line 54:		Line 54:

	=== Configuration ===		=== Configuration ===
		+	*the TCP/IP listening port of the debug daemon is [[OS4X_Core_configuration#TCP.2FIP_port_of_OS4X_debug_daemon\|configurable]] at "Configuration" -> "TCP/IP" -> "TCP/IP port of OS4X debug daemon"

@@ Line 34: / Line 34: @@
   root@os4xbox:~# /opt/os4x/bin/os4xdebugd -D
   initiating dump to /tmp...OK
 == Customizing ==
 === Configuration ===

@@ Line 30: / Line 30: @@
   root@os4xbox:~# /opt/os4x/bin/os4xdebugd -d
   initiating dump...OK
 == Customizing ==

@@ Line 3: / Line 3: @@
 == Requirements ==
-In order to get an OS4X debug dump file, the daemon must be running. Verify this by [[OS4X_check_running_daemons#checking_OS4X_debug_daemon|checking the daemon's running state]]. The daemon must be running at least for three seconds in order to gather all needed information.
+In order to get an OS4X debug dump file, the daemon must be running. Verify this by [[OS4X_check_running_daemons#checking_OS4X_debug_daemon|checking the daemon's running state]]. The daemon must be running at least for three seconds in order to gather all needed information from running daemons.
 == Normal behaviour ==

@@ Line 27: / Line 27: @@
 === Dumping log via command line ===
+Dumping log via command line is quite easy: call the daemon binary with the parameter "<code>-d</code>":
 == Customizing ==

← Older revision		Revision as of 16:25, 26 September 2012
Line 14:		Line 14:

	=== Dumping log via web GUI ===		=== Dumping log via web GUI ===
		+	1. Select "Programs" -> "Daemons" in the administrative web interface:
		+
		+	[[Image:Programs-daemons.png]]
		+
		+	2.1 In the new panel, click on the button "Dump log", which is activated when the daemon is running:
		+
		+	[[Image:Os4xdebugd-dump.png]]
		+
		+	If the daemon is not running, it makes no sense to start it and dump for an ancient event: the event must occur when the daemon "<code>os4xdebugd</code>" is running.
		+
		+	2.2 If the previous step fails, it may help to dump a log to the directory "<code>/tmp</code>", since the [[OS4X_Core_configuration#temporary_directory\|OS4X's configurable temporary directory]] may be not available. Use the button "Dump to /tmp" in order to accomplish this task.

	=== Dumping log via command line ===		=== Dumping log via command line ===