[Contents] [Prev] [Next] [Index] [Report an Error] [No Frames]


Event Logging

This section describes how to set up and use the event logging function in IMS AAA Server.

The IMS AAA Server provides the ability to capture log streams. Log streams capture different groups of server related events at various levels of granularity. You may configure the IMS AAA Server to capture any number of log streams. Each log stream is saved in a separate text file called a log file. Each log file is date stamped, and can be assigned a prefix for easy identification. The format for log files is Prefix_Date.log.

The level of granularity in a log stream is configurable by selecting the event level for the log group. The log group specifies the type of server related events to be captured, and the event level specifies the level of granularity. Figure 111 shows the Log Stream dialog.


Figure 111: Log Stream Dialog

Events

To configure and save a log stream to a log file you:

In general, each event level includes all event types of a less verbose type. For example, if you configure an event level of "Warning", then warnings and errors will be logged to the specified Log Stream. The event levels in order of increasing verbosity are shown in Table 35.

Table 35: Event Levels 
Event Level
Description

None

No events will be logged for the Log Group.

Error

An error is defined as an event that may cause the system to operate incorrectly. Examples include exceptions being thrown, an inability to continue processing a transaction, or configuration errors that cause a component to fail to start.

Warning

Warnings are less severe than errors, in that a warning should be logged when the system was able to handle an unexpected input or condition without any threat to the operation of the server. Examples of warnings include invalid packet contents, protocol violations, possibly security violations, ignored configuration data, and failures to contact remote servers.

Standard

Standard logging messages are defined as "what the average administrator would want to see during normal operation."

Detail

Detail logging is intended to inform why and how the particular result indicated by standard logging was reached. Server components that perform significant processing on the transaction, such as determining validity of the packet contents, log details about decisions they made. All server components that route the transaction through different processing based on the nature of the transaction, log their routing activity at this level. The detail log is allowed to refer to the contents of messages logged at the "standard" level; that is, it will never be read without the standard messages.

Debug

Debug logging is provided for the benefit of engineering only.


Log Groups

Log groups specify the type of server functionality for which you want to log events. The log groups listed in Table 36 are available:

Table 36: Log Groups 
Log Group
Description

Administration

This log group reports events related to server administration such as:

  •     A server access log, including identity of the administrator. This is available using the Standard event level.
  •     Changes made to the server configuration, including identity of the administrator. This is available using the Detail event level.

AuthAccept

This log group reports events related to activity resulting in an authentication or authorization accept.

AuthFailure

This log group reports events related to activity resulting in an authentication or authorization failure.

AuthReject

This log group reports events related to activity resulting in an authentication or authorization reject.

Configuration

This log group reports events related to configuration.

Packet

This log group reports events related to transaction processing.

PacketTrace

This log group displays content of a packet in a <attribute name>:<attribute value> format.

PacketTraceRaw

This log group displays content of a packet in its raw (octets) format.

PeerStateMachine

This log group reports events related to the Peer State Machine as specified in RFC3588.

System

This log group reports events related to the system such as:

  • Resource failures (no memory, file not found, disk full, etc.)
  • Unknown exceptions
  • System start
  • System stop

Using Event Logging

Be careful when using event logging because it consumes server resources while capturing events, and consumes disk space to store the log files. As such, event logging is typically used for troubleshooting purposes. We recommend you limit the amount of information captured in a log stream to control the consumption of server resources and disk space. This also makes it easier to interpret the information in the log files. For example, you might configure one log stream to capture only configuration related events only by selecting the Configuration log group event level to Detail, and setting all other log group event levels to None.

Configuring a New Log Stream

To configure a new log stream:

  1. Select Server Management > Logging > New.

The New Log Stream dialog opens, see Figure 111.

  1. Enter a name for the log stream in the Name field.
  2. To easily identity the log files associated with the log stream, enter a prefix for the log file in the Prefix field.
  3. Select the desired File Settings (Table 37):

    Table 37: File Settings 
    File Settings
    Description

    Create new file on server start

    A new log file will be created each time the server starts.

    Create new file after logging n number of bytes

    If selected, a new log file will be created after n bytes. The Bytes field is enabled when the option is selected.

    Create new file every n minutes

    If selected, a new log file will be created every n minutes. The Minutes field is enabled when the option is selected.

    Automatically delete files after n days

    If selected, the log file will be deleted after n days. The Days field is enabled when the option is selected.


  1. Using the event level slidebars, configure the event level you want to log for each log group.
  2. Click OK to add the log stream to the list of log streams.

Editing an Existing Log Stream

To edit an existing log stream:

  1. Select Server Management > Logging .

The content frame displays a list of existing Log Streams as shown in Figure 112.


Figure 112: Log Streams
  1. Select the log stream you want to edit and click Edit.

An edit dialog equivalent to the New Log Stream dialog shown in Figure 111 opens.

  1. Make the desired changes to the log stream and click OK.

Deleting a Log Stream

  1. Select Server Management > Logging .

The content frame displays a list of existing log streams as shown in Figure 112.

  1. Select the log stream you want to delete and click Delete.

You are prompted to confirm the delete operation. Click Yes to delete the log stream or No to cancel the operation.


[Contents] [Prev] [Next] [Index] [Report an Error] [No Frames]