Network.Monitoring.Riemann.Types

Documentation

class HasState a where

HasState types (e.g. Event and State) have information representing the state of a service on a host at a given time. These shared types give rise to restrictedly polymorphic lenses.

Methods

time :: Lens' a (Maybe (Signed Int64))

The time of the event, in unix epoch seconds

state :: Lens' a (Maybe Text)

Any string less than 255 bytes, e.g. "ok", "warning", "critical"

service :: Lens' a (Maybe Text)

e.g. "API port 8000 reqs/sec"

host :: Lens' a (Maybe Text)

A hostname, e.g. "api1", "foo.com"

description :: Lens' a (Maybe Text)

Freeform text

tags :: Lens' a [Text]

Freeform list of strings, e.g. ["rate", "fooproduct", "transient"]

ttl :: Lens' a (Maybe Float)

A floating-point time, in seconds, that this event is considered valid for. Expired states may be removed from the index.

Instances

HasState Event

HasState State

class AMetric a where

The class of types which can be interpreted as metrics for an Event.

Methods

metric :: Lens' Event (Maybe a)

Instances

AMetric Double

AMetric Float

AMetric Int

AMetric Integer

AMetric (Signed Int64)

class HasQuery a where

HasQuery types contain a Riemann query inside them somewhere. This class provides query as a polymorphic lens toward that query.

Methods

query :: Lens' a (Maybe Text)

Instances

HasQuery Msg

HasQuery Query

data State

State is an object within Riemann's index, a result from a Query.

Instances

Eq State

Show State

Generic State

Monoid State

Default State

Decode State

Encode State

HasState State

type Rep State

data Event

Event is a description of an application-level event, emitted to Riemann for indexing.

Instances

Eq Event

Show Event

Generic Event

Monoid Event

Default Event

Decode Event

Encode Event

HasState Event

type Rep Event

data Query

Query is a question to be made of the Riemann index.

Instances

Eq Query

Show Query

Generic Query

Monoid Query

Default Query

Decode Query

Encode Query

HasQuery Query

type Rep Query

data Msg

Msg is a wrapper for sending/receiving multiple States, Events, or a single Query.

Instances

Eq Msg

Show Msg

Generic Msg

Monoid Msg

Default Msg

Decode Msg

Encode Msg

HasQuery Msg

type Rep Msg

ev :: AMetric a => String -> a -> Event

Create a simple Event with state "ok".

>>> get state $ ev "service" (0 :: (Signed Int64))
Just "ok"

>>> get service $ ev "service" (0 :: (Signed Int64))
Just "service"

>>> get metric $ ev "service" (0 :: (Signed Int64)) :: Maybe (Signed Int64)
Just 0

>>> get tags $ ev "service" (0 :: (Signed Int64))
[]

once :: Lens' State (Maybe Bool)

attributes :: Lens' Event (Map Text Text)

data MsgState

msgState :: Lens' Msg MsgState

states :: Lens' Msg [State]

events :: Lens' Msg [Event]