Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/katja-beam/katja
A simple Riemann client written in Erlang.
https://github.com/katja-beam/katja
erlang query-riemann riemann riemann-client
Last synced: about 1 month ago
JSON representation
A simple Riemann client written in Erlang.
- Host: GitHub
- URL: https://github.com/katja-beam/katja
- Owner: katja-beam
- License: isc
- Created: 2014-04-26T16:32:56.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-05-24T14:04:50.000Z (over 4 years ago)
- Last Synced: 2024-10-01T15:07:58.448Z (about 2 months ago)
- Topics: erlang, query-riemann, riemann, riemann-client
- Language: Erlang
- Homepage: https://hex.pm/packages/katja
- Size: 340 KB
- Stars: 27
- Watchers: 5
- Forks: 19
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Katja
A simple [Riemann](http://riemann.io) client written in Erlang.
[](https://travis-ci.org/katja-beam/katja) [](https://coveralls.io/github/katja-beam/katja?branch=master)
## Status
This is alpha software. Things might still change in ways that break everything.
## Configuration
```erlang
% Defaults
[
{katja, [
{host, "127.0.0.1"},
{port, 5555},
{transport, detect},
{pool, []},
{defaults, []}
]}
].
```
**host**: Host Riemann is running on
**port**: Port Riemann is listening on
**transport**: The message transport that should be used (supported: `detect`, `udp`, `tcp`)
**pool**: List of processes that should not be started (and supervised) by Katja (supported: `katja_reader`, `katja_writer`)
**defaults**: Property list with default values for events and states (supported: `host`, `tags`, `ttl`)
## Examples
### Sending an event
```erlang
Event = [{service, "katja demo"}, {metric, 9000.1}],
ok = katja:send_event(Event).
```
An event in Katja is just a property list. A list of all possible properties can be found in the `katja` module.
You can send an event asynchronously using `katja:send_event_async/{1,2,3}`:
```erlang
Event = [{service, "katja demo"}, {metric, 9000.1}],
ok = katja:send_event_async(Event).
```
This will return immediately and you will **not** know if the call has succeeded.
### Sending a state
```erlang
State = [{service, "katja demo"}, {state, "testing"}],
ok = katja:send_state(State).
```
Just like events, a state is a property list. The properties can once again be found in the `katja` module.
Just like for events, you can use `katja:send_state_async/{1,2,3}` to send states in a non-blocking way.
### Sending multiple entities
```erlang
Event = [{service, "katja demo"}, {metric, 9000.1}],
State = [{service, "katja demo"}, {state, "testing"}],
ok = katja:send_entities([{events, [Event, Event]}, {states, [State, State]}]).
```
`katja:send_entities/1` takes a property list with two possible properties: `events` should be set to a list of events and `states` should be set to a list of states.
Both properties are optional, so `katja:send_entities/1` can be used to only send multiple events or states.
```erlang
Event = [{service, "katja demo"}, {metric, 9000.1}],
State = [{service, "katja demo"}, {state, "testing"}],
ok = katja:send_events([Event]),
ok = katja:send_states([State]).
```
`katja:send_events/1` and `katja:send_states/1` are also available to send multiple events or states. Both of them delegate to `katja:send_entities/1` internally.
Sending entities asynchronously is also possible. All of the methods mentioned above have matching `_async/{1,2,3}` counterparts.
### Querying
```erlang
{ok, Events} = katja:query("service = \"katja demo\"").
```
A query returns a list of events. Events are in the format that you specify when sending data to Riemann.
Instead of a string you can also use a `katja:event()` and the `katja:query_event/1` method to send queries to Riemann.
```erlang
{ok, Events} = katja:query_event([{service, "katja demo"}]).
```
Katja will convert the event to a query string and query Riemann based on the generated string.
You can use `katja:query_async/{1,2}` and `katja:query_event_async/{1,2}` to send queries asynchronously. The results will be sent to the inbox of the calling process.
```erlang
Ref = katja:query_async("service = \"katja demo\""),
receive
{Ref, {ok, Events}} ->
% ...
end.
```
### Pooling
All the methods mentioned above optionally take a `katja:process()` as their first argument, enabling Katja to easily work with existing process pool implementations. `katja:process()` is either a `pid()` or one of the two following atoms: `katja_writer`, `katja_reader`.
The `atom()` cases usually don't have to be used directly, since `katja:send_event/1`, `katja:send_state/1`, `katja:query/1` etc. default to setting the correct value.
Additionally you can also "turn off" the `katja_writer` and `katja_reader` processes that are automatically started and supervised by adding their names to the `pool` configuration option.
### Forcing a transport
You can force a message to be send via TCP or UDP. By default, the transport is chosen based on the size of a message: UDP is used for messages up to 16Kb in size, everything larger than that uses TCP. Querying Riemann always uses TCP.
```erlang
Event = [{service, "katja demo"}, {metric, 9000.1}],
ok = katja:send_event(katja_writer, tcp, Event).
```
The first argument to `katja:send_event/3`, `katja:send_events/3`, `katja:send_state/3`, `katja:send_states/3` and `katja:send_entities/3` is a `katja:process()`. If you're using one of these methods and don't use a process pool, it has to be set to `katja_writer`.
You can set the `transport` configuration option to `tcp` or `udp` to always use that transport for sending data to Riemann.
## Resources
* [Generated EDoc](https://hexdocs.pm/katja)
* [Katja: Riemann Client Written In Erlang](https://blog.kempkens.io/posts/katja-riemann-client-written-in-erlang/)
## Related Projects
* [Katja VM Stats](https://github.com/katja-beam/katja_vmstats) - Easily send information about the Erlang VM to Riemann
## License
[ISC](https://en.wikipedia.org/wiki/ISC_license).
```
Copyright (c) 2014-2016, Daniel Kempkens
Copyright The katja-beam Contributors
Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted, provided that the above copyright notice
and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.
```