Deployment Solution 7.1 Logging: How to, Why, and Where

Article:HOWTO31248  |  Created: 2010-08-31  |  Updated: 2012-12-07  |  Article URL http://www.symantec.com/docs/HOWTO31248
Article Type
How To



When troubleshooting Deployment Solution 7.x, there are several sets of logs you will find useful.  This document will attempt to outline them all.  Look for 3 things with each log type: Function (what they do or why they're used), How (how to enable them) and Location (where to find them).

  1. General NS Logging (related, but not specifically DS logs)
  2. Debug (Task Specific) Logs
  3. SBS Site Services general logging
  4. Automation and Imaging logs
  5. Other Miscelaneous Logs

 

General Logging (related to, but not specifically for DS)

NS Server Logs

  • Function: These logs only exist on the Notification Server, and are basic logs for tracking all NS activity. Information from various modules, including the Altiris Service, Task Services, and IIS are included in this log file. The most current file will be called "a.log", with progressively older files being labeled with an appended number in the following format: "aXX.log". This is one of the logs displayed in the Altiris Log Viewer.
  • How: These are enabled by default, though increased logging can be specified throug registry key changes (not in this KB) or via the Log Viewer.
  • Location: "C:\Program Files\Altiris\Notification Server\Logs"

NS Agent Logs

  • Function: These logs will exist on all managed machines; the Notification Server, Site Servers, and clients will all have them. This log tracks activity specific to this client, including Job/Task execution, server communication, and internal agent activity. The most current file will be called "Agent.log", with progressively older files being labeled with an appended number in the following format: "AgentXX.log". This is one of the logs displayed in the Altiris Log Viewer.
  • How: These are enabled by default, though increased logging can be specified throug registry key changes (not in this KB) or via the Log Viewer.
  • Location: "C:\Program Files\Altiris\Altiris Agent\Logs\"

Task History Logs

  • Function: This is a history of the Tasks specific to the managed machine from which it is taken. This is the information displayed when clicking the 'Task History' button on the Symantec Management Agent UI.
  • How: These are enabled by default and can not be modified.
  • Location: "C:\Program Files\Altiris\Altiris Agent\TaskManagement\statusXml\History\"

Task Management Logs

These logs will be located on remote Site Servers with the Task Service installed.

  • Function: Records the activities and functions of the Remote Task Server
  • How: these are enabled by default and can not be modified (I think)
  • Location: "C:\Program Files\Altiris\Altiris Agent\Client Task Server\logs\taskmanagement.log"

 

Debug (Task Specific) Logs

Function: These logs are to track all DS related tasks / task types, either on a site server, or on an agent.  If a task is not behaving the way you expect it to, enable these.  For instance, if the CopyFile task is failing to do what it should, these logs might show why.

NOTE: This is also how you capture the NSInterface logging.

How: This single key will create a set of logs in the specified folder all named after the task for which it logs.  It is enabled via "String Value" registry key:

HKEY_LOCAL_MACHINE\SOFTWARE\Altiris\Deployment\DebugLogs
string value = your chosen path

Location: Where they are stored is up to you, but a common location may be as simple as c:\temp.  Remember, don't leave this key enabled for longer than it takes to troubleshoot because it can generate a lot of data and can quickly fill up remaining space.

 

SBS Site Services general logging

Function: These track all activity in the SBS Services in detail..  These correlate with the setting in the console to enable logging (Settings | All Settings  Settings\Deployment and Migration\Symantec Boot Services (PXE)\PXE Server Configuration \ "Enable logging"), but the console setting does not actually enable all of these and is thus not recommended.  This process is more thorough and detailed.

There are several items you should remember when doing this:

  • TFTP logging seriously impeeds performance of a WinPE dowload to a client system and should be avoided where possible.
  • There are 6 keys here and only 4 services. That is by design. Server, PXEOpts and ParsePXE all are created by the SBSServer service.
  • There is currently no way to modify the destination location (actual path) of these logs. Only the file name matters, so please do not modify the path itself.
  • In the SBS folder, there is a file called "initialPXEConfigPath.txt" that has several logging options. Though it would appear to augment and/or replace this process, they are not fully functional. Please ignore those settings and simply use this.

How: create the following registry keys and enable them.  Alternately, an already configured sample is attached (DS Debug.ZIP) which you can import to the registry and then modify.

NOTE: The examples here below will have all the logs enabled (dword = 1).  The attached zip file when imported will leave the logs disabled until you go change the Enabled value.  Do NOT leave the SbsMTFTP logs enabled long!  Generally, that one should be OFF.

NOTE: SBSNSInterface has additional logging as noted in the section above "Debug"

NOTE: There is an option in the console to enable logging that touches on this, but it is not complete.  It is recommended to use this process/section instead.

[HKEY_LOCAL_MACHINE\SOFTWARE\Altiris\Debug]

[HKEY_LOCAL_MACHINE\SOFTWARE\Altiris\Debug\SbsNSiFace]
"Enabled"=dword:00000001
"Filepath"="SBSLog_NSiFace.txt"
"OutputThreshold"=dword:000000fe

[HKEY_LOCAL_MACHINE\SOFTWARE\Altiris\Debug\SbsNSiSignal]
"Enabled"=dword:00000001
"Filepath"="SBSLog_NSiSignal.txt"
"OutputThreshold"=dword:000000fe

[HKEY_LOCAL_MACHINE\SOFTWARE\Altiris\Debug\SbsParsePxe]
"Enabled"=dword:00000001
"Filepath"="SBSLog_parsePxe.txt"
"OutputThreshold"=dword:000000fe

[HKEY_LOCAL_MACHINE\SOFTWARE\Altiris\Debug\SbsPxeOpts]
"Enabled"=dword:00000001
"Filepath"="SBSLog_pxeopts.txt"
"OutputThreshold"=dword:000000fe

[HKEY_LOCAL_MACHINE\SOFTWARE\Altiris\Debug\SbsServer]
"Enabled"=dword:00000001
"Filepath"="SBSLog_server.txt"
"OutputThreshold"=dword:000000fe

[HKEY_LOCAL_MACHINE\SOFTWARE\Altiris\Debug\SbsLogHelper]
"FilePath"="SBSLog_helper.txt"
"OutputThreshold"=dword:000000fe
"Enabled"=dword:00000001

[HKEY_LOCAL_MACHINE\SOFTWARE\Altiris\Debug\SbsMtftp]
"Enabled"=dword:00000001
"Filepath"="SBSLog_mtftp.txt"
"OutputThreshold"=dword:000000fe

Location:  All the following logs will be generated in the same folder where the service executables reside.

 

Automation and Imaging logs

WinPE (Automation) Agent Logs & Task-Specific Logs

  • Function: The Agent.log and PECTAgent.log record the processes and operations performed by the automation agent in WinPE. PectAgent mimics the activity normally seen in the "Agent" log in production.  The Agent.log actually records the initial connection and initialization of the agent with significant debug information.  The final entry of the Agent log indicates that the agent is starting, where the PectAgent log then takes over, approximately.
  • How: Automatically created
  • Location: "X:\Program Files\Altiris\Altiris Agent\Logs\"

Linux Agent Logs & Task-Specific Logs

  • Function: The aex-client.log and DSPluginInit.log record the processes and operations performed by the automation agent in Linux. The remaining logs will be named according to the Task for which they record information.
  • How: Automatically created
  • Location: "/opt/altiris/notification/nsagent/var"

Ghost Imaging Logs

  • Function: Records any failures that occur during use of the Ghost imaging tool.
  • How: These are created automatically but only IF there's a failure.  If no failure, no logs.
  • Location: "C:\Program Files\Altiris\Altiris Agent\Agents\Deployment\Task Handler\ghost\ghDplyAw32.txt" on the PXE/Site Server
           AND/OR  "x:\Ghosterr.txt" (in automation only - must be collected before rebooting)

RDeploy Log

  • Function: Records any failures that occur during use of the RDeploy tool.  This is recorded only on the Site Server if RDeploy is used, in the same directory as RDeploy.
  • How: These are created automatically.
  • Location: "C:\Program Files\Altiris\Altiris Agent\Agents\Deployment\Task Handler\rdeploy\rdeploy.txt"

 

Other Miscelaneous DS Logs

PXE Startup Info (on DS site servers)

  • Function: This tracks the initialization of the PXE services.
  • How: This is automatically logged
  • Location:  The log files kept in the same folder by default as the application and in the Windows\System32 folder as follows:
       C:\Program Files\Altiris\Altiris Agent\Agents\Deployment\Task Handler\SBS\pxestartupinfo.log
       C:\Windows\System32\pxestartupinfo.log

SBS Store

  • Function: Tracking data sent to the SBS services by the Task handlers.  It is a historical set of data that is sometimes useful for seeing if data is actually getting TO the PXE services.  It can be purged any time.
  • How: Automatic.
  • Location: This is actually just a subfolder of SBS and is a historic folder of all activity sent to the SBS Server via Task.  It can be cleared any time with absolutely no risk or loss.

 

 

 


Attachments

DS Debug.zip (442 Bytes)

Article URL http://www.symantec.com/docs/HOWTO31248


Terms of use for this information are found in Legal Notices