Skip to content
Newer
Older
100644 39 lines (27 sloc) 1.16 KB
63b0570 Add README, LICENSE
Kyle Kingsbury authored
1 This project encompasses:
2
3 1. A Java client for the Riemann protocol
4 2. The Riemann protocol buffer definition, and
5 3. Its corresponding (autogenerated) Java classes
6
7 # Example
8
9 ``` java
9e3db5f Readme: mention protoc, fix syntax.
Kyle Kingsbury authored
10 RiemannClient c = new RiemannTcpClient(new InetSocketAddress("my.riemann.server", 5555));
63b0570 Add README, LICENSE
Kyle Kingsbury authored
11 c.event().
9e3db5f Readme: mention protoc, fix syntax.
Kyle Kingsbury authored
12 service("fridge").
13 state("running").
63b0570 Add README, LICENSE
Kyle Kingsbury authored
14 metric(5.3).
9e3db5f Readme: mention protoc, fix syntax.
Kyle Kingsbury authored
15 tags("appliance", "cold").
63b0570 Add README, LICENSE
Kyle Kingsbury authored
16 send();
17
9e3db5f Readme: mention protoc, fix syntax.
Kyle Kingsbury authored
18 c.query("tagged \"cold\" and metric > 0"); // => List<Event>;
63b0570 Add README, LICENSE
Kyle Kingsbury authored
19 ```
20
21 # Status
22
23 The TCP client is in its early stages; it does not handle server error
24 responses correctly and offers no pooling or retries. The top-level API for
25 sending events and querying the index is functional and threadsafe. A small DSL
26 is available to make sending events easier.
27
9e3db5f Readme: mention protoc, fix syntax.
Kyle Kingsbury authored
28
63b0570 Add README, LICENSE
Kyle Kingsbury authored
29 # Next steps
30
31 - Set host automatically.
32 - Add error handling to TcpClient--raise exceptions when msg.getOk() is false.
33 - Write a UDP client.
34 - Write a hybrid client which dispatches to UDP and TCP clients as appropriate.
9e3db5f Readme: mention protoc, fix syntax.
Kyle Kingsbury authored
35
36 # Hacking
37
38 You'll need [protoc 2.3.0](http://code.google.com/p/protobuf/downloads/detail?name=protobuf-2.3.0.tar.bz2&can=2&q=). After that, `mvn package` should build a JAR, and `mvn install` will drop it in your local repository.
Something went wrong with that request. Please try again.