influxdb2 0.5.2

Influxdb 2 client library for rust
Documentation 
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

//! Write API

use crate::models::WriteDataPoint;
use crate::{Client, Http, RequestError, ReqwestProcessing};

use bytes::BufMut;
use futures::{Stream, StreamExt};
use reqwest::header::HeaderMap;
use reqwest::{Body, Method, StatusCode};
use snafu::ResultExt;
use std::io::{self, Write};

impl Client {
    /// Write line protocol data to the specified organization and bucket.
    /// This method writes with default timestamp precision (nanoseconds).
    /// Use write_line_protocol_with_precision if you want to write with a different precision.
    pub async fn write_line_protocol(
        &self,
        org: &str,
        bucket: &str,
        body: impl Into<Body> + Send,
    ) -> Result<(), RequestError> {
        self.write_line_protocol_with_precision(org, bucket, body, TimestampPrecision::Nanoseconds)
            .await
    }

    /// Write line protocol data to the specified organization and bucket.
    pub async fn write_line_protocol_with_precision(
        &self,
        org: &str,
        bucket: &str,
        body: impl Into<Body> + Send,
        precision: TimestampPrecision,
    ) -> Result<(), RequestError> {
        self.write_line_protocol_with_precision_headers(
            org,
            bucket,
            body,
            precision,
            HeaderMap::new(),
        )
        .await
    }

    async fn write_line_protocol_with_precision_headers(
        &self,
        org: &str,
        bucket: &str,
        body: impl Into<Body> + Send,
        precision: TimestampPrecision,
        headers: HeaderMap,
    ) -> Result<(), RequestError> {
        let body = body.into();
        let write_url = self.url("/api/v2/write");

        let response = self
            .request(Method::POST, &write_url)
            .headers(headers)
            .query(&[
                ("bucket", bucket),
                ("org", org),
                ("precision", precision.api_short_name()),
            ])
            .body(body)
            .send()
            .await
            .context(ReqwestProcessing)?;

        if response.status() != StatusCode::NO_CONTENT {
            let status = response.status();
            let text = response.text().await.context(ReqwestProcessing)?;
            Http { status, text }.fail()?;
        }

        Ok(())
    }

    /// Write a `Stream` of `DataPoint`s to the specified bucket.
    ///
    /// This method writes with default timestamp precision (nanoseconds).
    /// Use write_with_precision if you want to write with a different precision.
    pub async fn write(
        &self,
        bucket: &str,
        body: impl Stream<Item = impl WriteDataPoint> + Send + Sync + 'static,
    ) -> Result<(), RequestError> {
        self.write_with_precision(bucket, body, TimestampPrecision::Nanoseconds)
            .await
    }

    /// Write a `Stream` of `DataPoint`s to the specified organization and
    /// bucket.
    pub async fn write_with_precision(
        &self,
        bucket: &str,
        body: impl Stream<Item = impl WriteDataPoint> + Send + Sync + 'static,
        timestamp_precision: TimestampPrecision,
    ) -> Result<(), RequestError> {
        let mut buffer = bytes::BytesMut::new();

        let body = body.map(move |point| {
            let mut w = (&mut buffer).writer();
            point.write_data_point_to(&mut w)?;
            w.flush()?;
            Ok::<_, io::Error>(buffer.split().freeze())
        });

        #[cfg(feature = "gzip")]
        {
            use crate::Compression;
            use async_compression::tokio::bufread::GzipEncoder;
            use async_compression::Level;
            use reqwest::header::HeaderValue;
            use tokio_util::io::{ReaderStream, StreamReader};

            match self.compression {
                Compression::Gzip => {
                    let encoder = GzipEncoder::with_quality(StreamReader::new(body), Level::Best);
                    let body: Body = Body::wrap_stream(ReaderStream::new(encoder));

                    let mut headers = HeaderMap::new();
                    headers.insert("Content-Encoding", HeaderValue::from_static("gzip"));

                    return self
                        .write_line_protocol_with_precision_headers(
                            &self.org,
                            bucket,
                            body,
                            timestamp_precision,
                            headers,
                        )
                        .await;
                }
                Compression::None => {
                    // fall through
                }
            }
        }
        let body: Body = Body::wrap_stream(body);

        self.write_line_protocol_with_precision(&self.org, bucket, body, timestamp_precision)
            .await
    }
}

