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.
To configure and save a log stream to a log file you:
- Enter a Name for the log stream-this is the name used by the server to identify the log stream.
- Enter a Prefix for the log files—this prefix is prepended to each log file created for the log stream.
- Configure the File Settings—these settings define how often the log files for this particular log stream are created, and how long they are stored.
- Configure the Log Detail—configure the level of detail to be captured for each log group using the event level slidebar for the respective log group.
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.
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.
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.
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.
Log groups specify the type of server functionality for which you want to log events. The log groups listed in Table 36 are available:
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:
- Select Server Management > Logging > New.
The New Log Stream dialog opens, see Figure 111.
- Enter a name for the log stream in the Name field.
- To easily identity the log files associated with the log stream, enter a prefix for the log file in the Prefix field.
- Select the desired File Settings (Table 37):
- Using the event level slidebars, configure the event level you want to log for each log group.
- Click OK to add the log stream to the list of log streams.
Editing an Existing Log Stream
To edit an existing log stream:
- Select Server Management > Logging .
The content frame displays a list of existing Log Streams as shown in Figure 112.
- 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.
- Make the desired changes to the log stream and click OK.
Deleting a Log Stream
- Select Server Management > Logging .
The content frame displays a list of existing log streams as shown in Figure 112.
- Select the log stream you want to delete and click Delete.
You are prompted to confirm the delete operation. Click
Yesto delete the log stream or
Noto cancel the operation.