cc/td/doc/product/voice/uone/srvprov/r41s
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

Working with Log Files

Working with Log Files

This chapter contains descriptions of the various log files used by the uOne system, procedures for viewing them, and information that will help you interpret log file messages. The chapter also provides information about of how log files are removed on GateServer, and about purging log files on the backend servers.

Overview of Logging Information

The following log files provide information about the uOne application environment on the GateServers:


Note The Attrib.Global and the Attrib.<hostname> files, located in $PARMLIB/parms/<Agent> or $PARMLIB/parms/BASE, contain the settings for all logging detail and debug levels. Attributes can be set to enable or disable logging. Global settings can be over-ridden at the ACB (BASE) / agent level. Typically, any modification to the default settings is handled during configuration with the Quick Configuration tool. You can dynamically change current logging settings of running server agents only with the umcli tool.

Viewing Logging Information

To view any of the log files:

Step 1 Access the GateServer on which the log files you wish to view reside.

Step 2 Log in as spmaster.

Step 3 View the log file in one of the following ways:

Table 5-1 contains the pathnames for all the log files on the GateServer.
Table 5-1: Log File Locations
Log File Directory in Which It Resides

ACB and agent log files

$PARMLIB/logs/logfiles

stderrout files

$PARMLIB/logs/stderrout

umsa_pma.log file

$HOME/ADMIN/logs

Changing Logging Levels

Changing Logging Levels for the ACB and Sever Agents

Step 1 At the command line, type: umcli.

Step 2 Type: set loglevel <component> <error> <value>


Table 5-2: set loglevel Command options
Component Error Type Value Description

acb

error

off

local

Sets the ACB error level logging.

acb

warning

off

local

Sets the ACB warning level logging.

acb

info

off

local

Sets the ACB informational level logging.

acb

debug

off

local

Sets the ACB debug level logging.

cma

error

off

local

Sets the CMA error level logging.

cma

warning

off

local

Sets the ACB warning level logging.

cma

info

off

local

Sets the ACB informational level logging.

cma

debug

off

local

Sets the ACB debug level logging.


Note The local setting for the loglevel command means to turn on logging at the specified level for the local machine.

Changing Logging Levels for Application Agents

Use the following procedure to change the logging level for the UM, MWIOnOff, MWI_Notify, SMS_Notify, and FaxPrint applications

Step 1 At the command line, type:

logchange APP[:app_pid] [error|warning|info|debug] [off|local]


Table 5-3: logchange Command options
Application Error Type Value

APP [:app_pid]

app_pid = The PID of the application

error—Sets the specified application's error level logging.

off—Turns off logging for the specified application

local—Turns on logging at the specified level for application on the local machine.

warning—Sets the specified application's warning level logging.

info—Sets the specified application's informational level logging.

debug—Sets the specified application's debug level logging.

ACB and Agent Log Files

The uOne logging process provides central log management services to server and application agents. ACB and agents generate log files and escalation files.

ACB and agent log files contain the actual messages generated from the ACB and server or application agents. The three types Agent log files are:

The ACB and agent log files are identified by their file type as illustrated in Figure 5-1.


Figure 5-1: Sample Listing of ACB and Agent Log Files

Software Log File Messages

There are five types of software messages:


Note Debug logging is set up in the BASE/Attrib.Global file. For additional information, see the uOne GateServer Installation and Configuration Manual.

Software Log File Message Format

Software log files display the format illustrated in Figure 5-2. Table 5-4 describes the fields in the Sof messages.

Refer to "Software Log File Messages Descriptions" for descriptions of the Sof log file messages.


Figure 5-2: Sample Software Log File Messages


Table 5-4: Software Log File Message Fields
Message Field Description

Date

Date when the message was issued (automatically generated).

Time

Time when the message was issued (automatically generated).

Module

C-language file name from which the message was issued (automatically obtained during the compilation process).

Line Number

Line number in the file above where the message was issued (automatically obtained during the compilation process).

Message Name

Descriptive name of the type of message generated. The name includes the severity and version of the message.

Detail

The specific message.

Resource Log File Messages

Resource log messages are used to indicate resource utilization, such as agent instance allocation and deallocation.

Resource Log File Message Format

The sample in Figure 5-3 shows the fields in a Res log file. Refer to Table 5-4 for specific field descriptions.


