Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-syslog Reference Manual, version 0.2.4, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:25:08 2018 GMT+0.
| • Introduction: | What cl-syslog is all about | |
| • Systems: | The systems documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
Common Lisp interface to local and remote Syslog facilities.
For UDP Syslog See udp-syslog.lisp documentation strings. For local syslog see cl-syslog.lisp and variable.lisp. Priorities and facilities documented in variable.lisp.
Local Syslog Example: * (require :cl-syslog)
* (syslog:log "myprog" :local7 :info "this is the message")
"this is the message"
* (syslog:log "myprog" :local7 :info "this is the message"
syslog:+log-pid+)
"this is the message"
* (syslog:log "myprog" :local7 :info "this is the message"
(+ syslog:+log-pid+ syslog:+log-cons+))
"this is the message"
Then look in your /var/log/messages or other location if you have tweaked your /etc/syslog.conf.
Remote Syslog Example: (require :cl-syslog) ;; Create global logger (syslog.udp:udp-logger "127.0.0.1" 514)
;; Log a message
;; (Note: the log function is signature compatible with cl-syslog:log)
(syslog.udp:log "MyApp" :local7 :info "this is the message")
;; Log using a transient logger along with ulog function
(syslog-udp:ulog "this is the message" :logger
(syslog-udp:udp-logger "192.168.0.5" 514 :transient t))
;; Log with prirority
(syslog.udp:ulog "this is an error" :pri :err)
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The cl-syslog system: | ||
| • The cl-syslog.udp system: | ||
| • The cl-syslog.local system: |
Next: The cl-syslog<dot>udp system, Previous: Systems, Up: Systems [Contents][Index]
Erik Enge, Mike Maul
MIT (See LICENSE)
Common Lisp syslog interface.
0.2.4
cl-syslog.asd (file)
Next: The cl-syslog<dot>local system, Previous: The cl-syslog system, Up: Systems [Contents][Index]
MIT (See LICENSE)
Local-only syslog logging.
0.2.4
cl-syslog.asd (file)
Previous: The cl-syslog<dot>udp system, Up: Systems [Contents][Index]
MIT (See LICENSE)
Local-only syslog logging.
0.2.4
cffi
cl-syslog.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
Next: The cl-syslog<dot>udp/package-udp<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-syslog.asd
Next: The cl-syslog<dot>udp/udp-syslog<dot>lisp file, Previous: The cl-syslog<dot>asd file, Up: Lisp files [Contents][Index]
cl-syslog.udp (system)
package-udp.lisp
Next: The cl-syslog<dot>local/package<dot>lisp file, Previous: The cl-syslog<dot>udp/package-udp<dot>lisp file, Up: Lisp files [Contents][Index]
package-udp.lisp (file)
cl-syslog.udp (system)
udp-syslog.lisp
Next: The cl-syslog<dot>local/variable<dot>lisp file, Previous: The cl-syslog<dot>udp/udp-syslog<dot>lisp file, Up: Lisp files [Contents][Index]
cl-syslog.local (system)
package.lisp
Next: The cl-syslog<dot>local/cl-syslog<dot>lisp file, Previous: The cl-syslog<dot>local/package<dot>lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
cl-syslog.local (system)
variable.lisp
Previous: The cl-syslog<dot>local/variable<dot>lisp file, Up: Lisp files [Contents][Index]
variable.lisp (file)
cl-syslog.local (system)
cl-syslog.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The cl-syslog.udp package: | ||
| • The cl-syslog package: |
Next: The cl-syslog package, Previous: Packages, Up: Packages [Contents][Index]
UDP Syslog interface
package-udp.lisp (file)
syslog.udp
Previous: The cl-syslog<dot>udp package, Up: Packages [Contents][Index]
Common Lisp interface to syslog.
package.lisp (file)
syslog
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: | ||
| • Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported constants: | ||
| • Exported macros: | ||
| • Exported functions: | ||
| • Exported conditions: |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Log on the console if errors in sending.
variable.lisp (file)
Don’t delay open.
variable.lisp (file)
Don’t wait for console forks: deprecated.
variable.lisp (file)
Delay open until first syslog() (default).
variable.lisp (file)
Log to stderr as well.
variable.lisp (file)
Log the pid with each message.
variable.lisp (file)
Next: Exported functions, Previous: Exported constants, Up: Exported definitions [Contents][Index]
Macro wrapping ulog providing backwards signature compatibility with
cl-syslog:log function. The purpose of this is to allow the switching
of log destinations by switching bewteen the cl-syslog and cl-syslog.udp
namespaces.
See documentation for ulog details not covered here.
##Parameters##
name - Application name displayed in application name section if syslog message
facility - See ulog documentation for acceptable values
priority - See ulog documentation for acceptable values
text - Body of the message
option - Ignored, however parameter is necessary to maintain signature
compatibility with cl-syslog:log
:procid - See ulog documentation
:timestamp - See ulog documentation
:logger - See ulog documentation
##Return values##
value of text parameter, on error condition will be thrown.
udp-syslog.lisp (file)
Next: Exported conditions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
Syslog timestamp formatter defaults to current time.
Optional arg epoch as epoch seconds
Example format:2013-12-14T21:09:57.0Z-5
Timezone can be specified using local-time time zone variables
for example to specify GMT use local-time:+GMT-ZONE+
udp-syslog.lisp (file)
Return facility number given the facility’s name. If there is no such facility, signal ‘invalid-facility’ error.
cl-syslog.lisp (file)
Return priority number given the priority’s name. If there is no such priority, signal ‘invalid-priority’ error.
cl-syslog.lisp (file)
Print message to syslog.
’option’ can be any of the +log...+ constants
cl-syslog.lisp (file)
Constructs a UDP socket to host:port
:transient returns udp socket with out setting global socket
udp-syslog.lisp (file)
Closes udp socket
udp-syslog.lisp (file)
Streams a syslog formatted message (rfc5424) to a UDP destination.
Below is a sample of the equivalant string representation of a syslog
message streamed with this function:
<165>1 2003-08-24T05:14:15.000003-07:00 192.0.2.1 myproc 8710 - - %% It’s time to make the do-nuts.
##Parameters##
The paremeters map into the syslog message as shown below
:PRI VERSION SP :TIMESTAMP SP :HOSTNAME
SP :APP-NAME SP :PROCID SP :MSGID SP STRUCTURED-DATA [SP :MSG]
:logger
The destination is specified by either setting the global udp logger by
calling the udp-logger function or by specifying a logger with the
:logger parameter.
:pri
Must be one of the following priorities (default :info)
:emerg :alert :crit :err
:warning :notice :info :debug
:fac
Facility parameter must be one of (default :local7)
:kern :user :mail :daemon
:auth :syslog :lpr :news
:uucp :cron :authpriv :ftp
:local0 :local1 :local2 :local3
:local4 :local5 :local6 :local7
:app-name
Application name defaults to *package*
:hostname
Hostname defaults to (machine-instance)
udp-syslog.lisp (file)
Streams a syslog formatted message (rfc5424) to a UDP destination.
Below is a sample of the equivalant string representation of a syslog
message streamed with this function:
<165>1 2003-08-24T05:14:15.000003-07:00 192.0.2.1 myproc 8710 - - %% It’s time to make the do-nuts.
##Parameters##
The paremeters map into the syslog message as shown below
:PRI VERSION SP :TIMESTAMP SP :HOSTNAME
SP :APP-NAME SP :PROCID SP :MSGID SP STRUCTURED-DATA [SP :MSG]
:logger
The destination is specified by either setting the global udp logger by
calling the udp-logger function or by specifying a logger with the
:logger parameter.
:pri
Must be one of the following priorities (default :info)
:emerg :alert :crit :err
:warning :notice :info :debug
:fac
Facility parameter must be one of (default :local7)
:kern :user :mail :daemon
:auth :syslog :lpr :news
:uucp :cron :authpriv :ftp
:local0 :local1 :local2 :local3
:local4 :local5 :local6 :local7
:app-name
Application name defaults to *package*
:hostname
Hostname defaults to (machine-instance)
udp-syslog.lisp (file)
Streams contents of message string to UDP destination.
If a strict syslog formatted message is desired see (ulog ...),
otherwise this function would be okay to simple udp listener.
##Parameters##
:logger
The destination is specified by either setting the global udp logger by
calling the udp-logger function or by specifying a logger with the
:logger parameter.
udp-syslog.lisp (file)
Previous: Exported functions, Up: Exported definitions [Contents][Index]
cl-syslog.lisp (file)
error (condition)
facility (method)
:facility
facility (generic function)
cl-syslog.lisp (file)
error (condition)
priority (method)
:priority
priority (generic function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables: | ||
| • Internal functions: | ||
| • Internal generic functions: | ||
| • Internal conditions: |
Next: Internal functions, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
variable.lisp (file)
variable.lisp (file)
udp-syslog.lisp (file)
Next: Internal generic functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
cl-syslog.lisp (file)
udp-syslog.lisp (file)
cl-syslog.lisp (file)
cl-syslog.lisp (file)
Next: Internal conditions, Previous: Internal functions, Up: Internal definitions [Contents][Index]
cl-syslog.lisp (file)
udp-syslog.lisp (file)
cl-syslog.lisp (file)
Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
udp-syslog.lisp (file)
error (condition)
msg (method)
:msg
msg (generic function)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index: | ||
| • Function index: | ||
| • Variable index: | ||
| • Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | C F L |
|---|
| Jump to: | C F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | C E F G L M O P S U |
|---|
| Jump to: | C E F G L M O P S U |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
+
C F M P S |
|---|
| Jump to: | *
+
C F M P S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C I P S U |
|---|
| Jump to: | C I P S U |
|---|