/// Possible timestamp precisions.
#[derive(Debug, PartialEq, Copy, Clone)]
pub enum TimestampPrecision {
    /// Seconds timestamp precision
    Seconds,
    /// Milliseconds timestamp precision
    Milliseconds,
    /// Microseconds timestamp precision
    Microseconds,
    /// Nanoseconds timestamp precision
    Nanoseconds,
}

impl TimestampPrecision {
    fn api_short_name(&self) -> &str {
        match self {
            Self::Seconds => "s",
            Self::Milliseconds => "ms",
            Self::Microseconds => "us",
            Self::Nanoseconds => "ns",
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::models::DataPoint;
    use futures::stream;
    use mockito::mock;

    #[tokio::test]
    async fn writing_points() {
        let org = "some-org";
        let bucket = "some-bucket";
        let token = "some-token";

        let mock_server = mock(
            "POST",
            format!("/api/v2/write?bucket={}&org={}&precision=ns", bucket, org).as_str(),
        )
        .match_header("Authorization", format!("Token {}", token).as_str())
        .match_body(
            "\
cpu,host=server01 usage=0.5
cpu,host=server01,region=us-west usage=0.87
",
        )
        .with_status(204)
        .create();

        let client = Client::new(mockito::server_url(), org, token);

        let points = vec![
            DataPoint::builder("cpu")
                .tag("host", "server01")
                .field("usage", 0.5)
                .build()
                .unwrap(),
            DataPoint::builder("cpu")
                .tag("host", "server01")
                .tag("region", "us-west")
                .field("usage", 0.87)
                .build()
                .unwrap(),
        ];

        // If the requests made are incorrect, Mockito returns status 501 and `write`
        // will return an error, which causes the test to fail here instead of
        // when we assert on mock_server. The error messages that Mockito
        // provides are much clearer for explaining why a test failed than just
        // that the server returned 501, so don't use `?` here.
        let result = client.write(bucket, stream::iter(points)).await;
        mock_server.assert();
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn writing_points_with_precision() {
        let org = "some-org";
        let bucket = "some-bucket";
        let token = "some-token";

        let mock_server = mock(
            "POST",
            format!("/api/v2/write?bucket={}&org={}&precision=s", bucket, org).as_str(),
        )
        .match_header("Authorization", format!("Token {}", token).as_str())
        .match_body(
            "\
cpu,host=server01 usage=0.5 1671095854
",
        )
        .with_status(204)
        .create();

        let client = Client::new(mockito::server_url(), org, token);

        let point = DataPoint::builder("cpu")
            .tag("host", "server01")
            .field("usage", 0.5)
            .timestamp(1671095854)
            .build()
            .unwrap();
        let points = vec![point];

        // If the requests made are incorrect, Mockito returns status 501 and `write`
        // will return an error, which causes the test to fail here instead of
        // when we assert on mock_server. The error messages that Mockito
        // provides are much clearer for explaining why a test failed than just
        // that the server returned 501, so don't use `?` here.
        let result = client
            .write_with_precision(bucket, stream::iter(points), TimestampPrecision::Seconds)
            .await;
        mock_server.assert();
        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn status_code_correctly_interpreted() {
        let org = "org";
        let token = "token";
        let bucket = "bucket";

        let make_mock_server = |status| {
            mock(
                "POST",
                format!("/api/v2/write?bucket={}&org={}&precision=ns", bucket, org).as_str(),
            )
            .with_status(status)
            .create()
        };

        let write_with_status = |status| async move {
            let mock_server = make_mock_server(status);
            let client = Client::new(mockito::server_url(), org, token);
            let points: Vec<DataPoint> = vec![];
            let res = client.write(bucket, stream::iter(points)).await;
            mock_server.assert();
            res
        };

        // success status
        assert!(write_with_status(204).await.is_ok());

        // failing status
        for status in [200, 201, 400, 401, 404, 413, 429, 500, 503] {
            assert!(write_with_status(status).await.is_err());
        }
    }
}