1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
use std::collections::HashMap;
use crossbeam_channel::Receiver;
use log::info;
use serde_json::Value;
use crate::errors::Result;
use crate::fields::FieldHolder;
use crate::response::Response;
use crate::sender::Sender;
use crate::Event;
use crate::{Builder, DynamicFieldFunc};
const DEFAULT_API_HOST: &str = "https://api.honeycomb.io";
const DEFAULT_API_KEY: &str = "";
const DEFAULT_DATASET: &str = "librust-dataset";
const DEFAULT_SAMPLE_RATE: usize = 1;
#[derive(Debug, Clone)]
pub struct Options {
pub api_key: String,
pub api_host: String,
pub dataset: String,
pub sample_rate: usize,
}
impl Default for Options {
fn default() -> Self {
Self {
api_key: DEFAULT_API_KEY.to_string(),
dataset: DEFAULT_DATASET.to_string(),
api_host: DEFAULT_API_HOST.to_string(),
sample_rate: DEFAULT_SAMPLE_RATE,
}
}
}
#[derive(Debug, Clone)]
pub struct Client<T: Sender> {
pub(crate) options: Options,
pub transmission: T,
builder: Builder,
}
impl<T> Client<T>
where
T: Sender,
{
pub fn new(options: Options, transmission: T) -> Self {
info!("Creating honey client");
let mut c = Self {
transmission,
options: options.clone(),
builder: Builder::new(options),
};
c.start();
c
}
fn start(&mut self) {
self.transmission.start();
}
pub fn add(&mut self, data: HashMap<String, Value>) {
self.builder.add(data);
}
pub fn add_field(&mut self, name: &str, value: Value) {
self.builder.add_field(name, value);
}
pub fn add_dynamic_field(&mut self, name: &str, func: DynamicFieldFunc) {
self.builder.add_dynamic_field(name, func);
}
pub fn close(mut self) -> Result<()> {
info!("closing libhoney client");
self.transmission.stop()
}
pub fn flush(&mut self) -> Result<()> {
info!("flushing libhoney client");
self.transmission.stop()?;
self.transmission.start();
Ok(())
}
pub fn new_builder(&self) -> Builder {
self.builder.clone()
}
pub fn new_event(&self) -> Event {
self.builder.new_event()
}
pub fn responses(&self) -> Receiver<Response> {
self.transmission.responses()
}
}
#[cfg(test)]
mod tests {
use super::{Client, FieldHolder, Options, Value};
use crate::transmission::{self, Transmission};
#[test]
fn test_init() {
let client = Client::new(
Options::default(),
Transmission::new(transmission::Options::default()).unwrap(),
);
client.close().unwrap();
}
#[test]
fn test_flush() {
use reqwest::StatusCode;
use serde_json::json;
let api_host = &mockito::server_url();
let _m = mockito::mock(
"POST",
mockito::Matcher::Regex(r"/1/batch/(.*)$".to_string()),
)
.with_status(200)
.with_header("content-type", "application/json")
.with_body("[{ \"status\": 202 }]")
.create();
let mut client = Client::new(
Options {
api_key: "some api key".to_string(),
api_host: api_host.to_string(),
..Options::default()
},
Transmission::new(transmission::Options::default()).unwrap(),
);
let mut event = client.new_event();
event.add_field("some_field", Value::String("some_value".to_string()));
event.metadata = Some(json!("some metadata in a string"));
event.send(&mut client).unwrap();
let response = client.responses().iter().next().unwrap();
assert_eq!(response.status_code, Some(StatusCode::ACCEPTED));
assert_eq!(response.metadata, Some(json!("some metadata in a string")));
client.flush().unwrap();
event = client.new_event();
event.add_field("some_field", Value::String("some_value".to_string()));
event.metadata = Some(json!("some metadata in a string"));
event.send(&mut client).unwrap();
let response = client.responses().iter().next().unwrap();
assert_eq!(response.status_code, Some(StatusCode::ACCEPTED));
assert_eq!(response.metadata, Some(json!("some metadata in a string")));
client.close().unwrap();
}
#[test]
fn test_send_without_api_key() {
use serde_json::json;
use crate::errors::ErrorKind;
let api_host = &mockito::server_url();
let _m = mockito::mock(
"POST",
mockito::Matcher::Regex(r"/1/batch/(.*)$".to_string()),
)
.with_status(200)
.with_header("content-type", "application/json")
.with_body("[{ \"status\": 202 }]")
.create();
let mut client = Client::new(
Options {
api_host: api_host.to_string(),
..Options::default()
},
Transmission::new(transmission::Options::default()).unwrap(),
);
let mut event = client.new_event();
event.add_field("some_field", Value::String("some_value".to_string()));
event.metadata = Some(json!("some metadata in a string"));
let err = event.send(&mut client).err().unwrap();
assert_eq!(err.kind, ErrorKind::MissingOption);
assert_eq!(
err.message,
"missing option 'api_key', can't send to Honeycomb"
);
client.close().unwrap();
}
}