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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
#[cfg(feature = "async-std")]
use async_std::task::spawn_blocking;
use bytes::Bytes;
use flate2::{write::GzEncoder, Compression};
use futures::Stream;
use reqwest::header;
use serde::Serialize;
use std::{
env, fmt::Debug as FmtDebug, io::Write, result::Result as StdResult,
time::Duration as StdDuration,
};
#[cfg(feature = "tokio")]
use tokio::task::spawn_blocking;
use tokio_stream::StreamExt;
use tracing::instrument;
use crate::{
datasets::{
self, ContentEncoding, ContentType, IngestStatus, LegacyQuery, LegacyQueryOptions,
LegacyQueryResult, Query, QueryOptions, QueryParams, QueryResult,
},
error::{Error, Result},
http::{self, HeaderMap},
is_personal_token, users,
};
static API_URL: &str = "https://api.axiom.co";
#[derive(Debug, Clone)]
pub struct Client {
http_client: http::Client,
url: String,
pub datasets: datasets::Client,
pub users: users::Client,
}
impl Client {
pub fn new() -> Result<Self> {
Self::builder().build()
}
pub fn builder() -> Builder {
Builder::new()
}
#[doc(hidden)]
pub fn url(&self) -> String {
self.url.clone()
}
pub async fn version(&self) -> String {
env!("CARGO_PKG_VERSION").to_string()
}
#[instrument(skip(self, opts))]
pub async fn query<S, O>(&self, apl: S, opts: O) -> Result<QueryResult>
where
S: Into<String> + FmtDebug,
O: Into<Option<QueryOptions>>,
{
let (req, query_params) = match opts.into() {
Some(opts) => {
let req = Query {
apl: apl.into(),
start_time: opts.start_time,
end_time: opts.end_time,
};
let query_params = QueryParams {
no_cache: opts.no_cache,
save: opts.save,
format: opts.format,
};
(req, query_params)
}
None => (
Query {
apl: apl.into(),
..Default::default()
},
QueryParams::default(),
),
};
let query_params = serde_qs::to_string(&query_params)?;
let path = format!("/v1/datasets/_apl?{}", query_params);
let res = self.http_client.post(path, &req).await?;
let saved_query_id = res
.headers()
.get("X-Axiom-History-Query-Id")
.map(|s| s.to_str())
.transpose()
.map_err(|_e| Error::InvalidQueryId)?
.map(|s| s.to_string());
let mut result = res.json::<QueryResult>().await?;
result.saved_query_id = saved_query_id;
Ok(result)
}
#[instrument(skip(self, opts))]
#[deprecated(
since = "0.6.0",
note = "The legacy query will be removed in future versions, use `apl_query` instead"
)]
pub async fn query_legacy<N, O>(
&self,
dataset_name: N,
query: LegacyQuery,
opts: O,
) -> Result<LegacyQueryResult>
where
N: Into<String> + FmtDebug,
O: Into<Option<LegacyQueryOptions>>,
{
let path = format!(
"/v1/datasets/{}/query?{}",
dataset_name.into(),
&opts
.into()
.map(|opts| { serde_qs::to_string(&opts) })
.unwrap_or_else(|| Ok(String::new()))?
);
let res = self.http_client.post(path, &query).await?;
let saved_query_id = res
.headers()
.get("X-Axiom-History-Query-Id")
.map(|s| s.to_str())
.transpose()
.map_err(|_e| Error::InvalidQueryId)?
.map(|s| s.to_string());
let mut result = res.json::<LegacyQueryResult>().await?;
result.saved_query_id = saved_query_id;
Ok(result)
}
#[instrument(skip(self, events))]
pub async fn ingest<N, I, E>(&self, dataset_name: N, events: I) -> Result<IngestStatus>
where
N: Into<String> + FmtDebug,
I: IntoIterator<Item = E>,
E: Serialize,
{
let json_lines: Result<Vec<Vec<u8>>> = events
.into_iter()
.map(|event| serde_json::to_vec(&event).map_err(Error::Serialize))
.collect();
let json_payload = json_lines?.join(&b"\n"[..]);
let payload = spawn_blocking(move || {
let mut gzip_payload = GzEncoder::new(Vec::new(), Compression::default());
gzip_payload.write_all(&json_payload)?;
gzip_payload.finish()
})
.await;
#[cfg(feature = "tokio")]
let payload = payload.map_err(Error::JoinError)?;
let payload = payload.map_err(Error::Encoding)?;
self.ingest_bytes(
dataset_name,
payload,
ContentType::NdJson,
ContentEncoding::Gzip,
)
.await
}
#[instrument(skip(self, payload))]
pub async fn ingest_bytes<N, P>(
&self,
dataset_name: N,
payload: P,
content_type: ContentType,
content_encoding: ContentEncoding,
) -> Result<IngestStatus>
where
N: Into<String> + FmtDebug,
P: Into<Bytes>,
{
let mut headers = HeaderMap::new();
headers.insert(header::CONTENT_TYPE, content_type.into());
headers.insert(header::CONTENT_ENCODING, content_encoding.into());
self.http_client
.post_bytes(
format!("/v1/datasets/{}/ingest", dataset_name.into()),
payload,
headers,
)
.await?
.json()
.await
}
#[instrument(skip(self, stream))]
pub async fn ingest_stream<N, S, E>(&self, dataset_name: N, stream: S) -> Result<IngestStatus>
where
N: Into<String> + FmtDebug,
S: Stream<Item = E> + Send + Sync + 'static,
E: Serialize,
{
let dataset_name = dataset_name.into();
let mut chunks = Box::pin(stream.chunks_timeout(1000, StdDuration::from_secs(1)));
let mut ingest_status = IngestStatus::default();
while let Some(events) = chunks.next().await {
let new_ingest_status = self.ingest(dataset_name.clone(), events).await?;
ingest_status = ingest_status + new_ingest_status
}
Ok(ingest_status)
}
#[instrument(skip(self, stream))]
pub async fn try_ingest_stream<N, S, I, E>(
&self,
dataset_name: N,
stream: S,
) -> Result<IngestStatus>
where
N: Into<String> + FmtDebug,
S: Stream<Item = StdResult<I, E>> + Send + Sync + 'static,
I: Serialize,
E: std::error::Error + Send + Sync + 'static,
{
let dataset_name = dataset_name.into();
let mut chunks = Box::pin(stream.chunks_timeout(1000, StdDuration::from_secs(1)));
let mut ingest_status = IngestStatus::default();
while let Some(events) = chunks.next().await {
let events: StdResult<Vec<I>, E> = events.into_iter().collect();
match events {
Ok(events) => {
let new_ingest_status = self.ingest(dataset_name.clone(), events).await?;
ingest_status = ingest_status + new_ingest_status
}
Err(e) => return Err(Error::IngestStreamError(Box::new(e))),
}
}
Ok(ingest_status)
}
}
pub struct Builder {
env_fallback: bool,
url: Option<String>,
token: Option<String>,
org_id: Option<String>,
}
impl Builder {
fn new() -> Self {
Self {
env_fallback: true,
url: None,
token: None,
org_id: None,
}
}
pub fn no_env(mut self) -> Self {
self.env_fallback = false;
self
}
pub fn with_token<S: Into<String>>(mut self, token: S) -> Self {
self.token = Some(token.into());
self
}
#[doc(hidden)]
pub fn with_url<S: Into<String>>(mut self, url: S) -> Self {
self.url = Some(url.into());
self
}
pub fn with_org_id<S: Into<String>>(mut self, org_id: S) -> Self {
self.org_id = Some(org_id.into());
self
}
pub fn build(self) -> Result<Client> {
let env_fallback = self.env_fallback;
let mut token = self.token.unwrap_or_default();
if token.is_empty() && env_fallback {
token = env::var("AXIOM_TOKEN").unwrap_or_default();
}
if token.is_empty() {
return Err(Error::MissingToken);
}
let mut url = self.url.unwrap_or_default();
if url.is_empty() && env_fallback {
url = env::var("AXIOM_URL").unwrap_or_default();
}
if url.is_empty() {
url = API_URL.to_string();
}
let mut org_id = self.org_id.unwrap_or_default();
if org_id.is_empty() && env_fallback {
org_id = env::var("AXIOM_ORG_ID").unwrap_or_default();
};
if url == API_URL && org_id.is_empty() && is_personal_token(&token) {
return Err(Error::MissingOrgId);
}
let http_client = http::Client::new(url.clone(), token, org_id)?;
Ok(Client {
http_client: http_client.clone(),
url,
datasets: datasets::Client::new(http_client.clone()),
users: users::Client::new(http_client),
})
}
}