Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
The cl-syslog Reference Manual
This is the cl-syslog Reference Manual, version 0.2.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 05:11:01 2022 GMT+0.
Table of Contents
Next: Systems, Previous: The cl-syslog Reference Manual, Up: The cl-syslog Reference Manual [Contents][Index]
1 Introduction
CL-SYSLOG 
Common Lisp interface to local and remote Syslog facilities.
Features
- Local sysloging implemented via foreign-function calls.
- Remote syslog over UDP sockets.
- Optional, complete RFC5424 support.
Documentation
The source files are relatively well documented, so we recommend looking at them, but here's a quickstart guide.
Notice
- cl-syslog.udp has been removed due to duplicate functionality in cl-syslog: udp-log-writer
- All functionality has been moved into system cl-syslog package cl-syslog (Sorry if this causes breakage)
Basic Usage
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 Support
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!
RFC 5424 Caveats
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.
Raw C Functions
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: The cl-syslog Reference Manual [Contents][Index]
2 Systems
The main system appears first, followed by any subsystem dependency.
2.1 cl-syslog
Common Lisp syslog interface.
- Author
Erik Enge, Mike Maul, Robert Smith
- License
MIT (See LICENSE)
- Version
0.2.4
- Dependencies
- alexandria (system).
- cffi (system).
- global-vars (system).
- usocket (system).
- split-sequence (system).
- babel (system).
- local-time (system).
- sb-posix (system).
- Source
- Child Components
- package.lisp (file).
- variable.lisp (file).
- cl-syslog.lisp (file).
- rfc5424.lisp (file).
- rfc5424-reserved.lisp (file).
Next: Packages, Previous: Systems, Up: The cl-syslog Reference Manual [Contents][Index]
3 Files
Files are sorted by type and then listed depth-first from the systems components trees.
3.1 Lisp
- cl-syslog/cl-syslog.asd
- cl-syslog/package.lisp
- cl-syslog/variable.lisp
- cl-syslog/cl-syslog.lisp
- cl-syslog/rfc5424.lisp
- cl-syslog/rfc5424-reserved.lisp
Next: cl-syslog/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
3.1.1 cl-syslog/cl-syslog.asd
- Source
- Parent Component
cl-syslog (system).
- ASDF Systems
Next: cl-syslog/variable.lisp, Previous: cl-syslog/cl-syslog.asd, Up: Lisp [Contents][Index]
3.1.2 cl-syslog/package.lisp
- Source
- Parent Component
cl-syslog (system).
- Packages
Next: cl-syslog/cl-syslog.lisp, Previous: cl-syslog/package.lisp, Up: Lisp [Contents][Index]
3.1.3 cl-syslog/variable.lisp
- Source
- Parent Component
cl-syslog (system).
- Public Interface
- +log-cons+ (constant).
- +log-ndelay+ (constant).
- +log-nowait+ (constant).
- +log-odelay+ (constant).
- +log-perror+ (constant).
- +log-pid+ (constant).
- Internals
- *facilities* (special variable).
- *priorities* (special variable).
Next: cl-syslog/rfc5424.lisp, Previous: cl-syslog/variable.lisp, Up: Lisp [Contents][Index]
3.1.4 cl-syslog/cl-syslog.lisp
- Source
- Parent Component
cl-syslog (system).
- Public Interface
- closelog (function).
- get-facility (function).
- get-priority (function).
- invalid-facility (condition).
- invalid-priority (condition).
- log (function).
- openlog (function).
- syslog (macro).
- Internals
Next: cl-syslog/rfc5424-reserved.lisp, Previous: cl-syslog/cl-syslog.lisp, Up: Lisp [Contents][Index]
3.1.5 cl-syslog/rfc5424.lisp
- Source
- Parent Component
cl-syslog (system).
- Public Interface
- current-time (generic function).
- define-structured-data-id (macro).
- format-log (generic function).
- join-log-writers (function).
- malformed-rfc5424-input (condition).
- null-log-writer (function).
- rfc-log (macro).
- rfc5424-logger (class).
- shared-initialize (method).
- stream-log-writer (function).
- syslog-log-writer (function).
- tee-to-stream (function).
- udp-log-writer (function).
- Internals
- ascii-char-p (function).
- ascii-control-char-p (function).
- ascii-graphic-char-p (function).
- ascii-graphic-string-p (function).
- ascii-whitespace-char-p (function).
- assert-rfc5424 (macro).
- copy-structured-data-description (function).
- copy-structured-data-field-description (function).
- find-sd-id (function).
- (setf find-sd-id) (function).
- logger-app-name (reader method).
- logger-facility (reader method).
- logger-hostname (reader method).
- logger-log-writer (reader method).
- logger-maximum-priority (reader method).
- logger-process-id (reader method).
- make-param (function).
- make-sd-element (function).
- make-structured-data-description (function).
- make-structured-data-field-description (function).
- nilvalue (constant).
- param-name (function).
- param-value (function).
- rfc5424-pri (type).
- sd-element-id (function).
- sd-element-params (function).
- structured-data-description (structure).
- structured-data-description-allow-other-params (reader).
- structured-data-description-fields (reader).
- structured-data-description-id (reader).
- structured-data-description-p (function).
- structured-data-field-description (structure).
- structured-data-field-description-length-type (reader).
- structured-data-field-description-name (reader).
- structured-data-field-description-p (function).
- structured-data-field-description-repetitions-allowed-p (reader).
- structured-data-field-description-validator (reader).
- valid-app-name-p (function).
- valid-day-p (function).
- valid-enterprise-number-p (function).
- valid-fraction-of-a-second-p (function).
- valid-hostname-p (function).
- valid-hour-p (function).
- valid-minute-p (function).
- valid-month-p (function).
- valid-msgid-p (function).
- valid-param-p (function).
- valid-pri-p (function).
- valid-procid-p (function).
- valid-sd-element-p (function).
- valid-sd-id-p (function).
- valid-sd-name-p (function).
- valid-second-p (function).
- valid-year-p (function).
- violated-assertion (reader method).
- write-app-name (function).
- write-date (function).
- write-hostname (function).
- write-msg (function).
- write-msgid (function).
- write-param-name (function).
- write-param-value (function).
- write-pri (function).
- write-procid (function).
- write-rfc5424-syslog-message (function).
- write-rfc5424-syslog-message-unsafe (function).
- write-sd-element (function).
- write-sd-elements (function).
- write-time (function).
- write-two-digit-number (function).
- write-utc-timestamp (function).
- write-version (function).
Previous: cl-syslog/rfc5424.lisp, Up: Lisp [Contents][Index]
3.1.6 cl-syslog/rfc5424-reserved.lisp
- Source
- Parent Component
cl-syslog (system).
- Internals
- ip-address-p (function).
- ip4-address-p (function).
- ip6-address-p (function).
Next: Definitions, Previous: Files, Up: The cl-syslog Reference Manual [Contents][Index]
4 Packages
Packages are listed by definition order.
4.1 cl-syslog
Common Lisp interface to syslog.
- Source
- Nickname
syslog
- Use List
common-lisp.
- Public Interface
- +log-cons+ (constant).
- +log-ndelay+ (constant).
- +log-nowait+ (constant).
- +log-odelay+ (constant).
- +log-perror+ (constant).
- +log-pid+ (constant).
- closelog (function).
- current-time (generic function).
- define-structured-data-id (macro).
- format-log (generic function).
- get-facility (function).
- get-priority (function).
- invalid-facility (condition).
- invalid-priority (condition).
- join-log-writers (function).
- log (function).
- malformed-rfc5424-input (condition).
- null-log-writer (function).
- openlog (function).
- rfc-log (macro).
- rfc5424-logger (class).
- stream-log-writer (function).
- syslog (macro).
- syslog-log-writer (function).
- tee-to-stream (function).
- udp-log-writer (function).
- Internals
- *facilities* (special variable).
- *priorities* (special variable).
- ascii-char-p (function).
- ascii-control-char-p (function).
- ascii-graphic-char-p (function).
- ascii-graphic-string-p (function).
- ascii-whitespace-char-p (function).
- assert-rfc5424 (macro).
- copy-structured-data-description (function).
- copy-structured-data-field-description (function).
- facility (generic reader).
- find-sd-id (function).
- (setf find-sd-id) (function).
- ip-address-p (function).
- ip4-address-p (function).
- ip6-address-p (function).
- logger-app-name (generic reader).
- logger-facility (generic reader).
- logger-hostname (generic reader).
- logger-log-writer (generic reader).
- logger-maximum-priority (generic reader).
- logger-process-id (generic reader).
- make-param (function).
- make-sd-element (function).
- make-structured-data-description (function).
- make-structured-data-field-description (function).
- nilvalue (constant).
- param-name (function).
- param-value (function).
- priority (generic reader).
- rfc5424-pri (type).
- sd-element-id (function).
- sd-element-params (function).
- structured-data-description (structure).
- structured-data-description-allow-other-params (reader).
- structured-data-description-fields (reader).
- structured-data-description-id (reader).
- structured-data-description-p (function).
- structured-data-field-description (structure).
- structured-data-field-description-length-type (reader).
- structured-data-field-description-name (reader).
- structured-data-field-description-p (function).
- structured-data-field-description-repetitions-allowed-p (reader).
- structured-data-field-description-validator (reader).
- valid-app-name-p (function).
- valid-day-p (function).
- valid-enterprise-number-p (function).
- valid-fraction-of-a-second-p (function).
- valid-hostname-p (function).
- valid-hour-p (function).
- valid-minute-p (function).
- valid-month-p (function).
- valid-msgid-p (function).
- valid-param-p (function).
- valid-pri-p (function).
- valid-procid-p (function).
- valid-sd-element-p (function).
- valid-sd-id-p (function).
- valid-sd-name-p (function).
- valid-second-p (function).
- valid-year-p (function).
- violated-assertion (generic reader).
- write-app-name (function).
- write-date (function).
- write-hostname (function).
- write-msg (function).
- write-msgid (function).
- write-param-name (function).
- write-param-value (function).
- write-pri (function).
- write-procid (function).
- write-rfc5424-syslog-message (function).
- write-rfc5424-syslog-message-unsafe (function).
- write-sd-element (function).
- write-sd-elements (function).
- write-time (function).
- write-two-digit-number (function).
- write-utc-timestamp (function).
- write-version (function).
Next: Indexes, Previous: Packages, Up: The cl-syslog Reference Manual [Contents][Index]
5 Definitions
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
5.1 Public Interface
Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]
5.1.1 Constants
- Constant: +log-cons+ ¶
-
Log on the console if errors in sending.
- Package
- Source
- Constant: +log-ndelay+ ¶
-
Don’t delay open.
- Package
- Source
- Constant: +log-nowait+ ¶
-
Don’t wait for console forks: deprecated.
- Package
- Source
- Constant: +log-odelay+ ¶
-
Delay open until first syslog() (default).
- Package
- Source
- Constant: +log-perror+ ¶
-
Log to stderr as well.
- Package
- Source
- Constant: +log-pid+ ¶
-
Log the pid with each message.
- Package
- Source
Next: Ordinary functions, Previous: Constants, Up: Public Interface [Contents][Index]
5.1.2 Macros
- Macro: define-structured-data-id (id-name (&key allow-other-params standard) &body body) ¶
-
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).
- Package
- Source
- Macro: rfc-log ((logger priority control &rest args) &body structured-data) ¶
-
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.
- Package
- Source
- Macro: syslog (priority format &rest varargs0) ¶
-
- Package
- Source
Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]
5.1.3 Ordinary functions
- Function: closelog () ¶
-
- Package
- Source
- Function: get-facility (facility-name) ¶
-
Return facility number given the facility’s name. If there is no such facility, signal ‘invalid-facility’ error.
- Package
- Source
- Function: get-priority (priority-name) ¶
-
Return priority number given the priority’s name. If there is no such priority, signal ‘invalid-priority’ error.
- Package
- Source
- Function: join-log-writers (&rest writers) ¶
-
Create a new log writer (for an RFC5424-LOGGER instance) joining the effects of each of the supplied log writers WRITERS.
- Package
- Source
- Function: log (name facility priority text &optional option) ¶
-
Print message to syslog.
’option’ can be any of the +log...+ constants- Package
- Source
- Function: null-log-writer () ¶
-
Create a log writer (for an RFC5424-LOGGER instance) that does nothing.
- Package
- Source
- Function: openlog (ident option facility) ¶
-
- Package
- Source
- Function: stream-log-writer (&optional stream) ¶
-
Create a log function (for an RFC5424-LOGGER instance) that writes to STREAM. By default this is *STANDARD-OUTPUT*.
- Package
- Source
- Function: syslog-log-writer (app-name facility) ¶
-
Create a log writer (for an RFC5424-LOGGER instance) that writes to the system’s syslog.
- Package
- Source
- Function: tee-to-stream (log-writer &optional stream) ¶
-
Create a log writer (for an RFC5424-LOGGER instance) that writes to STREAM, but is also processed by LOG-WRITER.
- Package
- Source
- Function: udp-log-writer (host port) ¶
-
Create a log writer (for an RFC5424-LOGGER instance) that writes to the UDP endpoint HOST on poort PORT.
- Package
- Source
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
5.1.4 Generic functions
- Generic Function: current-time (logger) ¶
-
Return values YEAR, MONTH, DAY, HOUR, MINUTE, SECOND, FRACTION-OF-A-SECOND.
- Package
- Source
- Methods
- Method: current-time ((logger rfc5424-logger)) ¶
- Generic Function: format-log (logger priority control &rest args) ¶
-
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.
- Package
- Source
- Methods
- Method: format-log ((logger rfc5424-logger) priority control &rest args) ¶
Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]
5.1.5 Standalone methods
-
- Source
Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]
5.1.6 Conditions
- Condition: invalid-facility ¶
-
- Package
- Source
- Direct superclasses
error.
- Direct methods
- Direct slots
- Condition: invalid-priority ¶
-
- Package
- Source
- Direct superclasses
error.
- Direct methods
- Direct slots
- Condition: malformed-rfc5424-input ¶
-
- Package
- Source
- Direct superclasses
error.
- Direct methods
- Direct slots
- Slot: violated-assertion ¶
-
- Initargs
:violated-assertion
- Readers
- Writers
This slot is read-only.
Previous: Conditions, Up: Public Interface [Contents][Index]
5.1.7 Classes
- Class: rfc5424-logger ¶
-
Class holding the state to construct and transmit an RFC 5424-compliant log message.
- Package
- Source
- Direct methods
- Direct Default Initargs
Initarg Value :facility (quote user) :maximum-priority (quote info) :hostname (machine-instance) :app-name nil :process-id (prin1-to-string (getpid)) :log-writer nil - Direct slots
- Slot: facility ¶
-
The syslog facility, as a keyword.
- Initargs
:facility
- Readers
- Writers
This slot is read-only.
- Slot: maximum-priority ¶
-
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.)
- Initargs
:maximum-priority
- Readers
- Writers
This slot is read-only.
- Slot: hostname ¶
-
- Initargs
:hostname
- Readers
- Writers
This slot is read-only.
- Slot: app-name ¶
-
- Initargs
:app-name
- Readers
- Writers
This slot is read-only.
- Slot: process-id ¶
-
- Initargs
:process-id
- Readers
- Writers
This slot is read-only.
- Slot: log-writer ¶
-
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.
- Initargs
:log-writer
- Readers
- Writers
This slot is read-only.
Previous: Public Interface, Up: Definitions [Contents][Index]
5.2 Internals
Next: Special variables, Previous: Internals, Up: Internals [Contents][Index]
5.2.1 Constants
- Constant: nilvalue ¶
-
The RFC 5424 "NILVALUE".
- Package
- Source
5.2.2 Special variables
- Special Variable: *facilities* ¶
-
- Package
- Source
- Special Variable: *priorities* ¶
-
- Package
- Source
Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]
5.2.3 Macros
- Macro: assert-rfc5424 (thing) ¶
-
- Package
- Source
Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]
5.2.4 Ordinary functions
- Function: ascii-char-p (c) ¶
-
- Package
- Source
- Function: ascii-control-char-p (c) ¶
-
- Package
- Source
- Function: ascii-graphic-char-p (c) ¶
-
- Package
- Source
- Function: ascii-graphic-string-p (x) ¶
-
- Package
- Source
- Function: ascii-whitespace-char-p (c) ¶
-
- Package
- Source
- Function: copy-structured-data-description (instance) ¶
-
- Package
- Source
- Function: copy-structured-data-field-description (instance) ¶
-
- Package
- Source
- Function: find-sd-id (name) ¶
-
- Package
- Source
- Function: (setf find-sd-id) (name) ¶
-
- Package
- Source
- Function: ip-address-p (x) ¶
-
- Package
- Source
- Function: ip4-address-p (x) ¶
-
- Package
- Source
- Function: ip6-address-p (x) ¶
-
- Package
- Source
- Function: make-param (name value) ¶
-
- Package
- Source
- Function: make-sd-element (id &rest params) ¶
-
- Package
- Source
- Function: make-structured-data-description (&key id allow-other-params fields) ¶
-
- Package
- Source
- Function: make-structured-data-field-description (&key name repetitions-allowed-p length-type validator) ¶
-
- Package
- Source
- Function: param-name (param) ¶
-
- Package
- Source
- Function: param-value (param) ¶
-
- Package
- Source
- Function: sd-element-id (elt) ¶
-
- Package
- Source
- Function: sd-element-params (elt) ¶
-
- Package
- Source
- Reader: structured-data-description-allow-other-params (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: structured-data-description-fields (instance) ¶
-
- Package
- Source
- Target Slot
- Function: structured-data-description-p (object) ¶
-
- Package
- Source
- Reader: structured-data-field-description-length-type (instance) ¶
-
- Package
- Source
- Target Slot
- Function: structured-data-field-description-p (object) ¶
-
- Package
- Source
- Reader: structured-data-field-description-repetitions-allowed-p (instance) ¶
-
- Package
- Source
- Target Slot
- Reader: structured-data-field-description-validator (instance) ¶
-
- Package
- Source
- Target Slot
- Function: valid-app-name-p (thing) ¶
-
- Package
- Source
- Function: valid-day-p (x) ¶
-
- Package
- Source
- Function: valid-enterprise-number-p (string) ¶
-
Is the string STRING a valid enterprise number?
- Package
- Source
- Function: valid-fraction-of-a-second-p (x) ¶
-
- Package
- Source
- Function: valid-hostname-p (thing) ¶
-
- Package
- Source
- Function: valid-hour-p (x) ¶
-
- Package
- Source
- Function: valid-minute-p (x) ¶
-
- Package
- Source
- Function: valid-month-p (x) ¶
-
- Package
- Source
- Function: valid-msgid-p (thing) ¶
-
- Package
- Source
- Function: valid-param-p (p) ¶
-
- Package
- Source
- Function: valid-pri-p (thing) ¶
-
- Package
- Source
- Function: valid-procid-p (thing) ¶
-
- Package
- Source
- Function: valid-sd-element-p (e) ¶
-
- Package
- Source
- Function: valid-sd-id-p (x) ¶
-
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.
- Package
- Source
- Function: valid-sd-name-p (string) ¶
-
- Package
- Source
- Function: valid-second-p (x) ¶
-
- Package
- Source
- Function: valid-year-p (x) ¶
-
- Package
- Source
- Function: write-app-name (stream app-name) ¶
-
- Package
- Source
- Function: write-date (stream year month day) ¶
-
- Package
- Source
- Function: write-hostname (stream hostname) ¶
-
- Package
- Source
- Function: write-msg (stream string) ¶
-
- Package
- Source
- Function: write-msgid (stream msgid) ¶
-
- Package
- Source
- Function: write-param-name (stream string) ¶
-
Write out the PARAM-NAME STRING to the stream STREAM.
- Package
- Source
- Function: write-param-value (stream string) ¶
-
Write out the PARAM-VALUE STRING to the stream STREAM.
- Package
- Source
- Function: write-pri (stream pri) ¶
-
- Package
- Source
- Function: write-procid (stream procid) ¶
-
- Package
- Source
- Function: write-rfc5424-syslog-message (stream pri year month day hour minute second fraction-of-a-second hostname app-name procid msgid sd-elements msg) ¶
-
Write the RFC 5424-compliant syslog message to the stream STREAM.
- Package
- Source
- Function: write-rfc5424-syslog-message-unsafe (stream pri year month day hour minute second fractions-of-a-second hostname app-name procid msgid sd-elements msg) ¶
-
- Package
- Source
- Function: write-sd-element (stream elt) ¶
-
- Package
- Source
- Function: write-sd-elements (stream elts) ¶
-
- Package
- Source
- Function: write-time (stream hour minute second fraction-of-a-second) ¶
-
- Package
- Source
- Function: write-two-digit-number (stream number) ¶
-
- Package
- Source
- Function: write-utc-timestamp (stream year month day hour minute second fraction-of-a-second) ¶
-
- Package
- Source
- Function: write-version (stream) ¶
-
- Package
- Source
Next: Structures, Previous: Ordinary functions, Up: Internals [Contents][Index]
5.2.5 Generic functions
- Generic Reader: facility (condition) ¶
-
- Package
- Methods
- Reader Method: facility ((condition invalid-facility)) ¶
-
- Source
- Target Slot
- Generic Reader: logger-app-name (object) ¶
-
- Package
- Methods
- Reader Method: logger-app-name ((rfc5424-logger rfc5424-logger)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Reader: logger-facility (object) ¶
-
- Package
- Methods
- Reader Method: logger-facility ((rfc5424-logger rfc5424-logger)) ¶
-
The syslog facility, as a keyword.
- Source
- Target Slot
- Generic Reader: logger-hostname (object) ¶
-
- Package
- Methods
- Reader Method: logger-hostname ((rfc5424-logger rfc5424-logger)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Reader: logger-log-writer (object) ¶
-
- Package
- Methods
- Reader Method: logger-log-writer ((rfc5424-logger rfc5424-logger)) ¶
-
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.
- Source
- Target Slot
- Generic Reader: logger-maximum-priority (object) ¶
-
- Package
- Methods
- Reader Method: logger-maximum-priority ((rfc5424-logger rfc5424-logger)) ¶
-
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.)
- Source
- Target Slot
- Generic Reader: logger-process-id (object) ¶
-
- Package
- Methods
- Reader Method: logger-process-id ((rfc5424-logger rfc5424-logger)) ¶
-
automatically generated reader method
- Source
- Target Slot
- Generic Reader: priority (condition) ¶
-
- Package
- Methods
- Reader Method: priority ((condition invalid-priority)) ¶
-
- Source
- Target Slot
- Generic Reader: violated-assertion (condition) ¶
-
- Package
- Methods
- Reader Method: violated-assertion ((condition malformed-rfc5424-input)) ¶
-
- Source
- Target Slot
Next: Types, Previous: Generic functions, Up: Internals [Contents][Index]
5.2.6 Structures
- Structure: structured-data-description ¶
-
A description of structured data.
- Package
- Source
- Direct superclasses
structure-object.
- Direct slots
- Slot: id ¶
-
- Type
alexandria:string-designator
- Readers
- Writers
This slot is read-only.
- Slot: allow-other-params ¶
-
- Type
boolean
- Initform
t
- Readers
- Writers
This slot is read-only.
- Slot: fields ¶
-
- Type
alexandria:proper-list
- Readers
- Writers
This slot is read-only.
- Structure: structured-data-field-description ¶
-
A description of a field of structured data.
- Package
- Source
- Direct superclasses
structure-object.
- Direct slots
- Slot: name ¶
-
- Type
alexandria:string-designator
- Readers
- Writers
This slot is read-only.
- Slot: repetitions-allowed-p ¶
-
- Type
boolean
- Readers
- Writers
This slot is read-only.
- Slot: length-type ¶
-
- Initform
(quote unsigned-byte)
- Readers
- Writers
This slot is read-only.
- Slot: validator ¶
-
- Type
(or symbol function)
- Initform
(constantly t)
- Readers
- Writers
This slot is read-only.
Previous: Structures, Up: Internals [Contents][Index]
5.2.7 Types
- Type: rfc5424-pri () ¶
-
- Package
- Source
Previous: Definitions, Up: The cl-syslog Reference Manual [Contents][Index]
Appendix A Indexes
A.2 Functions
| 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 types, Previous: Functions, Up: Indexes [Contents][Index]
A.3 Variables
| 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 |
|---|
A.4 Data types
| Jump to: | C F I M P R S T V |
|---|
| Jump to: | C F I M P R S T V |
|---|