README
¶
Riemann client (Golang)
Introduction
A Go client library for Riemann.
Features:
- Idiomatic concurrency
- Sending events, queries.
- Support TCP, UDP, TLS clients.
- Second and Microsecond time resolution
This client is a fork of Goryman, a Riemann go client written by Christopher Gilbert. Thanks and full credit to him!
The initial Goryman repository has been deleted. We've used @rikatz's fork to create this repository.
We've also renamed the client to riemanngo instead of goryman to make its purpose clearer.
Build Status
Installation
To install the package for use in your own programs:
go get github.com/riemann/riemann-go-client
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/riemann/riemann-go-client"
)
Next, we'll need to establish a new client. The parameter is the connection timeout duration. You can use a TCP client:
c := riemanngo.NewTcpClient("127.0.0.1:5555")
err := c.Connect(5)
if err != nil {
panic(err)
}
Or a UDP client:
c := riemanngo.NewUdpClient("127.0.0.1:5555")
err := c.Connect(5)
if err != nil {
panic(err)
}
You can also create a TLS client. The second parameter is the path to your client certificate, the third parameter the path to your client key. The last parameter allows you to create an insecure connection (insecure certificate check). You can find more informations about how to configure TLS in Riemann here.
c := riemanngo.NewTlsClient("127.0.0.1:5554", "/path/to/cert.pem", "/path/to/key.key", true)
err := c.Connect(5)
if err != nil {
panic(err)
}
Don't forget to close the client connection when you're done:
defer c.Close()
Sending events is easy (list of valid event properties):
result, err := riemanngo.SendEvent(c, &riemanngo.Event{
Service: "hello",
Metric: 100,
Tags: []string{"riemann ftw"},
})
The host name and time in events will automatically be replaced with the hostname of the server and the current time if none is specified.
You can also send batch of events:
events = []riemanngo.Event {
riemanngo.Event{
Service: "hello",
Metric: 100,
Tags: []string{"hello"},
},
riemanngo.Event{
Service: "goodbye",
Metric: 200,
Tags: []string{"goodbye"},
},
}
You can also query the Riemann index (using the TCP or TLS client):
events, err := c.QueryIndex("service = \"hello\"")
if err != nil {
panic(err)
}
Tests
You can lauch tests using
make test
and integration tests using:
make integ-test
This command will download Riemann, start it, launch integration tests, and kill it.
You can also use:
go test -tags=integration
if you already have a Riemann instance listening on localhost
Copyright
See LICENSE document
Documentation
¶
Overview ¶
A Riemann client for Go, featuring concurrency, sending events and state updates, queries
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 ¶
convert an event to a protobuf Event
Types ¶
type Client ¶
type Client interface {
Send(message *proto.Msg) (*proto.Msg, error)
Connect(timeout int32) error
Close() error
}
Client is an interface to a generic client
type Event ¶
type Event struct {
Ttl float32
Time time.Time
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 ¶
converts an array of proto.Event to an array of Event
type IndexClient ¶
IndexClient is an interface to a generic Client for index queries
type TcpClient ¶
type TcpClient struct {
// contains filtered or unexported fields
}
TcpClient is a type that implements the Client interface
func (*TcpClient) QueryIndex ¶
Query the server for events using the client
type TlsClient ¶
type TlsClient struct {
// contains filtered or unexported fields
}
TlsClient is a type that implements the Client interface
func NewTlsClient ¶
NewTlsClient - Factory
func (*TlsClient) QueryIndex ¶
Query the server for events using the client
Source Files
Directories