Admins:LogSystem - Revision history

Cynnar at 01:23, 4 August 2015

2015-08-04T01:23:08Z

Cynnar at 01:04, 4 August 2015

2015-08-04T01:04:41Z

Cynnar at 20:32, 3 August 2015

2015-08-03T20:32:58Z

Cynnar at 20:26, 3 August 2015

2015-08-03T20:26:55Z

John adams at 15:04, 19 September 2012

2012-09-19T15:04:58Z

John adams: /* EQ2Emulator: Log System */

2012-09-19T14:58:34Z

‎EQ2Emulator: Log System

John adams at 14:55, 19 September 2012

2012-09-19T14:55:08Z

John adams: Created page with "== EQ2Emulator: Log System == The 'log_config.xml' file is the '''optional''' Log System configuration file for EQ2Emulator Server. All loggers have default settings defined in t..."

2012-08-02T15:29:14Z

Created page with "== EQ2Emulator: Log System == The 'log_config.xml' file is the '''optional''' Log System configuration file for EQ2Emulator Server. All loggers have default settings defined in t..."

New page

== EQ2Emulator: Log System ==
The 'log_config.xml' file is the '''optional''' Log System configuration file for EQ2Emulator Server. All loggers have default settings defined in the code (LogTypes.h) and this file is used to override those defaults without having to recompile the code.

The LogWrite system consists of these elements:
LogWrite(CATEGORY__TYPE, "Tag", "Formatted Text", params);

=== Categories ===
This is the list of current CATEGORIES available:

==== System Loggers ====
WORLD
LOGIN
PATCHER
PARSER
INIT
DATABASE
MUTEX
MISC

==== Network Loggers ====
CCLIENT
NET
OPCODE
PACKET

==== Player Loggers ====
PLAYER

==== SubSystem Loggers ====
CHAT
COLLECTIONS
COMBAT
COMMAND
FACTION
GUILD
ITEM
LOOT
LUA
MERCHANT
NPC
NPC_AI
QUEST
RECIPES
RULES
SKILLS
SPELLS
TRADESKILLS

==== Spawn Loggers ====
SPAWN
OBJECT
SIGN
WIDGET
GROUNDSPAWN

==== Zone Loggers ====
ZONE
INSTANCE

=== Types ===
All CATEGORIES have 7 TYPES, with some categories having a few extra as needed:

INFO
WARNING
ERROR
DEBUG
PACKET
DETAIL
DATA

=== Color ===
The "Color" parameter allows you to set your own color for the log entry (restricted to defined colors in code)

White/WhiteBold
Yellow/YellowBold
Red/RedBold
Green/GreenBold
Blue/BlueBold
Cyan/CyanBold
Magenta/MagentaBold

=== Enabled ===
The "Enabled" parameter allows you to toggle the logger on or off without removing the entry from log_config.xml

=== Logs ===
The "Logs" parameter lets you direct the logger to one of 3 outputs, or any combination of the 3 (bitwise):

1 = Log File (logs folder under EQ2World.exe folder)
2 = Console
4 = Client (not currently implemented)

Examples:
To direct logger output to both File and Console, Logs="3"
To direct logger output to just Console, Logs="2"
To direct logger output to just File, Logs="1"

=== Example ===
Example LogConfig (you can use any 1 TYPE definition, you do not need them all, but the XML must be formatted as follows):

<LogConfig Category="WORLD">
<ConfigType Type="DEBUG" Color="GreenBold" Enabled="True" Logs="3" />
<ConfigType Type="DATA" Color="White" Enabled="True" Logs="1" />
</LogConfig>

This example overrides the default WORLD category, DEBUG and DATA types, to write to the console and/or just the log file.

