Syslog#Severity level

{{short description|Network event logging system and protocol}}

{{Infobox software

| name = Syslog

| logo =

| screenshot =

| caption =

| collapsible =

| author = Eric Allman

| developer =

| released = 1980s

| discontinued =

| latest release version =

| frequently updated =

| programming language =

| operating system = Unix-like

| platform =

| size =

| language =

| status =

| genre = System logging

| license =

}}

In computing, syslog ({{IPAc-en|'|s|ɪ|s|l|ɒ|g}}) is a standard for message logging. It allows separation of the software that generates messages, the system that stores them, and the software that reports and analyzes them. Each message is labeled with a facility code, indicating the type of system generating the message, and is assigned a severity level.

Computer system designers may use syslog for system management and security auditing as well as general informational, analysis, and debugging messages. A wide variety of devices, such as printers, routers, and message receivers across many platforms use the syslog standard. This permits the consolidation of logging data from different types of systems in a central repository. Implementations of syslog exist for many operating systems.

When operating over a network, syslog uses a client-server architecture where a syslog server listens for and logs messages coming from clients.

History

Syslog was developed in the 1980s by Eric Allman as part of the Sendmail project.{{cite web |url=https://www.internethalloffame.org/inductees/eric-allman |title=Eric Allman |publisher=Internet Hall of Fame |access-date=2017-10-30}} It was readily adopted by other applications and has since become the standard logging solution on Unix-like systems.{{Cite web|date=2021-08-06|title=3 great engineering roles to apply for this week|url=https://venturebeat.com/2021/08/06/3-great-engineering-roles-to-apply-for-this-week/|access-date=2021-08-16|website=VentureBeat|language=en-US}} A variety of implementations also exist on other operating systems and it is commonly found in network devices, such as routers.{{Cite journal|title=Efficient and Robust Syslog Parsing for Network Devices in Datacenter Networks|url=https://ieeexplore.ieee.org/document/8988255|journal=IEEE Access|date=2020|volume=8|pages=30245–30261|author1=Zhang, Shenglin|author2=Liu, Ying|author3=Meng, Weibin|author4=Bu, Jiahao|author5=Yang, Sen|author6=Sun, Yongqian|author7=Pei, Dan|author8=Xu, Jun|author9=Zhang, Yuzhi|author10=Song, Lei|author11=Zhang, Ming|doi=10.1109/ACCESS.2020.2972691 |doi-access=free}}

Syslog originally functioned as a de facto standard, without any authoritative published specification, and many implementations existed, some of which were incompatible. The Internet Engineering Task Force documented the status quo in RFC 3164 in August 2001. It was standardized by RFC 5424 in March 2009.{{Cite IETF |rfc=5424 |last=Gerhards |first=Rainer |title=The Syslog Protocol}}

Various companies have attempted to claim patents for specific aspects of syslog implementations.{{cite web|url=http://lxer.com/module/newswire/view/64026/index.html|title=LXer: Patent jeopardizes IETF syslog standard}}{{cite web|url=http://datatracker.ietf.org/public/ipr_detail_show.cgi?ipr_id=724|title=IETF IPR disclosure on HUAWEI's patent claims}} This has had little effect on the use and standardization of the protocol.{{cn|date=August 2016}}

Message components

The information provided by the originator of a syslog message includes the facility code and the severity level. The syslog software adds information to the information header before passing the entry to the syslog receiver. Such components include an originator process ID, a timestamp, and the hostname or IP address of the device.

=Facility=

A facility code is used to specify the type of system that is logging the message. Messages with different facilities may be handled differently.{{cite web|url=http://linux.die.net/man/3/syslog|access-date=22 November 2012|title=Syslog Facility}} The list of facilities available is described by the standard:{{rp|9}}

class="wikitable"
Facility code

! Keyword

! Description

0kernKernel messages
1userUser-level messages
2mailMail system
3daemonSystem daemons
4authSecurity/authentication messages
5syslogMessages generated internally by syslogd
6lprLine printer subsystem
7newsNetwork news subsystem
8uucpUUCP subsystem
9cronCron subsystem
10authprivSecurity and authentication messages
11ftpFTP daemon
12ntpNTP subsystem
13securityLog audit
14consoleLog alert
15solaris-cronScheduling daemon
16–23local0 – local7Locally used facilities

The mapping between facility code and keyword is not uniform in different operating systems and syslog implementations.{{cite web |url=https://www.sans.org/white-papers/1490/ |title=The Ins and Outs of System Logging Using Syslog |publisher=SANS Institute}}

=Severity level=

The list of severities of issues is also described by the standard:{{rp|10}}

class="wikitable"
ValueSeverityKeywordDeprecated keywordsDescriptionCondition
0Emergencyemergpanic{{cite web|url=https://linux.die.net/man/5/syslog.conf |title=syslog.conf(5) - Linux man page |access-date=2017-03-29 |quote=The keywords error, warn and panic are deprecated and should not be used anymore.}}System is unusableA panic condition.{{cite web |url=http://pubs.opengroup.org/onlinepubs/009695399/functions/syslog.html |title=closelog, openlog, setlogmask, syslog - control system log |access-date=2017-03-29 |quote=LOG_NOTICE Conditions that are not error conditions, but that may require special handling.}}
1AlertalertAction must be taken immediatelyA condition that should be corrected immediately, such as a corrupted system database.
2CriticalcritCritical conditionsHard device errors.
3ErrorerrerrorError conditions
4WarningwarningwarnWarning conditions
5NoticenoticeNormal but significant conditionsConditions that are not error conditions, but that may require special handling.{{cite web |url=https://www.gnu.org/software/libc/manual/html_node/syslog_003b-vsyslog.html |title=The GNU C Library: syslog, vsyslog |access-date=2024-07-19 |quote=LOG_NOTICE The message describes a normal but important event.}}
6InformationalinfoInformational messagesConfirmation that the program is working as expected.
7DebugdebugDebug-level messagesMessages that contain information normally of use only when debugging a program.

The meaning of severity levels other than Emergency and Debug are relative to the application. For example, if the purpose of the system is to process transactions to update customer account balance information, an error in the final step should be assigned Alert level. However, an error occurring in an attempt to display the ZIP code of the customer may be assigned Error or even Warning level.

The server process that handles display of messages usually includes all lower (more severe) levels when the display of less severe levels is requested. That is, if messages are separated by individual severity, a Warning level entry will also be included when filtering for Notice, Info and Debug messages.{{Cite web|title=Severity Levels for Syslog Messages|url=https://cd.delphix.com/docs/latest/severity-levels-for-syslog-messages|access-date=2024-10-02|website=cd.delphix.com}}

=Message=

In RFC 3164, the message component (known as MSG) was specified as having these fields: TAG, which should be the name of the program or process that generated the message, and CONTENT which contains the details of the message.

Described in RFC 5424, "MSG is what was called CONTENT in RFC 3164. The TAG is now part of the header, but not as a single field. The TAG has been split into APP-NAME, PROCID, and MSGID. This does not totally resemble the usage of TAG, but provides the same functionality for most of the cases." Popular syslog tools such as NXLog, Rsyslog conform to this new standard.

The content field should be encoded in a UTF-8 character set and octet values in the traditional ASCII control character range should be avoided.{{Cite web|title=Transmission of Syslog Messages over TCP|url=https://www.ipa.go.jp/security/rfc/RFC6587EN.html|access-date=2021-08-16|website=www.ipa.go.jp}}

Logger

Generated log messages may be directed to various destinations including console, files, remote syslog servers, or relays. Most implementations provide a command line utility, often called logger, as well as a software library, to send messages to the log.{{Cite web|title=logger Command|url=https://www.ibm.com/docs/en/aix/7.2?topic=l-logger-command|access-date=2021-08-16|website=www.ibm.com|language=en-us}}

To display and monitor the collected logs one needs to use a client application or access the log file directly on the system. The basic command line tools are tail and grep. The log servers can be configured to send the logs over the network (in addition to the local files). Some implementations include reporting programs for filtering and displaying of syslog messages.

Network protocol

When operating over a network, syslog uses a client-server architecture where the server listens on a well-known or registered port for protocol requests from clients. Historically the most common transport layer protocol for network logging has been User Datagram Protocol (UDP), with the server listening on port 514.{{Cite web|title=Syslog Server|url=https://www.howtonetwork.com/technical/security-technical/syslog-server/|access-date=2021-08-16|website=www.howtonetwork.com}} Because UDP lacks congestion control mechanisms, Transmission Control Protocol (TCP) port 6514 is used; Transport Layer Security is also required in implementations and recommended for general use.{{cite journal|url=https://tools.ietf.org/html/rfc5424#section-8.6|title=RFC 5424 - The Syslog Protocol|date=March 2009|last1=Gerhards|first1=Rainer|doi=10.17487/RFC5424|website=tools.ietf.org }}{{cite journal|url=https://tools.ietf.org/html/rfc5425#section-7.1|title=RFC 5425 - TLS Transport Mapping for Syslog|date=March 2009|last1=Fuyou|first1=Miao|last2=Yuzhi|first2=Ma|last3=Salowey|first3=Joseph A.|editor-first1=F |editor-first2=Y |editor-first3=J |editor-last1=Miao |editor-last2=Ma |editor-last3=Salowey |doi=10.17487/RFC5425 |website=tools.ietf.org }}

Limitations

Since each process, application, and operating system was written independently, there is little uniformity to the payload of the log message. For this reason, no assumption is made about its formatting or contents. A syslog message is formatted (RFC 5424 gives the Augmented Backus–Naur form (ABNF) definition), but its MSG field is not.

The network protocol is simplex communication, with no means of acknowledging the delivery to the originator.

Outlook

Various groups are working on draft standards detailing the use of syslog for more than just network and security event logging, such as its proposed application within the healthcare environment.{{cite web |url=https://healthcaresecprivacy.blogspot.com/2011/12/atna-syslog-is-good-enough.html |title=ATNA + SYSLOG is good enough |date=2 January 2012 |publisher=Healthcare Exchange Standards |access-date=2018-06-06}}

Regulations, such as the Sarbanes–Oxley Act, PCI DSS, HIPAA, and many others, require organizations to implement comprehensive security measures, which often include collecting and analyzing logs from many different sources. The syslog format has proven effective in consolidating logs, as there are many open-source and proprietary tools for reporting and analysis of these logs. Utilities exist for conversion from Windows Event Log and other log formats to syslog.

Managed Security Service Providers attempt to apply analytical techniques and artificial intelligence algorithms to detect patterns and alert customers to problems.{{Cite book|last1=Yamanishi|first1=Kenji|last2=Maruyama|first2=Yuko|title=Proceedings of the eleventh ACM SIGKDD international conference on Knowledge discovery in data mining |chapter=Dynamic syslog mining for network failure monitoring |date=2005-08-21|chapter-url=https://doi.org/10.1145/1081870.1081927|series=KDD '05|location=Chicago, Illinois, USA|publisher=Association for Computing Machinery|pages=499–508|doi=10.1145/1081870.1081927|isbn=978-1-59593-135-1|s2cid=5051532}}

Internet standard documents

The Syslog protocol is defined by Request for Comments (RFC) documents published by the Internet Engineering Task Force (Internet standards). The following is a list of RFCs that define the syslog protocol:{{cite web

| title = Security Issues in Network Event Logging (syslog)

| url = http://datatracker.ietf.org/wg/syslog/ | publisher = IETF

}}

  • {{cite IETF |RFC=3164 |title=The BSD syslog Protocol}} (obsoleted by {{cite IETF |RFC=5424 |title=The Syslog Protocol}})
  • {{cite IETF |RFC=3195 |title=Reliable Delivery for syslog}}
  • {{cite IETF |RFC=5424 |title=The Syslog Protocol}}
  • {{cite IETF |RFC=5425 |title=TLS Transport Mapping for Syslog}}
  • {{cite IETF |RFC=5426 |title=Transmission of Syslog Messages over UDP}}
  • {{cite IETF |RFC=5427 |title=Textual Conventions for Syslog Management}}
  • {{cite IETF |RFC=5848 |title=Signed Syslog Messages}}
  • {{cite IETF |RFC=6012 |title=Datagram Transport Layer Security (DTLS) Transport Mapping for Syslog}}
  • {{cite IETF |RFC=6587 |title=Transmission of Syslog Messages over TCP}}

See also

References

{{Reflist}}