Table Of Contents
NME-APA Troubleshooting Concepts
Information About the User Log
Information About the Logging System
Copying the User Log
Viewing the User Log
Clearing the User Log
Viewing the User Log Counters
Generating a File for Technical Support
Operational Status
CADC Operational Status
Offline
Available
Connected
Signature, Protocol, and Service IDs
Debug Flags for Protocol Libraries
Debug Flags for SML Components
NME-APA Troubleshooting Concepts
This module includes background information that can help operators to troubleshoot issues when using the Cisco Network Enhanced Module for Application Performance Assurance (NME-APA) and the Cisco Application Performance Assurance Device Console (APADC).
•
Information About the User Log
•Signature, Protocol, and Service IDs
•Debug Flags for Protocol Libraries
•Debug Flags for SML Components
Information About the User Log
The user log is an ASCII file that can be viewed in any editor. It contains a record of system events, including startup, shutdown and errors. You can use the Logger to view the user log to determine whether or not the system is functioning properly, as well as for technical support purposes.
User logs for CADC are available on the web server at <drive:>\SCAtE\apache-tomcat-5.5.20\logs\ where <drive:>is the hard drive where CADC is installed, for example, C: or D: .
Three different log files are available, where YYYYMMDD is the date of installation of the application.
•jakarta_service_YYYYMMDD.log —The Tomcat web server
•stderr_ YYYYMMDD.log —The CADC application error log
•stdout_ YYYYMMDD.log —The CADC application trace/informative log
Information About the Logging System
There are two discreet logging systems, NME-APA logging is maintained on the modules and CADC logging is maintained on the web server. CADC uses Java's Log4J logging system. The log files are located in the \SCAtE\apache-tomcat-5.5.20\logs\ directory.
Events are logged to one of two log files. After a file reaches maximum capacity, the events logged in that file are then temporarily archived. New events are then automatically logged to the alternate log file. When the second log file reaches maximum capacity, the system then reverts to logging events to the first log file, overwriting the temporarily archived information stored in that file.
Basic operations include:
•Copying the User Log to an external source
•Viewing the User Log
•Clearing the User Log
•Viewing and clearing the User Log counters
Copying the User Log
You can view a log file by copying both log files to to the local NME-APA platform disk or to any external host running an FTP server.
To copy the user log to an internal location, use the following command:
•From the NME-APA# prompt, type logger get user-log file-name target-filename and press Enter.
To copy the user log to an external source, use the following command:
•From the NME-APA# prompt, type logger get user-log file-name ftp://username:password@ipaddress/pathand press Enter.
Viewing the User Log
To view the user log:
•From the prompt, type more user-log and press Enter.
The user log appears.
Note This method is not recommended when the user log is large. Copy a large log to a file to view it (see Copying the User Log )
To view the CADC log:
1. Go to the path \SCAtE\apache-tomcat-5.5.20\logs\ .
2. Use a text editor to open the files.
Clearing the User Log
You can clear the contents of the user log at any time. The user log contains important information regarding the functioning of the system. It is recommended that a copy be made before the log is cleared.
To clear the user log:
1. From the prompt, type clear logger device user-file-log and press Enter.
2. The system asks Are you sure?
3. Type Y and press Enter.
To clear the CADC log:
•Delete the log files on the web server.
Viewing the User Log Counters
Note This not applicable to CADC logs.
There are two types of log counters:
•User log counters—Count the number of system events logged from the SCE platform since the last reboot
•Non-volatile counters—Are not cleared at boot time
To view the user log counters for the current session, use the following command:
•From the prompt, type show logger device user-file-log counters and press Enter.
The logger lines information appears, followed by the prompt.
To view the non-volatile logger counters for both the User log file and the debug log file, use the following command:
•From the prompt, type show logger nv-counters and press Enter.
The non-volatile log counter information appears, followed by the prompt.
To view the non-volatile counter for the user-file-log only, use the following command:
•From the prompt, type show logger device user-file-log nv-counters and press Enter.
The user-file-log non-volatile log counter information appears, followed by the prompt.
Generating a File for Technical Support
In order for technical support to be most effective, the user should provide them with the information contained in the system logs. Use the logger get support-file command to generate a support file for the use of Cisco technical support staff.
For CADC, the log files maintained by the application (see Information About the User Log ) should be made available to Cisco technical support staff.
To generate a log file for technical support:
•From the prompt, type logger get support-file filename and press Enter.
The support information file is created using the specified filename, and the prompt appears. This operation may take some time.
Operational Status
The operational status can be displayed using the CLI command show system operation-status. The following table lists the operational states.
Table 1-1 Operational States
Operational Status
|
Description
|
Booting
|
Initial state after reset
|
Operational
|
The system becomes operational after completing the following process:
•Boot is completed
•Power self-tests are completed without failure
•Platform configuration is applied
|
Warning
|
The system is fully operational (as above) but one of the following occurred:
•Line ports (FE ports) to the link are down
•The management port link is down
•Temperature raised above threshold
•Insufficient space on the disk
Note If the condition that caused the platform to be in Warning state is resolved (for example, link is up) the platform reverts to Operational state.
|
Failure
|
The system is in Failure state after Boot due to one of the following conditions:
•Power-on test failure
•Three abnormal reboots in less than 20 minutes
•The platform is configured to enter Failure mode subsequent to a failure-induced reboot (this is configurable using a CLI command)
Note Depending on the cause of failure, the management interface and the platform configuration may or may not be active/available.
|
CADC Operational Status
The CADC application maintains three operational states of managed NME-APA:
•Offline—The device is unreachable by ICMP ping.
•Available—The device is reachable but has not been authenticated.
•Connected—The device is reachable and authenticated.
Offline
Check if the device can be pinged from the server running the CADC application.
If the device is reachable from the server, check the application logs to see why the device failed to become "Available".
Available
If CADC fails to "Connect" to the managed NME-APA, perform the following:
1. Go to Admin >Admin User Management.
2. Verify that the NME-APA you are trying to connect is included under the "Configured Devices" for the CADC user trying to connect to the NME-APA.
3. Click on the device name under "Configured Devices" for the CADC user.
4. Verify that the device username on CADC also exists on the NME-APA through Telnet.
5. Verify that the passwords for the device user on CADC and NME-APA are identical.
6. Check the application logs for any error messages.
Connected
Only one managed device can be in this stateat any one time.
Check the application logs if the user is unable to "Disconnect" from NME-APA. If the problem persists, restart the Tomcat Windows service and the SCAtE MySQL Windows service. If this does not solve the problem, restart the server.
Signature, Protocol, and Service IDs
For protocol classification troubleshooting, the first thing is to make sure that appropriate signature, protocol, and service ID values are correct in the RDR report. The following table contains the values for the new protocols introduced in the Excelsior project for reference.
Table 1-2 Signature, Service, and Protocol IDs
Protocol / Traffic Type
|
Signature ID (defined by Excelsior)
|
Protocol ID (defined by CADC)
|
Service ID (defined by CADC)
|
| |
|
|
|
PROTOCOL_TYPE_ORACLE
|
0x20010000
|
4000
|
400
|
| |
|
|
|
PROTOCOL_TYPE_CITRIX
|
0x20020000
|
4001
|
401
|
PROTOCOL_TYPE_CITRIX_ICA
|
0x20020100
|
4001
|
401
|
PROTOCOL_TYPE_CITRIX_CGP
|
0x20020200
|
4001
|
401
|
PROTOCOL_TYPE_CITRIX_IMA
|
0x20020300
|
4001
|
401
|
PROTOCOL_TYPE_CITRIX_SBM
|
0x20020400
|
4001
|
401
|
| |
|
|
|
PROTOCOL_TYPE_SAP
|
0x20030000
|
4002
|
402
|
| |
|
|
|
PROTOCOL_TYPE_AIM
|
0x20040000
|
714
|
28
|
PROTOCOL_TYPE_AIM_TEXT
|
0x20040100
|
714
|
28
|
PROTOCOL_TYPE_AIM_VOICE
|
0x20040200
|
714
|
28
|
PROTOCOL_TYPE_AIM_VIDEO
|
0x20040300
|
714
|
28
|
PROTOCOL_TYPE_AIM_MEDIA_CHAT
|
0x20040400
|
714
|
28
|
PROTOCOL_TYPE_AIM_FILEXFER
|
0x20040500
|
714
|
28
|
PROTOCOL_TYPE_AIM_PICSHARE
|
0x20040600
|
714
|
28
|
PROTOCOL_TYPE_AIM_GAME
|
0x20040700
|
714
|
28
|
| |
|
|
|
PROTOCOL_TYPE_MS_EXCHANGE
|
0x20050000
|
4004
|
4
|
| |
|
|
|
PROTOCOL_TYPE_GOOGLE_TALK
|
0x20060000
|
1030
|
28
|
PROTOCOL_TYPE_GOOGLE_TALK_VOICE
|
0x20060100
|
1030
|
28
|
PROTOCOL_TYPE_GOOGLE_TALK_FILEXFER
|
0x20060200
|
1030
|
28
|
| |
|
|
|
PROTOCOL_TYPE_VOICE_YAHOO
|
0x050B0000
|
45
|
37
|
PROTOCOL_TYPE_CHAT_YAHOO_MESSENGER
|
0x0B020000
|
40
|
28
|
| |
|
|
|
PROTOCOL_TYPE_MSSQL
|
0x20070000
|
4006
|
403
|
| |
|
|
|
PROTOCOL_TYPE_ACTIVEX
|
0x20080000
|
4007
|
404
|
| |
|
|
|
PROTOCOL_TYPE_MSN_MESSENGER
|
0x20090000
|
883
|
28
|
PROTOCOL_TYPE_MSN_MESSENGER_TEXT
|
0x20090100
|
883
|
28
|
PROTOCOL_TYPE_MSN_MESSENGER_VOICE
|
0x20090200
|
883
|
28
|
PROTOCOL_TYPE_MSN_MESSENGER_VIDEO
|
0x20090300
|
883
|
28
|
PROTOCOL_TYPE_MSN_MESSENGER_EMAIL
|
0x20090400
|
883
|
28
|
PROTOCOL_TYPE_MSN_MESSENGER_FILEXFER
|
0x20090500
|
883
|
28
|
PROTOCOL_TYPE_MSN_MESSENGER_GAME
|
0x20090600
|
883
|
28
|
PROTOCOL_TYPE_MSN_MESSENGER_WHITEBOARD
|
0x20090700
|
883
|
28
|
Debug Flags for Protocol Libraries
The following flags can be used to collect debug traces for a specific protocol library.
Note Debug flags can be used only if a special SML debug image is loaded into the NME-APA. The release image is not compatible with debug flags.
The CLI command to apply the debug flag is under config ->Interface Linecard 0:
Tunnable PL_PT_ShowDebugReportForModule[Flag Value] value TRUE
The protocol library debug flag values are listed in the following table.
Table 1-3 Debug Flags for Protocol Libraries
Debug Flag
|
Value
|
public const uint16 PL_ALL_MODULES
|
0
|
public const uint16 PL_UNIFICATION
|
1
|
public const uint16 PL_COMMON
|
2
|
public const uint16 PL_VOICE_SKYPE
|
3
|
public const uint16 PL_MAIL_SMTP
|
4
|
public const uint16 PL_BEHAVIORAL
|
5
|
public const uint16 PL_YAHOO
|
6
|
public const uint16 PL_VOICE_RTP
|
7
|
public const uint16 PL_VOICE_DINGOTEL
|
8
|
public const uint16 PL_P2P
|
9
|
public const uint16 PL_VOICE_SIP
|
10
|
public const uint16 PL_RTSP
|
11
|
public const uint16 PL_FTP
|
12
|
public const uint16 PL_HTTP
|
13
|
public const uint16 PL_MMS
|
14
|
public const uint16 PL_TFTP
|
15
|
public const uint16 PL_MAIL_IMAP
|
16
|
public const uint16 PL_MAIL_MIME
|
17
|
public const uint16 PL_NNTP
|
18
|
public const uint16 PL_MAIL_POP3
|
19
|
public const uint16 PL_SSL
|
20
|
public const uint16 PL_DHCP
|
21
|
public const uint16 PL_RADIUS
|
22
|
public const uint16 PL_H323
|
23
|
public const uint16 PL_MGCP
|
24
|
public const uint16 PL_PTT
|
25
|
public const uint16 PL_RTCP
|
26
|
public const uint16 PL_SDP
|
27
|
public const uint16 PL_SKINNY
|
28
|
public const uint16 PL_SMPP
|
29
|
public const uint16 PL_WAP
|
30
|
public const uint16 PL_DNS
|
31
|
public const uint16 PL_SSDP
|
32
|
public const uint16 PL_AGG_AGING
|
33
|
public const uint16 PL_BASIC
|
34
|
public const uint16 PL_HITLESS_UPGRADE
|
35
|
public const uint16 PL_CUWORLD
|
36
|
public const uint16 PL_ICQ
|
37
|
public const uint16 PL_JABBER
|
38
|
public const uint16 PL_STUN
|
39
|
Note PL_HITLESS_UPGRADE (35) will be used for the new features added in hitless upgrade.
Debug Flags for SML Components
The following flags can be used to collect debug traces for a software component in the Excelsior SML application.
Note Debug flags can be used only if a special SML debug image is loaded into the NME-APA. The release image is not compatible with debug flags.
The CLI command to apply the debug flag is under config ->Interface Linecard 0:
Tunnable APP_PT_ShowDebugReportForModule[Flag Value] value TRUE
The SML component debug flag values are listed in the following table.
Table 1-4 Debug Flags for SML Components
Debug Flag
|
Value
|
public const uint16 APP_ALL_MODULES
|
0
|
public const uint16 APP_MAIN
|
1
|
public const uint16 APP_UNIFICATION
|
2
|
public const uint16 APP_CLASSIFY
|
3
|
public const uint16 APP_EXTERN_CALLBACKS
|
4
|
public const uint16 APP_LISTNERS
|
5
|
public const uint16 APP_PARTY
|
6
|
public const uint16 APP_HANDLERS
|
7
|
public const uint16 APP_REPORTS
|
8
|
public const uint16 APP_MAX_MODULE
|
9
|