Figure 5-3: Sample of a Resource Log File Message


Table 5-5: Resource Log File Message Fields
Message Field Description

Date

Date when the message was issued (automatically generated).

Time

Time when the message was issued (automatically generated).

Machine Name

Host name of the machine from which the message was issued (automatically generated).

Component

Name of the component (e.g., CMA, ACB, APP, etc.) that generated the message (automatically generated).

Process

The name of the process that issued the message (automatically generated).

PID

Number of the process (process ID) that issued the message (automatically generated).

Module Name

C-language file name from which the message was issued (automatically obtained during the compilation process).

Line Number

Line number in the file above where the message was issued (automatically obtained during the compilation process).

Message Category

Category of resource logging message. The currently used category is Billing

Resource Type

Type of resource accessed. The currently used type is Application Program.

Resource Action

Action performed on the resource. The currently used actions are: Allocated and Freed

ID

A numeric code (often an event or command ID) modifying the resource action above, e.g. a code indicating a "STARTAPP" command ID was used to allocate a Application Program agent resource. These codes are not published.

Max

Maximum number of resources of the resource type that can be allocated. (independent of current utilization).

Level

Current allocation of resources of this type.

User PID

ID number of the process performing the resource action.

User Host

Name of the host performing the resource action.

User Component

Name of the server agent performing the resource action.

Resource Name

Name of the specific resource accessed.

Event Log File Messages

Application agents use Event Log File messages to log important events, such as information required for call detail records, or errors. Application agents log these messages through the ACB so they are associated with the ACB name. Event logging information allows administrators to recreate user problems, enabling enhanced problem resolution abilities. The event logging also supplies billing information.

The following application agents output messages to the Event Log File:

Types of Event Logging

The uOne application agents have several types of event logging:

Event Log File Message Format

The format for the event messages generated by the uOne application agents has two parts. The first part of the message is common to all types of event logging. The second part is specific to the type of logging, which is fatal error, warning, informational, or call detail record logging. The sample message in Figure 5-4 identifies the common part of an Event Log Message. See Table 5-6 for descriptions of the message fields.


Figure 5-4: Common Part of an Event Log Message—UM Application

Refer to the following sections in this chapter for descriptions of the fields that are specific to the logging type:


Table 5-6: Descriptions of Event Log Message Common Fields—UM Application
Field Number Message Field Description

1

Date

Date when the message was issued using the subscriber's time zone (automatically generated).

2

Time

Time when the message was issued using the subscriber's time zone (automatically generated).

3

Machine Name

Host name of the machine from which the message was issued (automatically generated).

4

Component

Name of the component (e.g., CMA, ACB, APP, etc.) that generated the message (automatically generated).

5

Process

The name of the process that issued the message (automatically generated).

6

PID

Number of the process (process ID) that issued the message (automatically generated).

7

Module Name

C-language file name from which the message was issued (automatically obtained during the compilation process).

8

Line Number

Number of the line in the file above where the message was issued (automatically obtained during the compilation process).

9

Distinguished Name

Community search base distinguished name (dn) for the subscriber.

Fatal Error Messages

The UM application Agent logs Fatal Error messages when errors occur that cause UM to exit with the phrases AUD_SORRY_GOODBYE or AUD_SYSTEM_ERROR_GOODBYE. This level of logging is not configurable and is always turned on.

Figure 5-5 is an example of a Fatal Error Message from the Event Log File. Table 5-7 describes the message fields that are specific to Fatal Error Messages.


Figure 5-5: Fatal Error Specific Fields—UM Application


Table 5-7: Descriptions of Fatal Error Specific Fields—UM Application
Field Number Message Field Description

10

Type

Valid access type is: Error.

11

Mailbox ID

Subscriber's mailbox identification.

12

Blank

Not applicable.

13

Code

Return code.

14

Error

Description of the error that occurred.

15, 16

Blank

Not applicable.

Warning Messages

The UM application agent logs warning messages when non-fatal errors occur, such as failures to play a phrase or retrieve DTMF. This level of logging is not configurable and is always turned on. Table 5-7 describes the message fields that are specific to Warning Messages.


Table 5-8: Descriptions of Warning Messages Specific Fields—UM Application
Field Number Message Field Description

10

