ON THIS PAGE
Specify the Facility and Severity of Messages to Include in the Log
Direct System Log Messages to a Remote Machine or the Other Routing Engine
Specify an Alternative Source Address for System Log Messages Directed to a Remote Destination
Add a Text String to System Log Messages Directed to a Remote Destination
Change the Alternative Facility Name for System Log Messages Directed to a Remote Destination
Default Facilities for System Log Messages Directed to a Remote Destination
Alternate Facilities for System Log Messages Directed to a Remote Destination
Examples: Assign an Alternative Facility to System Log Messages Directed to a Remote Destination
Direct System Log Messages to a Remote Destination
Specify the Facility and Severity of Messages to Include in the Log
Each system log message belongs to a facility, which groups together messages that either are generated by the same source (such as a software process) or concern a similar condition or activity (such as authentication attempts). Each message is also preassigned a severity level, which indicates how seriously the triggering event affects routing platform functions.
When you configure logging for a facility and destination, you specify a severity level for each facility. Messages from the facility that are rated at that level and higher are logged to the following destination:
[edit system syslog]
(console | file filename | host destination | user username) {
facility severity ;
}For more information about the destinations, see Directing System Log Messages to a User Terminal, and, Directing System Log Messages to the Console.
To log messages belonging to more than one facility to a particular destination, specify each facility and associated severity as a separate statement within the set of statements for the destination.
Table 1 lists
the Junos OS system logging facilities that you can specify in configuration
statements at the [edit system syslog] hierarchy level.
Facility |
Type of Event or Error |
|---|---|
|
All (messages from all facilities) |
|
Authentication and authorization attempts |
|
Changes to the Junos OS configuration |
|
Specified configuration is invalid on the router type |
|
Actions performed or errors encountered by system processes |
|
Events related to dynamic flow capture |
|
Include priority and facility in system log messages |
|
Actions performed or errors encountered by the local external applications |
|
Packet filtering actions performed by a firewall filter |
|
Actions performed or errors encountered by the FTP process |
|
Commands issued at the Junos OS command-line interface (CLI) prompt or by a client application such as a Junos XML protocol or NETCONF XML client |
|
Actions performed or errors encountered by the Junos OS kernel |
|
Actions performed or errors encountered by the Network Time Protocol processes |
|
Actions performed or errors encountered by the Packet Forwarding Engine |
|
Actions performed or errors encountered by user-space processes |
Table 2 lists
the severity levels that you can specify in configuration statements
at the [edit system syslog] hierarchy level. The levels
from emergency through info are in order from
highest severity (greatest effect on functioning) to lowest.
Unlike the other severity levels, the none level disables logging of a facility instead of indicating how seriously
a triggering event affects routing functions. For more information,
see Disabling the System Logging of a Facility.
Value |
Severity Level |
Description |
|---|---|---|
N/A |
|
Disables logging of the associated facility to a destination |
0 |
|
System panic or other condition that causes the router to stop functioning |
1 |
|
Conditions that require immediate correction, such as a corrupted system database |
2 |
|
Critical conditions, such as hard errors |
3 |
|
Error conditions that generally have less serious consequences than errors at the emergency, alert, and critical levels |
4 |
|
Conditions that warrant monitoring |
5 |
|
Conditions that are not errors but might warrant special handling |
6 |
|
Events or nonerror conditions of interest |
7 |
|
Includes all severity levels |
Direct System Log Messages to a Log File
To direct system log messages to a file in the /var/log directory of the local Routing Engine,
include the file statement at the [edit system syslog] hierarchy level:
[edit system syslog] file filename { facility severity; archive <archive-sites (ftp-url <password password>)> <files number> <size size> <start-time "YYYY-MM-DD.hh:mm"> <transfer-interval minutes> <world-readable | no-world-readable>; explicit-priority; match "regular-expression"; structured-data { brief; } }
For the list of facilities and severity levels, see Specifying the Facility and Severity of Messages to Include in the Log.
To prevent log files from growing too large, the
Junos OS system logging utility by default writes messages to a sequence
of files of a defined size. By including the archive statement,
you can configure the number of files, their maximum size, and who
can read them, either for all log files or for a certain log file.
For more information, see Specifying Log File Size, Number, and Archiving
Properties.
For information about the following statements, see the indicated sections:
explicit-priority—See Including Priority Information in System Log Messagesmatch—See Using Strings and Regular Expressions to Refine the Set of Logged Messagesstructured-data—See Logging Messages in Structured-Data Format
Direct System Log Messages to a User Terminal
To direct system log messages to the terminal session
of one or more specific users (or all users) when they are logged
in to the local Routing Engine, include the user statement
at the [edit system syslog] hierarchy level:
[edit system syslog] user (username | *) { facility severity; match "regular-expression"; }
Specify one or more Junos OS usernames, separating
multiple values with spaces, or use the asterisk (*) to
indicate all users who are logged in to the local Routing Engine.
For the list of logging facilities and severity
levels, see Specifying the Facility and Severity of Messages
to Include in the Log. For information about the match statement, see Using Strings and Regular Expressions to Refine
the Set of Logged Messages.
Direct System Log Messages to the Console
To direct system log messages to the console of
the local Routing Engine, include the console statement
at the [edit system syslog] hierarchy level:
[edit system syslog] console { facility severity; }
For the list of logging facilities and severity levels, see Specifying the Facility and Severity of Messages to Include in the Log.
Direct System Log Messages to a Remote Machine or the Other Routing Engine
To direct system log messages to a remote machine or to the other Routing Engine,
include the host statement at the
[edit system syslog] hierarchy level:
[edit system syslog] host (hostname | other-routing-engine) { facility severity; explicit-priority; facility-override facility; log-prefix string; match "regular-expression"; source-address source-address; structured-data { brief; } } source-address source-address;
To direct system log messages to a remote machine, include the host
hostname statement to specify the remote machine’s IP version 4
(IPv4) address, IP version 6 (IPv6) address, or fully
qualified hostname. The remote machine must be running the standard
syslogd utility. We do not recommend directing messages to
another Juniper Networks device. In each system log message directed to the remote
machine, the hostname of the local Routing Engine appears after the
timestamp to indicate that it is the source for the message.
To direct system log messages to the other Routing Engine on a device with two
Routing Engines installed and operational, include the
host other-routing-engine statement. The statement is not
automatically reciprocal, so you must include it in each Routing Engine
configuration if you want the Routing Engines to direct messages to each other. In
each message directed to the other Routing Engine, the string re0
or re1 appears after the timestamp to indicate the source for the
message.
For the list of logging facilities and severity levels to configure under the
host statement, see Specifying
the Facility and Severity of Messages to Include in the Log.
To record facility and severity level information in each message, include the
explicit-priority statement. For more information, see Including Priority
Information in System Log Messages.
For information about the match statement, see Using Strings and Regular Expressions to Refine the Set of Logged
Messages.
When directing messages to remote machines, you can include the
source-address statement to specify the IP address of the
device that is reported in the messages as their source. In each
host statement, include the facility-override
statement to assign an alternative facility and the log-prefix
statement to add a string to each message. You can include the
structured-data statement to enable the forwarding of
structured system log messages to a remote system log server in the
IETF system log message format.
Specify an Alternative Source Address for System Log Messages Directed to a Remote Destination
To specify the source router to be reported in system log messages when the messages are directed
to a remote machine, include the source-address statement
at the [edit system syslog] hierarchy level:
[edit system syslog] source-address source-address;
source-address is a valid IPv4 or IPv6 address configured on one of the router interfaces.
The address is reported in the messages directed to all remote machines
specified in host hostname statements
at the [edit system syslog] hierarchy level,
but not in messages directed to the other Routing Engine.
Add a Text String to System Log Messages Directed to a Remote Destination
To add a text string to every system log message
directed to a remote machine or to the other Routing Engine, include
the log-prefix statement at the [edit system syslog host] hierarchy level:
[edit system syslog host (hostname | other-routing-engine)] facility severity; log-prefix string;
The string can contain any alphanumeric or special character except the equal sign ( = ) and the colon ( : ). It also cannot include the space character; do not enclose the string in quotation marks (“ ”) in an attempt to include spaces in it.
The Junos OS system logging utility automatically appends a colon and a space to the specified string when the system log messages are written to the log. The string is inserted after the identifier for the Routing Engine that generated the message.
The following example shows how to add the string M120 to all messages to indicate that the router is an M120 router, and direct the messages to the remote machine hardware-logger.mycompany.com:
[edit system syslog]
host hardware-logger.mycompany.com {
any info;
log-prefix M120;
}
When these configuration statements are included on an M120 router called origin1, a message in the system log on hardware-logger.mycompany.com looks like the following:
Mar 9 17:33:23 origin1 M120: mgd[477]: UI_CMDLINE_READ_LINE: user ‘root’, command ‘run show version’
Change the Alternative Facility Name for System Log Messages Directed to a Remote Destination
Some facilities assigned to messages logged on
the local router or switch have Junos OS-specific names (see Junos OS System Logging Facilities). In the recommended configuration, a remote machine designated
at the [edit system syslog host hostname] hierarchy level is not a Juniper Networks router or switch,
so its syslogd utility cannot interpret the Junos OS-specific names.
To enable the standard syslogd utility to handle messages from these
facilities when messages are directed to a remote machine, a standard localX facility name is used instead of
the Junos OS-specific facility name.
Default Facilities for System Log Messages Directed to a Remote Destination lists the default alternative facility name next to the Junos OS-specific facility name it is used for.
The syslogd utility on a remote machine handles
all messages that belong to a facility in the same way, regardless
of the source of the message (the Juniper Networks router or switch
or the remote machine itself). For example, the following statements
in the configuration of the router called local-router direct
messages from the authorization facility to the remote
machine monitor.mycompany.com:
[edit system syslog]
host monitor.mycompany.com {
authorization info;
}
The default alternative facility for the local authorization facility is also authorization. If
the syslogd utility on monitor is configured to write messages
belonging to the authorization facility to the file /var/log/auth-attempts, then the file contains the
messages generated when users log in to local-router and
the messages generated when users log in to monitor. Although
the name of the source machine appears in each system log message,
the mixing of messages from multiple machines can make it more difficult
to analyze the contents of the auth-attempts file.
To make it easier to separate the messages from each source,
you can assign an alternative facility to all messages generated on local-router when they are directed to monitor. You can then configure the syslogd utility
on monitor to write messages with the alternative facility
to a different file from messages generated on monitor itself.
To change the facility used for all messages directed
to a remote machine, include the facility-override statement
at the [edit system syslog host hostname] hierarchy level:
[edit system syslog host hostname] facility severity; facility-override facility;
In general, it makes sense to specify an alternative
facility that is not already in use on the remote machine, such as
one of the localX facilities. On the
remote machine, you must also configure the syslogd utility to handle
the messages in the desired manner.
Facilities for the facility-override Statement lists
the facilities that you can specify in the facility-override statement.
We do not recommend including the facility-override statement at the [edit system syslog host other-routing-engine] hierarchy level. It is not necessary to use alternative facility
names when directing messages to the other Routing Engine, because
its Junos OS system logging utility can interpret the Junos OS-specific
names.
The following example shows how to log all messages generated on the local router at the error level or higher to the local0 facility on the remote machine called monitor.mycompany.com:
[edit system syslog]
host monitor.mycompany.com {
any error;
facility-override local0;
}
The following example shows how to configure routers located in California and routers located in New York to send messages to a single remote machine called central-logger.mycompany.com. The messages from California are assigned to alternative facility local0 and the messages from New York are assigned to alternative facility local2.
Configure California routers to aggregate messages in the local0 facility:
[edit system syslog] host central-logger.mycompany.com { change-log info; facility-override local0; }Configure New York routers to aggregate messages in the local2 facility:
[edit system syslog] host central-logger.mycompany.com { change-log info; facility-override local2; }
On central-logger, you can then configure the system logging utility to write messages from the local0 facility to the file change-log and the messages from the local2 facility to the file new-york-config.
Default Facilities for System Log Messages Directed to a Remote Destination
Table 3 lists the default alternative facility name next to the Junos OS-specific facility name for which it is used. For facilities that are not listed, the default alternative name is the same as the local facility name.
Junos OS–Specific Local Facility |
Default Facility When Directed to Remote Destination |
|---|---|
change-log |
local6 |
conflict-log |
local5 |
dfc |
local1 |
firewall |
local3 |
interactive-commands |
local7 |
pfe |
local4 |
Alternate Facilities for System Log Messages Directed to a Remote Destination
Table 4 lists the facilities
that you can specify in the facility-override statement.
Facility |
Description |
|---|---|
|
Authentication and authorization attempts |
|
Actions performed or errors encountered by system processes |
|
Actions performed or errors encountered by the FTP process |
|
Actions performed or errors encountered by the Junos OS kernel |
|
Local facility number 0 |
|
Local facility number 1 |
|
Local facility number 2 |
|
Local facility number 3 |
|
Local facility number 4 |
|
Local facility number 5 |
|
Local facility number 6 |
|
Local facility number 7 |
|
Actions performed or errors encountered by user-space processes |
We do not recommend including the facility-override statement at the [edit system syslog host other-routing-engine] hierarchy level. It is not necessary to use alternative facility
names when directing messages to the other Routing Engine, because
its Junos OS system logging utility can interpret the Junos OS-specific
names.
Examples: Assign an Alternative Facility to System Log Messages Directed to a Remote Destination
Log all messages generated on the local routing platform at
the error level or higher to the local0 facility on the
remote machine called monitor.mycompany.com:
[edit system syslog]
host monitor.mycompany.com {
any error;
facility-override local0;
}Configure routing platforms located in California and routing platforms located in New York to send messages to a single remote machine called central-logger.mycompany.com. The messages from California are assigned alternative facility local0 and the messages from New York are assigned to alternative facility local2.
Configure California routing platforms to aggregate messages in the
local0facility:[edit system syslog] host central-logger.mycompany.com { change-log info; facility-override local0; }Configure New York routing platforms to aggregate messages in the
local2facility:[edit system syslog] host central-logger.mycompany.com { change-log info; facility-override local2; }
On central-logger, you can then configure the system
logging utility to write messages from the local0 facility
to the file california-config and
the messages from the local2 facility to the file new-york-config.