IMPORTANT:
Supported Components
Category | Description |
---|---|
AAARADIUS | Pertains to authentication, authorization, and accounting (AAA) functionality using the RADIUS protocol functionality. |
ADHOCRPT | Pertains to ad-hoc report generation functionality |
AlarmMgmtMain | Pertains to SNMP alarm management functionality. |
APN | Pertains to Access Point Name (APN) functionality |
CA | Pertains to Context Administration (CA) functionality. |
CAT | Pertains to Config Audit Trail (CAT) functionality. |
CDR | Pertains to Charging Detail Record (CDR) functionality. |
CHARGINGSVC | Pertains to integrated Enhanced Charging Service (ECS) functionality. |
CPU | Pertains to system Central Processing Unit (CPU) state information. |
CSM | Pertains to Client Session Management (CSM) functionality. |
CSP | Pertains to the system’s Card, Slot, Port (CSP) software task. |
CSS | Pertains to Content Service Steering (CSS) functionality. |
DB | Pertains to Data Base (DB) functionality. |
DHCP | Pertains to DHCP functionality. |
FM | Pertains to Fault Management (FM) functionality. |
GBLCMDS | Pertains to system Global Commands (GBLCMDS) functionality. |
starent-tableGGSN | Pertains to GGSN functionality. |
starent-tableGTPC | Pertains to GTP Control (GTPC) functionality. |
GTPP | Pertains to GTP Prime (GTPP) functionality. |
IMGCACHE | Pertains to system Information Cache (IMGCACHE) functionality. |
IMGKA | Pertains to system Keep-Alive (IMGKA) functionality. |
IMGLicense | Pertains to system session and feature-use licensing. |
Interceptor | Pertains to Client interceptor methods functionality. |
IPSec | Pertains to IP Security functionality. |
L2TP | Pertains to L2TP functionality. |
Logs | Pertains to system log functionality. |
MIP | Pertains to Mobile IP functionality. |
Monitor | Pertains to Monitor functionality. |
NR | Pertains to Network Reachability Server Configuration functionality. |
ORBEM | Pertains to Common Object Broker Request Architecture (CORBA) functionality. |
OSPF | Pertains to OSPF routing functionality. |
Pdsn | Pertains to PDSN functionality. |
PM | Pertains to Process Monitor (PM) functionality. |
PortMon | Pertains to system port monitoring functionality. |
PPP | Pertains to PPP functionality. |
PS | Pertains to polling support functionality. |
RP | Pertains to RP interface functionality. |
ScbrSessMgt | Pertains to subscriber session management functionality. |
SessionSubsystem | Pertains to the system session subsystem software. |
SNMP | Pertains to SNMP functionality. |
SVPN | Pertains to the system Virtual Private Network (VPN) software tasks. |
System | Pertains to system functionality. |
TCA | Pertains to threshold crossing alert functionality. |
Topology | Pertains to Topology interface functionality. |
UA | Pertains to User Administration functionality. |
UCM | Pertains to Access Service Configuration (UCM) functionality. |
UPref | Pertains to User Preferences functionality. |
SWU | Pertains to Software Upgrade functionality. |
ConfigBackup | Pertains to the Web Element Manager’s configuration backup functionality. |
Configuring Appender Settings
Asynchronous Appender Settings
<appender name="appender_name" class="AsyncAppender">
<param
name="BufferSize" value="size"/>
<appender-ref ref="attached_appender"/>
</appender>
Variable | Description |
---|---|
appender_name |
The name of the appender.
|
size |
Specifies the number
of events to be stored in buffer. This is configured as a non-negative
integer value. The default is 128 events.
|
attached_appender |
The name of an appender
to be attached to this appender.
|
Console Appender Settings
<appender name="appender_name" class="ConsoleAppender">
<param
name="Target" value="output"/>
<layout class="layout_class">
<param name="ConversionPattern" value="conv_pattern"/>
</layout>
</appender>
Variable | Description |
---|---|
appender_name |
The name of the appender.
|
output |
Specifies the file output
as either stdout or stderr. The default target is stdout.
|
layout_class |
Specifies the format
of the log file output. Refer to the Log File Output Formats section
of this chapter for information on supported output formats.
|
conv_pattern |
Specifies the conversion
pattern used to format event related information. Refer to the Pattern Layout Supported
Conversion Characters table for a list of supported conversion
characters.
|
File Appender Settings
<appender name="appender_name" class="FileAppender">
<param
name="File" value="file_name"/>
<param
name="Append" value="append_option"/>
<layout class="layout_class">
<param name="ConversionPattern" value="conv_pattern"/>
</layout>
</appender>
Variable | Description |
---|---|
appender_name |
The name of the appender.
|
file_name |
Specifies the name of
the output file.
|
append_option |
Dictates whether log
information will be appended to the file or not. This can be set
to either of the following options:
|
layout_class |
Specifies the format
of the log file output. Refer to Log File Output Formats section
of this chapter for information on supported output formats.
|
conv_pattern |
Specifies the conversion
pattern used to format event related information. Refer to the Pattern Layout Supported
Conversion Characters table for a list of supported conversion
characters.
|
Rolling File Appender Settings
<appender name="appender_name" class="RollingFileAppender">
<param
name="File" value="file_name"/>
<param
name="Append" value="append_option"/>
<param
name="MaxFileSize" value="size"/>
<param
name="MaxBackupIndex" value="max_backups"/>
<layout class="layout_class">
<param
name="ConversionPattern" value="conv_pattern"/>
</layout>
</appender>
Variable | Description |
---|---|
appender_name |
The name of the appender.
By default, each configuration file has a single appender configured
called Main-- each logger within the file are configured to use
this appender by default.
Additional appenders
can be added to the configuration file using the defined format.
This allows you to specify an appender for each logger if desired.
|
file_name |
Specifies the name of
the output file.
|
append_option |
Dictates whether log
information will be appended to the file or not. This can be set
to either of the following options:
|
size |
Specifies the maximum
size (in mega bytes) a log file can reach before creating a backup file
and starting a new log file. This can be configured to any integer
value from 0 to (263-1). The suffixes “KB”, “MB” or “GB” so
that the integer is interpreted being expressed respectively in
kilobytes, megabytes or gigabytes. (For example, the value “10KB” is interpreted
as 10240 Bytes.)
The default value is
5MB.
|
max_backups |
Specifies How many backup
files are kept before the oldest is erased. It can be configured as
a non-negative integer value. A value of 0 generates no backup files
no backup files and truncates the log file when it reaches MaxFileSize.
The default value is
10.
|
layout_class |
Specifies the format
of the log file output. Refer to the Log File Output Formats section
of this chapter for information on supported output formats.
|
conv_pattern | Specifies the conversion pattern used to format event related information. Refer to the Pattern Layout Supported Conversion Characters table for a list of supported conversion characters. |
Daily Rolling File Appender Settings
<appender name="appender_name" class="DailyRollingFileAppender">
<param
name="File" value="file_name"/>
<param
name="Append" value="append_option"/>
<param
name="DatePattern" value="date_format"/>
<layout class="layout_class">
<param name="ConversionPattern" value="conv_pattern"/>
</layout>
</appender>
Variable | Description |
---|---|
appender_name |
The name of the appender.
By default, each configuration file has a single appender configured
called Main-- each
logger within the file are configured to use this appender by default.
Additional appenders
can be added to the configuration file using the defined format.
This allows you to specify an appender for each logger if desired.
|
file_name |
Specifies the name of
the output file.
|
append_option |
Dictates whether log
information will be appended to the file or not. This can be set
to either of the following options:
|
date_format |
Specifies the date format.
The following time and date options are supported:
|
layout_class |
Specifies the format
of the log file output. Refer to the Log File Output Formats section
of this chapter for information on supported output formats.
|
conv_pattern |
Specifies the conversion
pattern used to format event related information. Refer to the Pattern Layout Supported
Conversion Characters table for a list of supported conversion
characters.
|
Socket Appender Settings
Telnet Appender Settings
SMTP Appender Settings
<appender name="appender_name" class="SMTPAppender">
<param
name="BufferSize" value="size" />
<param
name="SMTPHost" value="smtp_host"/>
<param
name="From" value="sender"/>
<param
name="To" value="recipient"/>
<param
name="Subject" value="subject"/>
<layout class="layout_class">
<param
name="ConversionPattern" value="conv_pattern"/>
</layout>
</appender>
Variable | Description |
---|---|
appender_name |
The name of the appender.
|
size |
Specifies the maximum
number of logging events to collect in a cyclic buffer. When the BufferSize is reached,
the oldest events are deleted as new events are added to the buffer.
The size can be configured
to a non-negative integer value. The default size of the cyclic
buffer is 512 events.
|
smtp_host |
Specifies the SMTP mail
server.
|
sender |
Specifies the e-mail
address of the sender.
|
recipient |
Specifies the e-mail
address of the recipient.
|
subject |
Specifies a subject
for the e-mail.
|
layout_class |
Specifies the format
of the log file output. Refer to the Log File Output Formats section
of this chapter for information on supported output formats.
|
conv_pattern |
Specifies the conversion
pattern used to format event related information. Refer to the Pattern Layout Supported
Conversion Characters table for a list of supported conversion
characters.
|
Log File Output Formats
HTML Layout
TTCC Layout
CAUTION:
<layout class="TTCCLayout"/>
<param
name="DatePattern" value="date_format"/>
</layout>
Variable | Description |
---|---|
date_format |
Specifies the date format.
The following time and date options are supported:
|
Pattern Layout
<layout class="org.apache.log4j.PatternLayout"/>
<param
name="ConversionPattern" value="pattern"/>
</layout>
Character | Description |
---|---|
c |
Used to output the logger
of the logging event. The logger conversion specifier can be optionally
followed by precision specifier, that is a decimal constant in brackets.
If a precision specifier
is given, then only the corresponding number of right most components
of the logger name will be printed. By default the logger name is
printed in full.
For example, for the
logger name “a.b.c” the pattern %c{2} will
output “b.c”.
|
d |
Used to output the date
of the logging event. The date conversion specifier may be followed
by a date format specifier enclosed between braces. For example, %d{%H:%M:%S} or %d{%d %b %Y %H:%M:%S}.
If no date format specifier is given then ISO8601 format is assumed.The
following format options are possible:
You can also use the
enhanced logging function’s predefined date formatters.
These can be specified using one of the following strings:
For example, %d{ISO8601} or %d{ABSOLUTE}.
|
F |
Used to output the file
name where the logging request was issued.
|
l |
Used to output location
information of the caller which generated the logging event.
|
L |
Used to output the line
number from where the logging request was issued.
|
m |
Used to output the application
supplied message associated with the logging event.
|
n |
Outputs the platform
dependent line separator character or characters.
This conversion character
offers practically the same performance as using non-portable line
separator strings such as “\n”, or “\r\n”.
Thus, it is the preferred way of specifying a line separator.
|
p |
Used to output the level
(priority) of the logging event.
|
r |
Used to output the number
of milliseconds elapsed since the start of the application until the
creation of the logging event.
|
t |
Used to output the name
of the thread that generated the logging event.
|
x |
Used to output the NDC
(nested diagnostic context) associated with the thread that generated
the logging event.
|
% |
The sequence %% outputs
a single percent sign.
|
Configuring Logger Settings
<logger name="name" additivity="add_option">
<level
value="severity"/>
<appender-ref
ref="appender_name"/>
</logger>
Variable | Description |
---|---|
name |
The name of the WEM
component of category for which logging parameters are being configured.
|
add_option |
Specifies whether or
not the logger is to inherit the appenders defined within the root element
of the configuration file. The following options are supported:
|
severity |
Specifies the severity
level of events to log. The following severity levels are supported:
|
appender_name |
The name of the appender
to use for this logger.
|
Configuring Log Message Filters
Level Match Filters
<filter class="LevelMatchFilter">
<param
name="LevelToMatch" value="severity" />
<param
name="AcceptOnMatch" value="accept_option"/>
</filter>
Variable | Description |
---|---|
severity |
Specifies the severity
level of events to filter. The following severity levels are supported:
|
accept_option |
Specifies whether or
not the logger is to accept logs that match the specified severity. The
following options are supported:
|
Level Range Filters
<filter class="LevelRangeFilter">
<param
name="LevelMax" value="max_sev"/>
<param
name="LevelMin" value="min_sev"/>
<param
name="AcceptOnMatch" value="accept_option"/>
</filter>
Variable | Description |
---|---|
max_sev |
Specifies the maximum
severity level for the range of events to filter. The following severity
levels are supported:
|
min_sev |
Specifies the minimum
severity level for the range of events to filter. The following severity
levels are supported:
|
accept_option |
Specifies whether or
not the logger is to accept logs that fall within the specified severity
range. The following options are supported:
|
String Match Filters
<filter class="StringMatchFilter">
<param
name="StringToMatch" value="string" />
<param
name="AcceptOnMatch" value="accept_option"/>
</filter>
Variable | Description |
---|---|
string |
Specifies the text string
upon which to filter the log.
|
accept_option |
Specifies whether or
not the logger is to accept logs that match the specified severity. The
following options are supported:
|
Deny Filters
<filter class="LevelMatchFilter">
<param
name="LevelToMatch" value="WARN" />
<param
name="AcceptOnMatch" value="true"/>
</filter>
<filter class="DenyAllFilter">
Configuring Support for Dynamic Logging Updates
<root>
<priority value="WARN"/>
<!-- A delay used
by the Watchdog thread to continuously read/check
the modified configuration
applies to EMS Logger-->
<delay value="3000"/>
<appender-ref
ref="Main"/>
</root>