The cl-statsd Reference Manual

Child Component

src (module).

Next: Files, Previous: Systems, Up: The cl-statsd Reference Manual [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.

cl-statsd/src
cl-statsd/src/transports
cl-statsd/src/clients

Next: cl-statsd/src/transports, Previous: Modules, Up: Modules [Contents][Index]

3.1 `cl-statsd/src`

Source

Parent Component

cl-statsd (system).

Child Components

package.lisp (file).
clients/base.lisp (file).
statsd.lisp (file).
transports (module).
clients (module).

Next: cl-statsd/src/clients, Previous: cl-statsd/src, Up: Modules [Contents][Index]

3.2 `cl-statsd/src/transports`

Dependency

statsd.lisp (file).

Source

Parent Component

src (module).

Child Components

base.lisp (file).
usocket.lisp (file).

Previous: cl-statsd/src/transports, Up: Modules [Contents][Index]

3.3 `cl-statsd/src/clients`

Dependency

transports (module).

Source

Parent Component

src (module).

Child Components

capture.lisp (file).
null.lisp (file).
sync.lisp (file).
async.lisp (file).

Next: Packages, Previous: Modules, Up: The cl-statsd Reference Manual [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: cl-statsd/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-statsd/cl-statsd.asd`

Source: cl-statsd.asd.
Parent Component: cl-statsd (system).
ASDF Systems: cl-statsd.

Next: cl-statsd/src/clients/base.lisp, Previous: cl-statsd/cl-statsd.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-statsd/src/package.lisp`

Source: cl-statsd.asd.
Parent Component: src (module).
Packages: cl-statsd.

Next: cl-statsd/src/statsd.lisp, Previous: cl-statsd/src/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `cl-statsd/src/clients/base.lisp`

Dependency

package.lisp (file).

Source

Parent Component

src (module).

Public Interface

*random-range* (special variable).
handler-handle-error (generic function).
stop-client (function).

Internals

client-error-handler (reader method).
client-handler-error (function).
client-prefix (reader method).
client-transport (reader method).
maybe-send (macro).
send (generic function).
serialize-metric (generic function).
serialize-metric% (function).
statsd-client-base (class).
statsd-client-with-prefix (class).
statsd-client-with-transport (class).
stop-client% (generic function).
with-smart?-error-handling (macro).

Next: cl-statsd/src/transports/base.lisp, Previous: cl-statsd/src/clients/base.lisp, Up: Lisp [Contents][Index]

4.1.4 `cl-statsd/src/statsd.lisp`

Dependency

clients/base.lisp (file).

Source

Parent Component

src (module).

Public Interface

*client* (special variable).
counter (function).
dec (function).
gauge (function).
inc (function).
set (function).
timing (function).
with-timing (macro).

Internals

with-timing% (function).

Next: cl-statsd/src/transports/usocket.lisp, Previous: cl-statsd/src/statsd.lisp, Up: Lisp [Contents][Index]

4.1.5 `cl-statsd/src/transports/base.lisp`

Source

Parent Component

transports (module).

Public Interface

make-transport (generic function).
socket-transport (class).
transport-base (class).
transport-error (condition).
transport.close (generic function).
transport.connect (generic function).
transport.send (generic function).

Internals

transport-error-error (reader method).
transport-host (reader method).
transport-port (reader method).
transport-socket (reader method).
transport-tcp-p (reader method).

Next: cl-statsd/src/clients/capture.lisp, Previous: cl-statsd/src/transports/base.lisp, Up: Lisp [Contents][Index]

4.1.6 `cl-statsd/src/transports/usocket.lisp`

Dependency

base.lisp (file).

Source

Parent Component

transports (module).

Public Interface

make-transport (method).
transport.close (method).
transport.connect (method).
transport.send (method).

Internals

usocket-transport (class).

Next: cl-statsd/src/clients/null.lisp, Previous: cl-statsd/src/transports/usocket.lisp, Up: Lisp [Contents][Index]

4.1.7 `cl-statsd/src/clients/capture.lisp`

Source

Parent Component

clients (module).

Public Interface

capture-client.recv (function).
capture-client.reset (function).
make-capture-client (function).
transport.close (method).
transport.send (method).

Internals

capture-client (class).
capture-client-queue (reader method).
(setf capture-client-queue) (writer method).
client-transport (method).
send (method).

Next: cl-statsd/src/clients/sync.lisp, Previous: cl-statsd/src/clients/capture.lisp, Up: Lisp [Contents][Index]

4.1.8 `cl-statsd/src/clients/null.lisp`

Dependency

capture.lisp (file).

Source

Parent Component

clients (module).

Public Interface

make-null-client (function).

Internals

null-client (class).
send (method).

Next: cl-statsd/src/clients/async.lisp, Previous: cl-statsd/src/clients/null.lisp, Up: Lisp [Contents][Index]

4.1.9 `cl-statsd/src/clients/sync.lisp`

Dependency

null.lisp (file).

Source

Parent Component

clients (module).

Public Interface

make-sync-client (function).

Internals

send (method).
sync-client (class).

Previous: cl-statsd/src/clients/sync.lisp, Up: Lisp [Contents][Index]

4.1.10 `cl-statsd/src/clients/async.lisp`

Dependency

sync.lisp (file).

Source

Parent Component

clients (module).

Public Interface

*throttle-threshold* (special variable).
make-async-client (function).
start-async-client (function).
throttle-threshold-reached (condition).

Internals

+async-client-reconnects-default+ (constant).
async-client (class).
async-client-mailbox (reader method).
async-client-reconnects (reader method).
async-client-state (reader method).
async-client-thread (reader method).
async-client-thread-fun (function).
async-client-throttle-threshold (reader method).
send (method).
stop-client% (method).
throttle-threshold (reader method).

Next: Definitions, Previous: Files, Up: The cl-statsd Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-statsd

Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-statsd`

Source

package.lisp.

Nickname

statsd

Use List

alexandria.
common-lisp.

Public Interface

*client* (special variable).
*random-range* (special variable).
*throttle-threshold* (special variable).
capture-client.recv (function).
capture-client.reset (function).
counter (function).
dec (function).
gauge (function).
handler-handle-error (generic function).
inc (function).
make-async-client (function).
make-capture-client (function).
make-null-client (function).
make-sync-client (function).
make-transport (generic function).
set (function).
socket-transport (class).
start-async-client (function).
stop-client (function).
throttle-threshold-reached (condition).
timing (function).
transport-base (class).
transport-error (condition).
transport.close (generic function).
transport.connect (generic function).
transport.send (generic function).
with-timing (macro).

Internals

+async-client-reconnects-default+ (constant).
async-client (class).
async-client-mailbox (generic reader).
async-client-reconnects (generic reader).
async-client-state (generic reader).
async-client-thread (generic reader).
async-client-thread-fun (function).
async-client-throttle-threshold (generic reader).
capture-client (class).
capture-client-queue (generic reader).
(setf capture-client-queue) (generic writer).
client-error-handler (generic reader).
client-handler-error (function).
client-prefix (generic reader).
client-transport (generic function).
maybe-send (macro).
null-client (class).
send (generic function).
serialize-metric (generic function).
serialize-metric% (function).
statsd-client-base (class).
statsd-client-with-prefix (class).
statsd-client-with-transport (class).
stop-client% (generic function).
sync-client (class).
throttle-threshold (generic reader).
transport-error-error (generic reader).
transport-host (generic reader).
transport-port (generic reader).
transport-socket (generic reader).
transport-tcp-p (generic reader).
usocket-transport (class).
with-smart?-error-handling (macro).
with-timing% (function).

Next: Indexes, Previous: Packages, Up: The cl-statsd Reference Manual [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

6.1 Public Interface

Special variables
Macros
Ordinary functions
Generic functions
Conditions
Classes

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Special variables

Special Variable: *client* ¶

Package: cl-statsd.
Source: statsd.lisp.

Special Variable: *random-range* ¶

Package: cl-statsd.
Source: clients/base.lisp.

Special Variable: *throttle-threshold* ¶

Package: cl-statsd.
Source: async.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]

6.1.2 Macros

Macro: with-timing ((key &optional client) &body body) ¶

Package: cl-statsd.
Source: statsd.lisp.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

6.1.3 Ordinary functions

Function: capture-client.recv (&optional client) ¶

Package: cl-statsd.
Source: capture.lisp.

Function: capture-client.reset (&optional client) ¶

Package: cl-statsd.
Source: capture.lisp.

Function: counter (key value &key rate client) ¶

Package: cl-statsd.
Source: statsd.lisp.

Function: dec (key &key rate client) ¶

Package: cl-statsd.
Source: statsd.lisp.

Function: gauge (key value &key rate client) ¶

Package: cl-statsd.
Source: statsd.lisp.

Function: inc (key &key rate client) ¶

Package: cl-statsd.
Source: statsd.lisp.

Function: make-async-client (&key prefix throttle-threshold error-handler transport host port reconnects tcp-p) ¶

Package: cl-statsd.
Source: async.lisp.

Function: make-capture-client (&key prefix) ¶

Package: cl-statsd.
Source: capture.lisp.

Function: make-null-client () ¶

Package: cl-statsd.
Source: null.lisp.

Function: make-sync-client (&key prefix error-handler transport host port tcp-p) ¶

Package: cl-statsd.
Source: sync.lisp.

Function: set (key value &key rate client) ¶

Package: cl-statsd.
Source: statsd.lisp.

Function: start-async-client (&optional client) ¶

Package: cl-statsd.
Source: async.lisp.

Function: stop-client (&key client timeout) ¶

Package: cl-statsd.
Source: clients/base.lisp.

Function: timing (key value &key rate client) ¶

Package: cl-statsd.
Source: statsd.lisp.

Next: Conditions, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

6.1.4 Generic functions

Generic Function: handler-handle-error (handler e) ¶

Package

Source

Methods

Method: handler-handle-error ((handler (eql :ignore)) e) ¶

Method: handler-handle-error ((handler (eql :throw)) e) ¶

Generic Function: make-transport (transport host port protocol) ¶

Package

Source

Methods

Method: make-transport ((transport (eql :usocket)) host port tcp-p) ¶

Source: usocket.lisp.

Generic Function: transport.close (transport) ¶

Package

Source

Methods

Method: transport.close ((transport capture-client)) ¶

Source: capture.lisp.

Method: transport.close ((transport usocket-transport)) ¶

Source: usocket.lisp.

Generic Function: transport.connect (transport) ¶

Package

Source

Methods

Method: transport.connect ((transport usocket-transport)) ¶

Source: usocket.lisp.

Generic Function: transport.send (transport metrics) ¶

Package

Source

Methods

Method: transport.send ((transport capture-client) metrics) ¶

Source: capture.lisp.

Method: transport.send ((transport usocket-transport) metrics) ¶

Source: usocket.lisp.

Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]

6.1.5 Conditions

Condition: throttle-threshold-reached ¶

Package

Source

async.lisp.

Direct superclasses

error.

Direct methods

throttle-threshold.

Direct slots

Slot: threshold ¶

Initargs: :threshold
Readers: throttle-threshold.
Writers: This slot is read-only.

Condition: transport-error ¶

Package

Source

Direct superclasses

error.

Direct methods

transport-error-error.

Direct slots

Slot: error ¶

Package: common-lisp.
Initargs: :error
Readers: transport-error-error.
Writers: This slot is read-only.

Previous: Conditions, Up: Public Interface [Contents][Index]

6.1.6 Classes

Class: socket-transport ¶

Package

Source

Direct superclasses

transport-base.

Direct subclasses

usocket-transport.

Direct methods

transport-host.
transport-port.
transport-socket.
transport-tcp-p.

Direct slots

Slot: socket ¶

Initargs: :socket
Readers: transport-socket.
Writers: This slot is read-only.

Slot: host ¶

Initargs: :host
Readers: transport-host.
Writers: This slot is read-only.

Slot: port ¶

Initargs: :port
Readers: transport-port.
Writers: This slot is read-only.

Slot: tcp ¶

Initargs: :tcp-p
Readers: transport-tcp-p.
Writers: This slot is read-only.

Class: transport-base ¶

Package

Source

Direct subclasses

capture-client.
socket-transport.

Previous: Public Interface, Up: Definitions [Contents][Index]

6.2 Internals

Constants
Macros
Ordinary functions
Generic functions
Classes

Next: Macros, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Constants

Constant: +async-client-reconnects-default+ ¶

Package: cl-statsd.
Source: async.lisp.

Next: Ordinary functions, Previous: Constants, Up: Internals [Contents][Index]

6.2.2 Macros

Macro: maybe-send (rate &body body) ¶

Package: cl-statsd.
Source: clients/base.lisp.

Macro: with-smart?-error-handling (client &body body) ¶

Package: cl-statsd.
Source: clients/base.lisp.

Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]

6.2.3 Ordinary functions

Function: async-client-thread-fun (client) ¶

Package: cl-statsd.
Source: async.lisp.

Function: client-handler-error (client e) ¶

Package: cl-statsd.
Source: clients/base.lisp.

Function: serialize-metric% (metric key value rate) ¶

Package: cl-statsd.
Source: clients/base.lisp.

Function: with-timing% (client key lambda) ¶

Package: cl-statsd.
Source: statsd.lisp.

Next: Classes, Previous: Ordinary functions, Up: Internals [Contents][Index]

6.2.4 Generic functions

Generic Reader: async-client-mailbox (object) ¶

Package

Methods

Reader Method: async-client-mailbox ((async-client async-client)) ¶

automatically generated reader method

Source: async.lisp.
Target Slot: mailbox.

Generic Reader: async-client-reconnects (object) ¶

Package

Methods

Reader Method: async-client-reconnects ((async-client async-client)) ¶

automatically generated reader method

Source: async.lisp.
Target Slot: reconnects.

Generic Reader: async-client-state (object) ¶

Package

Methods

Reader Method: async-client-state ((async-client async-client)) ¶

automatically generated reader method

Source: async.lisp.
Target Slot: state.

Generic Reader: async-client-thread (object) ¶

Package

Methods

Reader Method: async-client-thread ((async-client async-client)) ¶

automatically generated reader method

Source: async.lisp.
Target Slot: thread.

Generic Reader: async-client-throttle-threshold (object) ¶

Package

Methods

Reader Method: async-client-throttle-threshold ((async-client async-client)) ¶

automatically generated reader method

Source: async.lisp.
Target Slot: throttle-threshold.

Generic Reader: capture-client-queue (object) ¶

Package

Methods

Reader Method: capture-client-queue ((capture-client capture-client)) ¶

automatically generated reader method

Source: capture.lisp.
Target Slot: queue.

Generic Writer: (setf capture-client-queue) (object) ¶

Package

Methods

Writer Method: (setf capture-client-queue) ((capture-client capture-client)) ¶

automatically generated writer method

Source: capture.lisp.
Target Slot: queue.

Generic Reader: client-error-handler (object) ¶

Package

Methods

Reader Method: client-error-handler ((statsd-client-base statsd-client-base)) ¶

automatically generated reader method

Source: clients/base.lisp.
Target Slot: error-handler.

Generic Reader: client-prefix (object) ¶

Package

Methods

Reader Method: client-prefix ((statsd-client-with-prefix statsd-client-with-prefix)) ¶

automatically generated reader method

Source: clients/base.lisp.
Target Slot: prefix.

Generic Function: client-transport (object) ¶

Package

Methods

Method: client-transport ((client capture-client)) ¶

Source: capture.lisp.

Reader Method: client-transport ((statsd-client-with-transport statsd-client-with-transport)) ¶

automatically generated reader method

Source: clients/base.lisp.
Target Slot: transport.

Generic Function: send (client metric key value rate) ¶

Package

Source

Methods

Method: send ((client async-client) metric key value rate) ¶

Source: async.lisp.

Method: send ((client sync-client) metric key value rate) ¶

Source: sync.lisp.

Method: send ((client null-client) metric key value rate) ¶

Source: null.lisp.

Method: send ((client capture-client) metric key value rate) ¶

Source: capture.lisp.

Method: send :around ((client statsd-client-with-prefix) metric key value rate) ¶

Generic Function: serialize-metric (metric key value rate) ¶

Package

Source

Methods

Method: serialize-metric ((metric (eql :set)) key value rate) ¶

Method: serialize-metric ((metric (eql :gauge)) key value rate) ¶

Method: serialize-metric ((metric (eql :timing)) key value rate) ¶

Method: serialize-metric ((metric (eql :counter)) key value rate) ¶

Generic Function: stop-client% (client timeout) ¶

Package

Source

Methods

Method: stop-client% ((client async-client) timeout) ¶

Source: async.lisp.

Method: stop-client% ((client statsd-client-with-transport) timeout) ¶

Method: stop-client% (client timeout) ¶

Generic Reader: throttle-threshold (condition) ¶

Package

Methods

Reader Method: throttle-threshold ((condition throttle-threshold-reached)) ¶

Source: async.lisp.
Target Slot: threshold.

Generic Reader: transport-error-error (condition) ¶

Package

Methods

Reader Method: transport-error-error ((condition transport-error)) ¶

Source: base.lisp.
Target Slot: error.

Generic Reader: transport-host (object) ¶

Package

Methods

Reader Method: transport-host ((socket-transport socket-transport)) ¶

automatically generated reader method

Source: base.lisp.
Target Slot: host.

Generic Reader: transport-port (object) ¶

Package

Methods

Reader Method: transport-port ((socket-transport socket-transport)) ¶

automatically generated reader method

Source: base.lisp.
Target Slot: port.

Generic Reader: transport-socket (object) ¶

Package

Methods

Reader Method: transport-socket ((socket-transport socket-transport)) ¶

automatically generated reader method

Source: base.lisp.
Target Slot: socket.

Generic Reader: transport-tcp-p (object) ¶

Package

Methods

Reader Method: transport-tcp-p ((socket-transport socket-transport)) ¶

automatically generated reader method

Source: base.lisp.
Target Slot: tcp.

Previous: Generic functions, Up: Internals [Contents][Index]

6.2.5 Classes

Class: async-client ¶

Package

statsd-client-with-transport.

Source

async.lisp.

Direct superclasses

Direct methods

async-client-mailbox.
async-client-reconnects.
async-client-state.
async-client-thread.
async-client-throttle-threshold.
send.
stop-client%.

Direct slots

Slot: reconnects ¶

Initform: cl-statsd::+async-client-reconnects-default+
Initargs: :reconnects
Readers: async-client-reconnects.
Writers: This slot is read-only.

Slot: state ¶

Initform: :created
Readers: async-client-state.
Writers: This slot is read-only.

Slot: throttle-threshold ¶

Initargs: :throttle-threshold
Readers: async-client-throttle-threshold.
Writers: This slot is read-only.

Slot: thread ¶

Readers: async-client-thread.
Writers: This slot is read-only.

Slot: mailbox ¶

Initform: (safe-queue:make-mailbox)
Readers: async-client-mailbox.
Writers: This slot is read-only.

Class: capture-client ¶

Package

Source

capture.lisp.

Direct superclasses

statsd-client-with-prefix.
transport-base.

Direct methods

(setf capture-client-queue).
capture-client-queue.
client-transport.
send.
transport.close.
transport.send.

Direct slots

Slot: queue ¶

Initform: (safe-queue:make-queue)
Readers: capture-client-queue.
Writers: (setf capture-client-queue).

Class: null-client ¶

Package: cl-statsd.
Source: null.lisp.
Direct superclasses: statsd-client-base.
Direct methods: send.

Class: statsd-client-base ¶

Package

Source

Direct subclasses

null-client.
statsd-client-with-prefix.

Direct methods

client-error-handler.

Direct slots

Slot: error-handler ¶

Initform: :ignore
Initargs: :error-handler
Readers: client-error-handler.
Writers: This slot is read-only.

Class: statsd-client-with-prefix ¶

Package

Source

Direct superclasses

statsd-client-base.

Direct subclasses

capture-client.
statsd-client-with-transport.

Direct methods

client-prefix.
send.

Direct slots

Slot: prefix ¶

Initargs: :prefix
Readers: client-prefix.
Writers: This slot is read-only.

Class: statsd-client-with-transport ¶

Package

Source

statsd-client-with-prefix.

Direct superclasses

Direct subclasses

async-client.
sync-client.

Direct methods

client-transport.
stop-client%.

Direct slots

Slot: transport ¶

Initargs: :transport
Readers: client-transport.
Writers: This slot is read-only.

Class: sync-client ¶

Package: cl-statsd.
Source: sync.lisp.
Direct superclasses: statsd-client-with-transport.
Direct methods: send.

Class: usocket-transport ¶

Package