The ryeboy Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The ryeboy Reference Manual

This is the ryeboy Reference Manual, version 0.0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:18:36 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Ryeboy

Build Status

monolith

A Common Lisp client to Riemann

Usage:

(ql:quickload :ryeboy)
(use-package :ryeboy)

(let ((conn (make-connection))
      (ht (make-hash-table :test #'equal)))
  (setf (gethash "foo" ht) "bar")
  (send-event conn (make-event)) ;; Sends with time/host defaults
  (send-events conn
               (make-event :tags (list "foo" "bar" "baz"))
               (make-event :attrs ht)
               (make-event :service "somefunkyservice")
               (make-event :service "somethingisbroken" :state "offline"))
  (print (query conn "service = \"somefunkyservice\"")))

Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


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

2.1 ryeboy

Author

Aaron France aaron.l.france@gmail.com

License

BSD

Description

Riemann client

Version

0.0.1

Dependencies
Source

ryeboy.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 ryeboy.asd

Location

ryeboy.asd

Systems

ryeboy (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 ryeboy/packages.lisp

Parent

ryeboy (system)

Location

packages.lisp

Packages

ryeboy


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 ryeboy/proto.lisp

Dependency

packages.lisp (file)

Parent

ryeboy (system)

Location

proto.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 ryeboy/binary.lisp

Dependency

proto.lisp (file)

Parent

ryeboy (system)

Location

binary.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 ryeboy/time.lisp

Dependency

binary.lisp (file)

Parent

ryeboy (system)

Location

time.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 ryeboy/ryeboy-protocol.lisp

Dependency

time.lisp (file)

Parent

ryeboy (system)

Location

ryeboy-protocol.lisp

Exported Definitions

make-event (function)

Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.7 ryeboy/ryeboy-conn.lisp

Dependency

ryeboy-protocol.lisp (file)

Parent

ryeboy (system)

Location

ryeboy-conn.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


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

4.1 ryeboy

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: make-connection &key CONNECTION-TYPE HOST PORT
Package

ryeboy

Source

ryeboy-conn.lisp (file)

Function: make-event &key TIME METRIC HOST STATE SERVICE DESCRIPTION TAGS TTL ATTRS
Package

ryeboy

Source

ryeboy-protocol.lisp (file)

Function: query CONN QUERY-STRING
Package

ryeboy

Source

ryeboy-conn.lisp (file)

Function: send-event CONN EVENT
Package

ryeboy

Source

ryeboy-conn.lisp (file)

Function: send-events CONN &rest EVENTS
Package

ryeboy

Source

ryeboy-conn.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Conditions

Condition: riemann-error-response ()
Package

ryeboy

Source

ryeboy-conn.lisp (file)

Direct superclasses

condition (condition)

Direct methods
Direct slots
Slot: error-type
Initargs

:name

Readers

error-type (generic function)

Slot: error-msg
Initargs

:msg

Readers

error-msg (generic function)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *unix-epoch-difference*
Package

ryeboy

Source

time.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: define-binary-type NAME SIZE
Package

ryeboy

Source

binary.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: bytes->event BYTES
Package

ryeboy

Source

ryeboy-protocol.lisp (file)

Function: bytes->msg BYTES
Package

ryeboy

Source

ryeboy-protocol.lisp (file)

Function: encode-attributes KV
Package

ryeboy

Source

ryeboy-protocol.lisp (file)

Function: get-unix-time ()
Package

ryeboy

Source

time.lisp (file)

Function: handle-response RESPONSE REQUEST-TYPE
Package

ryeboy

Source

ryeboy-conn.lisp (file)

Function: make-msg &rest EVENTS
Package

ryeboy

Source

ryeboy-conn.lisp (file)

Function: make-query QUERY-STRING
Package

ryeboy

Source

ryeboy-protocol.lisp (file)

Function: read-int stream1 &key SIGNED?
Package

ryeboy

Source

binary.lisp (file)

Function: read-reply CONN REQUEST-TYPE
Package

ryeboy

Source

ryeboy-conn.lisp (file)

Function: read-sized N STREAM &optional SIGNED?
Package

ryeboy

Source

binary.lisp (file)

Function: send-msg CONN MSG REQ-TYPE
Package

ryeboy

Source

ryeboy-conn.lisp (file)

Function: thing->bytes THING
Package

ryeboy

Source

ryeboy-protocol.lisp (file)

Function: universal-to-unix-time UNIVERSAL-TIME
Package

ryeboy

Source

time.lisp (file)

Function: unix-to-universal-time UNIX-TIME
Package

ryeboy

Source

time.lisp (file)

Function: write-int value0 stream1
Package

ryeboy

Source

binary.lisp (file)

Function: write-sized VALUE N STREAM
Package

ryeboy

Source

binary.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Generic functions

Generic Function: error-msg CONDITION
Package

ryeboy

Methods
Method: error-msg (CONDITION riemann-error-response)
Source

ryeboy-conn.lisp (file)

Generic Function: error-type CONDITION
Package

ryeboy

Methods
Method: error-type (CONDITION riemann-error-response)
Source

ryeboy-conn.lisp (file)

Generic Function: set-attributes EVENT ATTRIBUTES

Set the attributes on the event

Package

ryeboy

Source

ryeboy-protocol.lisp (file)

Methods
Method: set-attributes (EVENT event) (ATTRIBUTES hash-table)
Generic Function: set-metric EVENT METRIC

Set the metric type on the event

Package

ryeboy

Source

ryeboy-protocol.lisp (file)

Methods
Method: set-metric (EVENT event) (METRIC double-float)
Method: set-metric (EVENT event) (METRIC float)
Method: set-metric (EVENT event) (METRIC integer)

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

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   R  
Index Entry  Section

F
File, Lisp, ryeboy.asd: The ryeboy<dot>asd file
File, Lisp, ryeboy/binary.lisp: The ryeboy/binary<dot>lisp file
File, Lisp, ryeboy/packages.lisp: The ryeboy/packages<dot>lisp file
File, Lisp, ryeboy/proto.lisp: The ryeboy/proto<dot>lisp file
File, Lisp, ryeboy/ryeboy-conn.lisp: The ryeboy/ryeboy-conn<dot>lisp file
File, Lisp, ryeboy/ryeboy-protocol.lisp: The ryeboy/ryeboy-protocol<dot>lisp file
File, Lisp, ryeboy/time.lisp: The ryeboy/time<dot>lisp file

L
Lisp File, ryeboy.asd: The ryeboy<dot>asd file
Lisp File, ryeboy/binary.lisp: The ryeboy/binary<dot>lisp file
Lisp File, ryeboy/packages.lisp: The ryeboy/packages<dot>lisp file
Lisp File, ryeboy/proto.lisp: The ryeboy/proto<dot>lisp file
Lisp File, ryeboy/ryeboy-conn.lisp: The ryeboy/ryeboy-conn<dot>lisp file
Lisp File, ryeboy/ryeboy-protocol.lisp: The ryeboy/ryeboy-protocol<dot>lisp file
Lisp File, ryeboy/time.lisp: The ryeboy/time<dot>lisp file

R
ryeboy.asd: The ryeboy<dot>asd file
ryeboy/binary.lisp: The ryeboy/binary<dot>lisp file
ryeboy/packages.lisp: The ryeboy/packages<dot>lisp file
ryeboy/proto.lisp: The ryeboy/proto<dot>lisp file
ryeboy/ryeboy-conn.lisp: The ryeboy/ryeboy-conn<dot>lisp file
ryeboy/ryeboy-protocol.lisp: The ryeboy/ryeboy-protocol<dot>lisp file
ryeboy/time.lisp: The ryeboy/time<dot>lisp file

Jump to:   F   L   R  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   B   D   E   F   G   H   M   Q   R   S   T   U   W  
Index Entry  Section

B
bytes->event: Internal functions
bytes->msg: Internal functions

D
define-binary-type: Internal macros

E
encode-attributes: Internal functions
error-msg: Internal generic functions
error-msg: Internal generic functions
error-type: Internal generic functions
error-type: Internal generic functions

F
Function, bytes->event: Internal functions
Function, bytes->msg: Internal functions
Function, encode-attributes: Internal functions
Function, get-unix-time: Internal functions
Function, handle-response: Internal functions
Function, make-connection: Exported functions
Function, make-event: Exported functions
Function, make-msg: Internal functions
Function, make-query: Internal functions
Function, query: Exported functions
Function, read-int: Internal functions
Function, read-reply: Internal functions
Function, read-sized: Internal functions
Function, send-event: Exported functions
Function, send-events: Exported functions
Function, send-msg: Internal functions
Function, thing->bytes: Internal functions
Function, universal-to-unix-time: Internal functions
Function, unix-to-universal-time: Internal functions
Function, write-int: Internal functions
Function, write-sized: Internal functions

G
Generic Function, error-msg: Internal generic functions
Generic Function, error-type: Internal generic functions
Generic Function, set-attributes: Internal generic functions
Generic Function, set-metric: Internal generic functions
get-unix-time: Internal functions

H
handle-response: Internal functions

M
Macro, define-binary-type: Internal macros
make-connection: Exported functions
make-event: Exported functions
make-msg: Internal functions
make-query: Internal functions
Method, error-msg: Internal generic functions
Method, error-type: Internal generic functions
Method, set-attributes: Internal generic functions
Method, set-metric: Internal generic functions
Method, set-metric: Internal generic functions
Method, set-metric: Internal generic functions

Q
query: Exported functions

R
read-int: Internal functions
read-reply: Internal functions
read-sized: Internal functions

S
send-event: Exported functions
send-events: Exported functions
send-msg: Internal functions
set-attributes: Internal generic functions
set-attributes: Internal generic functions
set-metric: Internal generic functions
set-metric: Internal generic functions
set-metric: Internal generic functions
set-metric: Internal generic functions

T
thing->bytes: Internal functions

U
universal-to-unix-time: Internal functions
unix-to-universal-time: Internal functions

W
write-int: Internal functions
write-sized: Internal functions

Jump to:   B   D   E   F   G   H   M   Q   R   S   T   U   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
E   S  
Index Entry  Section

*
*unix-epoch-difference*: Internal special variables

E
error-msg: Exported conditions
error-type: Exported conditions

S
Slot, error-msg: Exported conditions
Slot, error-type: Exported conditions
Special Variable, *unix-epoch-difference*: Internal special variables

Jump to:   *  
E   S  

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

A.4 Data types

Jump to:   C   P   R   S  
Index Entry  Section

C
Condition, riemann-error-response: Exported conditions

P
Package, ryeboy: The ryeboy package

R
riemann-error-response: Exported conditions
ryeboy: The ryeboy system
ryeboy: The ryeboy package

S
System, ryeboy: The ryeboy system

Jump to:   C   P   R   S