tcl-syslog - Syslog interface for Tcl
package require syslog
syslog::open ?-ident ident? ?-facility facility? ?-pid? ?-perror? ?-console?
syslog::log ?-level level? ?-format message_format? message
syslog::close
syslog ?-ident ident? ?-facility facility? -pid? ?-perror? level messageSyslog is a standard for forwarding log messages to local and other logging services available on an TCL/IP network. It is typically used for computer system management and security auditing; usually to aggregate log messages in a central repository. It is standardized within the Syslog working group of the IETF. Syslog is available in all POSIX compliant and POSIX-like Operating Systems.
This package provides a Tcl interface to the standard syslog service. It creates a Tcl namespace with commands for opening and closing the connection to the syslogd facility, sending messages to the syslog service and query the connection status. It's supposed to provide local and remote logging.
The current version provides also the global namespace command syslog for compatibility with earlier versions of the package which it's been revamped and extended to focus on resource consumption, computational overheads and multi-threading programming
The syslog facility is available to any process by calling the syslog command. If a connection to the syslog facility hasn't been already established syslog does it implicitly by calling openlog. Even though this is handy and preserved in tcl-syslog, calling openlog is meaninful if done just once at process startup. It's connection parameters are process-wide and shared among threads. For this purpose this version of the package implements three new command ::syslog::open, ::syslog::close and ::syslog::isopen. ::syslog::open accept options to be passed to openlog which are supposed to not change for the process lifetime. Actual logging is done through command ::syslog::log* which in turn accept its own set of options. Option to be passed to ::syslog::open are
-
-identident is an optional string argument that is used by syslog to differentiate between processes and log contexts. It is up to the user to specify any string here. -
-pidsets up syslog to print also the process pid in the log message. This options is most efficiently used as argument to -
-perrorprints the message also to stderr. -
-nodelaythe connection to the syslog facility is done right away instead of waiting for the first message to be issued -
-facilityfacility is an optional string dictated by syslog, and categorizes the entity that logs the message, in the following categories/facilities:
Facility Description
auth security/authorization messages
authpriv security/authorization messages (private)
cron clock daemon (cron and at)
daemon system daemons without separate facility value
ftp ftp daemon
kern kernel messages
local[0-7] local0 to local7 are reserved for local use
lpr line printer subsystem
mail mail subsystem
news USENET news subsystem
syslog messages generated internally by syslogd(8)
user generic user-level messages
uucp UUCP subsystem
The default facility is "user".
Command ::syslog::log is the command for logging. The following options can be specified.
- `-level' level describes the severity of the message. In order to control the message level possible arguments are:
Priority Description
emergency system is unusable
alert action must be taken immediately
critical critical conditions
error error conditions
warning warning conditions
notice normal, but significant, condition
info informational message
debug debug-level message
the default level is info
-
-prioritythe priority argument is equivalent to-level -
-formatprovides a limited support for the syslog formatting argument. For this argument to be meaningful it must be a string where somewhere the '%s' string qualifier must appear. A full support will be provided in future releases. -
-facilityis the same argument accepted by command
The ::syslog::open and ::syslog::log options become persistent across subsequent calls. Whereas ::syslog::log options status is interpreter/thread private ::syslog::open calls change the per-process global status of a connection that needs to be reset on every call. A sensible approach using the syslog package is therefore to call once ::syslog::open for every process and then call ::syslog::log with
package require syslog
::syslog::open -ident myapp -facility local0 -pid
::syslog::log -level info "An info message..."
#equivalently
::syslog::log info "An info message...."
::syslog::log -facility user info "Info message 2...."
#subsequent calls to log message preserve the state
#of the last call and options can be omitted
::syslog::log "Info message 3...."
# COMPATIBILITY
The global space command *syslog* is provided for compatibility but it's
deprecated because it potentially generates much overhead calling *openlog*
every time. This command accepts the whole set of the *::syslog::log* and
::syslog::open*
```tcl
package require syslog
syslog critical "Message 1"
syslog -ident tclsh warning "Message 2"
syslog -facility local0 notice "Message 3"
syslog -ident tclsh -facility user error "Message 4"
syslog -pid critical "Message 5.0"
syslog -pid -ident tclsh critical "Message 5.1"
syslog -pid -facility local0 debug "Message 5.1"
syslog -pid -facility local1 -ident tclsh info "Message 5.2"
syslog -pid -ident tclsh -facility local2 warning "Message 5.3"Outputs in /var/log/syslog (syslog timestamps and line prefix removed):
tclsh: Message 1
tclsh: Message 2
tclsh: Message 3
testident: Message 4
tclsh[7049]: Message 5.0
my_ident[7049]: Message 5.1
tclsh[7049]: Message 5.1
my_ident[7049]: Message 5.2
my_ident[7049]: Message 5.3
- Michael Kerrisk, The Linux Programming Interface, No Starch Press, 2010, ISBN 978-1-59327-220-3.
- Alexandros Stergiakis [email protected]
- Massimo Manghi [email protected]
Copyright (C) 2008 Alexandros Stergiakis
Copyright (C) 2024-2026 Massimo Manghi
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.