Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-syslog Reference Manual, version 0.2.4, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Feb 19 20:06:34 2020 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.
The source files are relatively well documented, so we recommend looking at them, but here's a quickstart guide.
To load cl-syslog, use Quicklisp or ASDF as usual:
> (ql:quickload :cl-syslog)
;; or, if ASDF can already see it:
> (asdf:load-system :cl-syslog)
Priorities and facilities are stated by their keyword name. For
instance, the priority :warning on facility :user. All of these
keywords are housed in the variables *priorities* and
*variables*. Should you provide invalid facilities or priorities,
the conditions cl-syslog:invalid-facility and
cl-syslog:invalid-priority will be signaled.
To log to your local syslog daemon, use cl-syslog:log (note that
this is shadowed, and is obviously not the same as cl:log!):
> (cl-syslog:log "MyApp" ':user ':warning "Low on memory.")
Then look in your /var/log/messages or other location if you have
tweaked your /etc/syslog.conf. On macOS, you can use the Console
application.
RFC 5424 is supported. (You can check if your CL-SYSLOG installation
support it by checking if cl-syslog::rfc5424 is present in your
*features*.)
The first thing you'll need to do is create an instance of the
rfc5424-logger class, filling out as many details as you
please. You're encouraged to fill out as many slots as you can so that
log messages contain more information.
Of particular interest is the :log-writer initarg. This controls how
log messages get processed in the end. The default log writer will use
a function wrapping cl-syslog:log. Should you instead be interested
in writing to standard output, you can supply
(cl-syslog:stream-log-writer) as an argument, like so:
(defparameter *logger*
(make-instance 'cl-syslog:rfc5424-logger
;; optional
:facility ':local0
:app-name "MyApp"
:hostname "computer.local"
:log-writer (cl-syslog:stream-log-writer)))
There are a few options for log writers, including a UDP log writer
for remote RFC-compliant logging. You can always support your own
lambda function, too.
Once you have a logger, the simplest way to create a compliant message
is to use cl-syslog:format-log:
> (cl-syslog:format-log *logger* ':warning "Low on memory.")
<132>1 2018-12-13T22:17:56Z computer.local MyApp 69840 - - Low on memory.
RFC 5424 has support for sending structured data within the log
message. It's a somewhat complicated arrangement, in that the
structured data has to be defined and "agreed upon". Specifically,
there are a set of IETF-approved structured data. They're identified
by "structured data IDs", and the standard IDs are timeQuality,
origin, and meta. Each of these have different structured data
parameters.
Personal structured data IDs must have some name, followed by @,
followed by a usually 4 or 5 digit integer. For instance,
mycompany@0001 is a valid personal structured data ID. One can
define a structured data ID using
cl-syslog:define-structured-data-id. The definition of the standard
origin ID is:
(define-structured-data-id |origin| (:standard t)
(|ip| :allow-repetitions t
:validator 'ip-address-p)
|enterpriseId|
(|software| :length (integer 0 40))
(|swVersion| :length (integer 0 32)))
(This can be seen in the file rfc5424-reserved.lisp.)
Your own structured data ID might be:
(cl-syslog:define-structured-data-id |mycompany@0001| ()
|who|
|what|)
Note that the field names are escaped to follow the RFC's usual idiom. Also node that the field names are here symbols scoped to your package. CL-SYSLOG exports all of the symbols of the standard ID's.
How can we use these? We use the log macro rfc-log. It's a macro
because it does extra work at compile time to build code that only
runs if the log message is to be sent.
Suppose we've defined the above structured data ID. Then we might log the following:
> (cl-syslog:rfc-log (*logger* :warning "Running out of memory! I got ~D byte~:P left!" 10)
(cl-syslog:|origin|
cl-syslog:|ip| "1.2.3.4"
cl-syslog:|software| "My Testing App"
cl-syslog:|swVersion| "12.2")
(|mycompany@0001|
|who| "John Doe"
|what| "Needs to buy a new computer."))
;; output:
<132>1 2018-12-13T22:28:02Z computer.local MyApp 69840 - [origin ip="1.2.3.4" software="My Testing App" swVersion="12.2"][mycompany@0001 who="John Doe" what="Needs to buy a new computer."] Running out of memory! I got 10 bytes left!
Optionally, a message ID string can be supplied. This is useful if the
message is a part of a category of similar messages. Suppose the
message ID is "LOG1234", then we could write the above message as:
> (cl-syslog:rfc-log (*logger* :warning "Running out of memory! I got ~D byte~:P left!" 10)
(:msgid "LOG1234")
(cl-syslog:|origin|
cl-syslog:|ip| "1.2.3.4"
cl-syslog:|software| "My Testing App"
cl-syslog:|swVersion| "12.2")
(|mycompany@0001|
|who| "John Doe"
|what| "Needs to buy a new computer."))
;; output:
<132>1 2018-12-13T22:29:36Z computer.local MyApp 69840 LOG1234 [origin ip="1.2.3.4" software="My Testing App" swVersion="12.2"][mycompany@0001 who="John Doe" what="Needs to buy a new computer."] Running out of memory! I got 10 bytes left!
Currently, Unicode isn't properly handled. It is expected all data is
ASCII. It is also expect that your Lisp's char-code matches
ASCII. The necessary BOM will not be inserted for Unicode.
The RFC 5424 log handling functions generally write to streams, but the entry points cons up strings (if and only if the log message is actually sent). There is currently no support for allowing streaming log data at the log generation level.
Many log processors do not implement all of RFC 5424, but nonetheless
cope rather well with the format, and can understand the RFC's
key=value pairs.
The raw C interfaces are CFFI-accessible by their standard UNIX names:
openlog, closelog, and syslog. None of these are necessary
unless you are looking for complete control. Beware, if you mess these
calls up, you will break your Lisp process.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The cl-syslog system |
Erik Enge, Mike Maul, Robert Smith
MIT (See LICENSE)
Common Lisp syslog interface.
0.2.4
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/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
cl-syslog.asd
cl-syslog (system)
Next: The cl-syslog/variable․lisp file, Previous: The cl-syslog․asd file, Up: Lisp files [Contents][Index]
Next: The cl-syslog/cl-syslog․lisp file, Previous: The cl-syslog/package․lisp file, Up: Lisp files [Contents][Index]
cl-syslog (system)
variable.lisp
Next: The cl-syslog/rfc5424․lisp file, Previous: The cl-syslog/variable․lisp file, Up: Lisp files [Contents][Index]
cl-syslog (system)
cl-syslog.lisp
Next: The cl-syslog/rfc5424-reserved․lisp file, Previous: The cl-syslog/cl-syslog․lisp file, Up: Lisp files [Contents][Index]
cl-syslog (system)
rfc5424.lisp
Previous: The cl-syslog/rfc5424․lisp file, Up: Lisp files [Contents][Index]
cl-syslog (system)
rfc5424-reserved.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The cl-syslog package |
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 generic functions | ||
| • Exported conditions | ||
| • Exported classes |
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]
Define a new structured data ID named ID-NAME.
ALLOW-OTHER-PARAMS is an option to allow other named parameters to be present.
STANDARD is an option to dictate that the defined message is an IETF-reserved name.
BODY specifies the fields and has the following syntax:
<body> ::= <field>*
<field> ::= <symbol>
| (<symbol> [:allow-repetitions <boolean>]
[:length <length-type>]
[:validator <form>])
<length-type> ::= an unevaluated form that is a subtype of UNSIGNED-BYTE
<form> ::= an evaluated form producing a funcallable unary function mapping to booleans
The :ALLOW-REPETITIONS keyword allows a field to be repeated (default: nil).
The :LENGTH keyword specifies what the length of the string data must satisfy. By default it’s unbounded by UNSIGNED-BYTE.
The :VALIDATOR keyword allows a validating function to be provided. By default it is (CONSTANTLY T).
rfc5424.lisp (file)
Log the message formed by CONTROL and ARGS to the logger LOGGER with priority PRIORITY. Structured data should be a list of structured data clauses of the form, where each clause has the form:
(:MSGID <string>)
or
(<ID> <PARAM 1> <VALUE 1>
<PARAM 2> <VALUE 2>
...)
The data <ID> and <PARAM n> are symbols, while <VALUE n> are strings. Both <ID> and <PARAM n> are *not* evaluated, while <VALUE n> are evaluated.
If :MSGID is provided, then this will be the RFC5424 msgid of the log message.
The logging will only happen of LOGGER does not exceed a specified maximum priority value.
rfc5424.lisp (file)
cl-syslog.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
cl-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)
Create a new log writer (for an RFC5424-LOGGER instance) joining the effects of each of the supplied log writers WRITERS.
rfc5424.lisp (file)
Print message to syslog.
’option’ can be any of the +log...+ constants
cl-syslog.lisp (file)
Create a log writer (for an RFC5424-LOGGER instance) that does nothing.
rfc5424.lisp (file)
cl-syslog.lisp (file)
Create a log function (for an RFC5424-LOGGER instance) that writes to STREAM. By default this is *STANDARD-OUTPUT*.
rfc5424.lisp (file)
Create a log writer (for an RFC5424-LOGGER instance) that writes to the system’s syslog.
rfc5424.lisp (file)
Create a log writer (for an RFC5424-LOGGER instance) that writes to STREAM, but is also processed by LOG-WRITER.
rfc5424.lisp (file)
Create a log writer (for an RFC5424-LOGGER instance) that writes to the UDP endpoint HOST on poort PORT.
rfc5424.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Return values YEAR, MONTH, DAY, HOUR, MINUTE, SECOND, FRACTION-OF-A-SECOND.
rfc5424.lisp (file)
Log the simple message STRING according to the priority PRIORITY. Note that this function behaves like CL:FORMAT, so ~’s in the CONTROL string will be interpreted as such.
This should be used in the simplest of logging situations. For more complicated log messages that contain structured data, see the RFC-LOG macro.
rfc5424.lisp (file)
Next: Exported classes, Previous: Exported generic 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)
rfc5424.lisp (file)
error (condition)
violated-assertion (method)
:violated-assertion
violated-assertion (generic function)
Previous: Exported conditions, Up: Exported definitions [Contents][Index]
Class holding the state to construct and transmit an RFC 5424-compliant log message.
rfc5424.lisp (file)
standard-object (class)
The syslog facility, as a keyword.
:facility
logger-facility (generic function)
The maximum priority above which log messages are not emitted to the external logging facility. The default maximum priority is :INFO. (Recall that priorities of *increasing* severity have *decreasing* priority values.)
:maximum-priority
logger-maximum-priority (generic function)
:hostname
logger-hostname (generic function)
:app-name
logger-app-name (generic function)
:process-id
logger-process-id (generic function)
A binary function that takes a priority keyword and a string and returns an unspecified value. This is the function that received log messages and does whatever is desired. A NIL initarg (the default) means strings will be logged to syslog with the associated facility (as if by SYSLOG-LOG-WRITER).
Example: A value of (CONSTANTLY NIL) is appropriate if no action is desired.
Example: A value akin to (lambda (p s) (write-line s)) is appropriate if all log messages should go to *STANDARD-OUTPUT*. Note that this can be done with (STREAM-LOG-WRITER).
Note: This isn’t a "writer" in the usual CLOS sense.
See also: The functions NULL-LOG-WRITER, SYSLOG-LOG-WRITER, STREAM-LOG-WRITER, TEE-TO-STREAM, UDP-LOG-WRITER.
:log-writer
logger-log-writer (generic function)
| Initarg | Value |
|---|---|
| :facility | (quote :user) |
| :maximum-priority | (quote :info) |
| :hostname | (machine-instance) |
| :app-name | nil |
| :process-id | (prin1-to-string (sb-posix:getpid)) |
| :log-writer | nil |
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal constants | ||
| • Internal special variables | ||
| • Internal macros | ||
| • Internal functions | ||
| • Internal generic functions | ||
| • Internal structures | ||
| • Internal types |
Next: Internal special variables, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
The RFC 5424 "NILVALUE".
rfc5424.lisp (file)
Next: Internal macros, Previous: Internal constants, Up: Internal definitions [Contents][Index]
variable.lisp (file)
variable.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
rfc5424.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424-reserved.lisp (file)
rfc5424-reserved.lisp (file)
rfc5424-reserved.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
Is the string STRING a valid enterprise number?
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
Is X a valid structured data ID? Roughly, these are either:
1. A bare ASCII name, in which case it’s an IETF-reserved name.
2. An ASCII name, followed by ’@’, followed by a number (which may have dots).
Return two values:
1. A Boolean indicating whether it’s a valid ID.
2. A Boolean indicating whether its name conforms to an IETF-reserved name.
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
Write out the PARAM-NAME STRING to the stream STREAM.
rfc5424.lisp (file)
Write out the PARAM-VALUE STRING to the stream STREAM.
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
Write the RFC 5424-compliant syslog message to the stream STREAM.
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
rfc5424.lisp (file)
Next: Internal structures, Previous: Internal functions, Up: Internal definitions [Contents][Index]
cl-syslog.lisp (file)
automatically generated reader method
rfc5424.lisp (file)
The syslog facility, as a keyword.
rfc5424.lisp (file)
automatically generated reader method
rfc5424.lisp (file)
A binary function that takes a priority keyword and a string and returns an unspecified value. This is the function that received log messages and does whatever is desired. A NIL initarg (the default) means strings will be logged to syslog with the associated facility (as if by SYSLOG-LOG-WRITER).
Example: A value of (CONSTANTLY NIL) is appropriate if no action is desired.
Example: A value akin to (lambda (p s) (write-line s)) is appropriate if all log messages should go to *STANDARD-OUTPUT*. Note that this can be done with (STREAM-LOG-WRITER).
Note: This isn’t a "writer" in the usual CLOS sense.
See also: The functions NULL-LOG-WRITER, SYSLOG-LOG-WRITER, STREAM-LOG-WRITER, TEE-TO-STREAM, UDP-LOG-WRITER.
rfc5424.lisp (file)
The maximum priority above which log messages are not emitted to the external logging facility. The default maximum priority is :INFO. (Recall that priorities of *increasing* severity have *decreasing* priority values.)
rfc5424.lisp (file)
automatically generated reader method
rfc5424.lisp (file)
cl-syslog.lisp (file)
rfc5424.lisp (file)
Next: Internal types, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
A description of structured data.
rfc5424.lisp (file)
structure-object (structure)
alexandria.1.0.0:string-designator
structured-data-description-id (function)
(setf structured-data-description-id) (function)
boolean
t
(setf structured-data-description-allow-other-params) (function)
alexandria.1.0.0:proper-list
structured-data-description-fields (function)
(setf structured-data-description-fields) (function)
A description of a field of structured data.
rfc5424.lisp (file)
structure-object (structure)
alexandria.1.0.0:string-designator
structured-data-field-description-name (function)
(setf structured-data-field-description-name) (function)
boolean
structured-data-field-description-repetitions-allowed-p (function)
(setf structured-data-field-description-repetitions-allowed-p) (function)
(quote unsigned-byte)
(setf structured-data-field-description-length-type) (function)
(or symbol function)
(constantly t)
structured-data-field-description-validator (function)
(setf structured-data-field-description-validator) (function)
Previous: Internal structures, Up: Internal definitions [Contents][Index]
rfc5424.lisp (file)
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: | (
A C D F G I J L M N O P R S T U V W |
|---|
| Jump to: | (
A C D F G I J L M N O P R S T U V W |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
+
A C F H I L M N P R S V |
|---|
| Jump to: | *
+
A C F H I L M N P R S V |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C I M P R S T |
|---|
| Jump to: | C I M P R S T |
|---|