README
¶
Riemann client (Golang)
Introduction
Go client library for Riemann.
This client library was inspired by Raidman, and Riemann NodeJS Client.
Features:
- Idiomatic concurrency
- Sending events, state updates, queries.
- Feature parity with the reference implementation written in Ruby.
Installation
To install the package for use in your own programs:
go get github.com/bigdatadev/goryman
If you're a developer, Riemann uses Google Protocol Buffers, so make sure that's installed and available on your PATH.
go get github.com/golang/protobuf/{proto,protoc-gen-go}
Getting Started
First we'll need to import the library:
import (
"github.com/bigdatadev/goryman"
)
Next we'll need to establish a new client:
c := goryman.NewGorymanClient("localhost:5555")
err := c.Connect()
if err != nil {
panic(err)
}
Don't forget to close the client connection when you're done:
defer c.Close()
Just like the Riemann Ruby client, the client sends small events over UDP by default. TCP is used for queries, and large events. There is no acknowledgement of UDP packets, but they are roughly an order of magnitude faster than TCP. We assume both TCP and UDP are listening on the same port.
Sending events is easy (list of valid event properties):
err = c.SendEvent(&goryman.Event{
Service: "moargore",
Metric: 100,
Tags: []string{"nonblocking"},
})
if err != nil {
panic(err)
}
You can also query events:
events, err := c.QueryEvents("host = \"goryman\"")
if err != nil {
panic(err)
}
The Hostname and Time in events will automatically be replaced with the hostname of the server and the current time if none is specified.
Integrations
Martini: GoryMartini
Contributing
Just send me a pull request. Please take a look at the project issues and see how you can help. Here are some tips:
- please add more tests.
- please check your syntax.
Author
Christopher Gilbert
- Web: http://cjgilbert.me
- Twitter: @bigdatadev
- Linkedin: /in/christophergilbert
Copyright
See LICENSE document
Documentation
¶
Overview ¶
A Riemann client for Go, featuring concurrency, sending events and state updates, queries, and feature parity with the reference implementation written in Ruby.
Copyright (C) 2014 by Christopher Gilbert <christopher.john.gilbert@gmail.com>
Index ¶
Constants ¶
const MAX_UDP_SIZE = 16384
MAX_UDP_SIZE is the maximum allowed size of a UDP packet before automatically failing the send
Variables ¶
This section is empty.
Functions ¶
func EventToProtocolBuffer ¶
EventToProtocolBuffer converts an Event type to a proto.Event
Types ¶
type Event ¶
type Event struct {
Ttl float32
Time int64
Tags []string
Host string // Defaults to os.Hostname()
State string
Service string
Metric interface{} // Could be Int, Float32, Float64
Description string
Attributes map[string]string
}
Event is a wrapper for Riemann events
func ProtocolBuffersToEvents ¶
ProtocolBuffersToEvents converts an array of proto.Event to an array of Event
type GorymanClient ¶
type GorymanClient struct {
// contains filtered or unexported fields
}
GorymanClient is a client library to send events to Riemann
func NewGorymanClient ¶
func NewGorymanClient(addr string) *GorymanClient
NewGorymanClient - Factory
func (*GorymanClient) Connect ¶
func (c *GorymanClient) Connect() error
Connect creates a UDP and TCP connection to a Riemann server
func (*GorymanClient) QueryEvents ¶
func (c *GorymanClient) QueryEvents(q string) ([]Event, error)
Query the server for events
func (*GorymanClient) SendState ¶
func (c *GorymanClient) SendState(s *State) error
Send a state update
type State ¶
type State struct {
Ttl float32
Time int64
Tags []string
Host string // Defaults to os.Hostname()
State string
Service string
Once bool
Metric interface{} // Could be Int, Float32, Float64
Description string
Attributes map[string]string
}
State is a wrapper for Riemann states
type TcpTransport ¶
type TcpTransport struct {
// contains filtered or unexported fields
}
TcpTransport is a type that implements the Transport interface
func (*TcpTransport) SendMaybeRecv ¶
TcpTransport implementation of SendMaybeRecv, queues a request to send a message to the server
type Transport ¶
type Transport interface {
SendRecv(message *proto.Msg) (*proto.Msg, error)
SendMaybeRecv(message *proto.Msg) (*proto.Msg, error)
}
Transport is an interface to a generic transport used by the client
type UdpTransport ¶
type UdpTransport struct {
// contains filtered or unexported fields
}
UdpTransport is a type that implements the Transport interface
func (*UdpTransport) SendMaybeRecv ¶
UdpTransport implementation of SendMaybeRecv, queues a request to send a message to the server
Source Files
Directories