@@ Line 18: / Line 18: @@
 {|style="table-layout:fixed; width: 100%;"
-|{{TextBox|Network Loggers|  CCLIENT
+|{{TextBox|Network Loggers|CCLIENT<br/>NET<br/>OPCODE<br/>PACKET|BackgroundColor=ffffff|FontColor=000}}
 {|style="table-layout:fixed; width: 100%;"
-|{{TextBox|Player Loggers|  PLAYER|BackgroundColor=ffffff|FontColor=000}}
+|{{TextBox|Player Loggers|PLAYER|BackgroundColor=ffffff|FontColor=000}}
 {|style="table-layout:fixed; width: 100%;"
-|{{TextBox|SubSystem Loggers|  CHAT
+|{{TextBox|SubSystem Loggers|CHAT<br/>COLLECTIONS<br/>COMBAT<br/>COMMAND<br/>FACTION<br/>GUILD<br/>ITEM<br/>LOOT<br/>LUA<br/>MERCHANT<br/>NPC<br/>NPC_AI<br/>QUEST<br/>RECIPES<br/>RULES<br/>SKILLS<br/>SPELLS<br/>TRADESKILLS|BackgroundColor=ffffff|FontColor=000}}
 {|style="table-layout:fixed; width: 100%;"
-|{{TextBox|Spawn Loggers|  SPAWN
+|{{TextBox|Spawn Loggers|SPAWN<br/>OBJECT<br/>SIGN<br/>WIDGET<br/>GROUNDSPAWN|BackgroundColor=ffffff|FontColor=000}}
 {|style="table-layout:fixed; width: 100%;"
-|{{TextBox|Zone Loggers|  ZONE
+|{{TextBox|Zone Loggers|ZONE<br/>INSTANCE|BackgroundColor=ffffff|FontColor=000}}

@@ Line 15: / Line 15: @@
 {|style="table-layout:fixed; width: 100%;"
-|{{TextBox|System Loggers|  WORLD
+|{{TextBox|System Loggers|WORLD<br/>LOGIN<br/>PATCHER<br/>PARSER<br/>INIT<br/>DATABASE<br/>MUTEX<br/>MISC|BackgroundColor=ffffff|FontColor=000}}
 {|style="table-layout:fixed; width: 100%;"

@@ Line 1: / Line 1: @@
 {{PageHeaderChild|Admins|Log System}}
 <br/>
 The 'log_config.xml' file is the '''optional''' Log System configuration file for EQ2Emulator Server. All loggers have default settings defined in the code (LogTypes.h) and this file is used to override those defaults without having to recompile the code.

@@ Line 1: / Line 1: @@
 == EQ2Emulator: Log System ==
 The 'log_config.xml' file is the '''optional''' Log System configuration file for EQ2Emulator Server. All loggers have default settings defined in the code (LogTypes.h) and this file is used to override those defaults without having to recompile the code.
@@ Line 10: / Line 12: @@
-=== Categories ===
+{{Header|Categories|BackgroundColor=3d78b4|FontColor=ffffff}}
 This is the list of current CATEGORIES available:
-==== System Loggers ====
+{|style="table-layout:fixed; width: 100%;"
-  WORLD
+|{{TextBox|System Loggers|  WORLD
    LOGIN
    PATCHER
@@ Line 21: / Line 23: @@
    DATABASE
    MUTEX
-   MISC
+   MISC|BackgroundColor=ffffff|FontColor=000}}
-==== Network Loggers ====
+{|style="table-layout:fixed; width: 100%;"
-  CCLIENT
+|{{TextBox|Network Loggers|  CCLIENT
    NET
    OPCODE
-   PACKET
+   PACKET|BackgroundColor=ffffff|FontColor=000}}
-==== Player Loggers ====
+{|style="table-layout:fixed; width: 100%;"
-  PLAYER
+|{{TextBox|Player Loggers|  PLAYER|BackgroundColor=ffffff|FontColor=000}}
-==== SubSystem Loggers ====
+{|style="table-layout:fixed; width: 100%;"
-  CHAT
+|{{TextBox|SubSystem Loggers|  CHAT
    COLLECTIONS
    COMBAT
@@ Line 50: / Line 52: @@
    SKILLS
    SPELLS
-   TRADESKILLS
+   TRADESKILLS|BackgroundColor=ffffff|FontColor=000}}
-==== Spawn Loggers ====
+{|style="table-layout:fixed; width: 100%;"
-  SPAWN
+|{{TextBox|Spawn Loggers|  SPAWN
    OBJECT
    SIGN
    WIDGET
-   GROUNDSPAWN
+   GROUNDSPAWN|BackgroundColor=ffffff|FontColor=000}}
-==== Zone Loggers ====
+{|style="table-layout:fixed; width: 100%;"
-  ZONE
+|{{TextBox|Zone Loggers|  ZONE
-   INSTANCE
+   INSTANCE|BackgroundColor=ffffff|FontColor=000}}
-=== Types ===
+{{Header|Types|BackgroundColor=3d78b4|FontColor=ffffff}}
 All CATEGORIES have 7 TYPES, with some categories having a few extra as needed:
@@ Line 76: / Line 78: @@
-=== Level ===
+{{Header|Level|BackgroundColor=3d78b4|FontColor=ffffff}}
 The "Level" parameter tells the logger how much detail you wish to see in your debugging of a particular logger. Valid range is 0 (minimal) through 9 (maximum).
@@ Line 85: / Line 87: @@
-=== Color ===
+{{Header|Color|BackgroundColor=3d78b4|FontColor=ffffff}}
 The "Color" parameter allows you to set your own color for the log entry (restricted to defined colors in code)
@@ Line 97: / Line 99: @@
-=== Enabled ===
+{{Header|Enabled|BackgroundColor=3d78b4|FontColor=ffffff}}
 The "Enabled" parameter allows you to toggle the logger on or off without removing the entry from log_config.xml
-=== Logs ===
 The "Logs" parameter lets you direct the logger to one of 3 outputs, or any combination of the 3 (bitwise):
@@ Line 112: / Line 115: @@
    To direct logger output to just File, Logs="1"
-=== Example ===
 Example LogConfig (you can use any 1 TYPE definition, you do not need them all, but the XML must be formatted as follows):

← Older revision		Revision as of 15:04, 19 September 2012
Line 1:		Line 1:
	== EQ2Emulator: Log System ==		== EQ2Emulator: Log System ==
	The 'log_config.xml' file is the '''optional''' Log System configuration file for EQ2Emulator Server. All loggers have default settings defined in the code (LogTypes.h) and this file is used to override those defaults without having to recompile the code.		The 'log_config.xml' file is the '''optional''' Log System configuration file for EQ2Emulator Server. All loggers have default settings defined in the code (LogTypes.h) and this file is used to override those defaults without having to recompile the code.
		+
		+
		+	Scatman has implemented "log queuing" functionality for our very active Log System. The problem was, so many logs were being written at the same time, they started to inject over each other making the logs unreadable. Now, logs are handled as FIFO - First In, First Out. The system is undergoing extensive testing, but for now performs wonderfully with the addition of the "Level" parameter as well.

@@ Line 4: / Line 4: @@
 The LogWrite system consists of these elements:
-   LogWrite(CATEGORY__TYPE, "Tag", "Formatted Text", params);
+   LogWrite(CATEGORY__TYPE, Level, "Tag", "Formatted Text", params);
@@ Line 113: / Line 113: @@
    <LogConfig Category="WORLD">
-     <ConfigType Type="DEBUG" Color="GreenBold" Enabled="True" Logs="3" />
+     <ConfigType Type="DEBUG" Level="0" Color="GreenBold" Enabled="True" Logs="3" />
-     <ConfigType Type="DATA" Color="White" Enabled="True" Logs="1" />
+     <ConfigType Type="DATA" Level="5" Color="White" Enabled="True" Logs="1" />
    </LogConfig>
 This example overrides the default WORLD category, DEBUG and DATA types, to write to the console and/or just the log file.

← Older revision		Revision as of 14:55, 19 September 2012
Line 71:		Line 71:
	DETAIL		DETAIL
	DATA		DATA
		+
		+
		+	=== Level ===
		+	The "Level" parameter tells the logger how much detail you wish to see in your debugging of a particular logger. Valid range is 0 (minimal) through 9 (maximum).
		+
		+	''Examples'':
		+	Default Level 0: Displays only the minumum amount of debugging for an event - Ie., Loading Items...
		+	Level 3: Might show Items loading, and display each TYPE of item loaded and it's counts
		+	Level 9: Might show each and every item loading with all of it's possible values (not advised)