Type

Valid access type is: Warning.

11

Mailbox ID

Subscriber's mailbox identification.

12

Blank

Not applicable.

13

Code

Return code.

14

Error

Description of the non-fatal error that occurred.

15, 16

Blank

Not applicable.

Informational Messages

Subscriber Informational Messages provide information about subscriber sessions other than billing information and FaxPrint processing and MWI processing. This includes events such as IMAP and LDAP accesses, DTMF keys pressed, and phrases played.

Figure 5-6 is an example of a Informational Message from the Event Log File. Table 5-9 describes the message fields that are specific to Informational Messages.


Figure 5-6: Informational Specific Fields—UM Application


Table 5-9: Descriptions of Informational Specific Fields—UM Application
Field Number Message Field Description

10

Type

Valid types are: Dtmf, Play, Phrase, Imap, Ldap, MWI.

11

Mailbox ID

Subscriber's mailbox identification or blank.

12

Usage Type

The type of usage that this message represents. Valid types are: RetrieveSignals, GetDigits, DateNTime, Number, Phrase, Record, Open, Close, ChangeFolder, Bind, DeleteDistList, AddList, Modify, SetIndicator, SendPage.

13

Code

Error code.

14, 15,16

Variable

Variable information based on Type. See "Event Log FileInformational Messages".

Call Detail Records

Call Detail Records provide information required to bill for subscriber activity. Figure 5-7 shows a sample Call Detail Record from the Event Log File.


Note These logs are located on each host that is running uOne application agents. In a distributed system, the information contained in these logs will have to be gathered from multiple hosts for a billing application to get complete and accurate data.

Figure 5-7: Call Detail Record Specific Fields—UM Application

See Table 5-10 for descriptions of the message fields that are specific to Call Detail Records. See Appendix C for detailed descriptions of usage information logged in Call Detail Records.
Table 5-10: Descriptions of Call Detail Record Specific Fields—UM Application
Field Number Message Field Description

10

Access Type

Valid access types are: Subscriber, SNR, and Caller.

11

Mailbox ID

Subscriber's mailbox identification.

12

Usage Type

The type of usage which this record represents. Valid types are: Login, LogOut, Sent (smtp), Broadcast, Cancelled, Failed, LockOut PageSent, PageFailed.

13

Code

Return Code.

14, 15, 16, 17

Variable

Variable information based on Type. See "Event Log FileInformational Messages".

The Standard err and out Files

Standard err and out files contain unformatted output from uOne software. When you are troubleshooting a problem, TAC may request copies of these files to help them resolve the problem.

The UMSA/PMA Log File

All UMSA/PMA log messages are written to the umsa_pma.log file in the home2/spmaster/ADMIN/logs directory. Figure 5-8 provides an example of this file.

The loggingData.ini file defines the types of information and activities that will be logged for UMSA and PMA


Figure 5-8: umsa_pma.log File Example

Managing Log Files on the GateServer

The logging features are configurable, primarily in the UM.ini files. The settings are generally set during the configuration process by the Quick Configuration tool. Logging settings can, however, be modified at any time to meet your needs. For information on configuring detail levels and logging settings, refer to the uOne Administration Manual. Logging settings can be changed dynamically using the umcli tool.

Log Remover Utility

The LogRemover utility constantly monitors logs and moves or deletes them as defined by the rules in the LogRemover.ini file. By default, Log Remover acts on Cisco generated logs. LogRemover runs on the GateServer only. LogRemover rules can be defined for individual log files. For example, you might want to delete one log file and move another. You can configure periodic delays during rules processing to minimize LogRemover's impact on CPU and I/O usage. You can also configure a time period that must elapse before the LogRemover utility can start rules processing again.

The files specified, and the rules for removal are set up in the LogRemover.ini file during system configuration by the Quick Configuration tool. If necessary, you may change the log removal rules at anytime.

See the uOne Administration Manual for additional information about the Log Remover.ini file.

Managing Messaging Server Log Files

MWI_PlugIn, notifier, and MWI_PassOff logging occurs on the Messaging Server via the syslog user facility. See the /etc/syslog.conf file for information about where the logs are configured and the severity that is logged.


hometocprevnextglossaryfeedbacksearchhelp
Posted: Mon Sep 25 19:39:36 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.