Rust InfluxDB库

一个用于查询和向InfluxDB发送数据的库。

https://gitlab.com/claudiomattera/rinfluxdb

功能

• 将数据序列化为InfluxDB行协议；
• 在Rust中构建InfluxQL查询；
• 在Rust中构建FLUX查询；
• 解析InfluxDB的响应；
• (可选)基于Reqwest的客户端以执行常见查询。
• 解析InfluxQL查询返回的InfluxDB JSON数据框；
• 解析FLUX查询返回的InfluxDB注释CSV数据框；
• (可选)围绕Reqwest对象构建请求并解析响应的包装器；

将数据序列化为InfluxDB行协议

使用行协议将数据发送到InfluxDB。

use rinfluxdb::line_protocol::LineBuilder;
use chrono::{TimeZone, Utc};

let line = LineBuilder::new("location")
    .insert_field("latitude", 55.383333)
    .insert_field("longitude", 10.383333)
    .insert_tag("city", "Odense")
    .set_timestamp(Utc.ymd(2014, 7, 8).and_hms(9, 10, 11))
    .build();

assert_eq!(line.measurement(), &"location".into());
assert_eq!(line.field("latitude"), Some(&55.383333.into()));
assert_eq!(line.field("longitude"), Some(&10.383333.into()));
assert_eq!(line.tag("city"), Some(&"Odense".into()));
assert_eq!(line.timestamp(), Some(&Utc.ymd(2014, 7, 8).and_hms(9, 10, 11)));

assert_eq!(
    line.to_string(), 
    "location,city=Odense latitude=55.383333,longitude=10.383333 1404810611000000000"
);

在Rust中构建InfluxQL查询

可以使用influxql::QueryBuilder构建InfluxQL查询。

use rinfluxdb::influxql::QueryBuilder;
use chrono::{TimeZone, Utc};

let query = QueryBuilder::from("indoor_environment")
    .field("temperature")
    .field("humidity")
    .start(Utc.ymd(2021, 3, 7).and_hms(21, 0, 0))
    .build();

assert_eq!(
    query.as_ref(),
    "SELECT temperature, humidity \
    FROM indoor_environment \
    WHERE time > '2021-03-07T21:00:00Z'",
);

在Rust中构建FLUX查询

可以使用flux::QueryBuilder构建FLUX查询。

use rinfluxdb::types::Duration;
use rinfluxdb::flux::QueryBuilder;

let query = QueryBuilder::from("telegraf/autogen")
    .range_start(Duration::Minutes(-15))
    .filter(
        r#"r._measurement == "cpu" and
        r._field == "usage_system" and
        r.cpu == "cpu-total""#
    )
    .build();

assert_eq!(
    query.as_ref(),
    r#"from(bucket: "telegraf/autogen")
  |> range(start: -15m)
  |> filter(fn: (r) =>
    r._measurement == "cpu" and
    r._field == "usage_system" and
    r.cpu == "cpu-total"
  )
  |> yield()"#,
);

解析InfluxDB的响应

向InfluxDB发送查询时，它将回复包含数据框列表的JSON或注释CSV内容。此库允许将此类回复解析为用户定义的数据框类型。

数据框必须可以从其名称（一个字符串）、其索引（一个瞬时向量）和其列（列名到值向量的映射）构建。

只要为给定的类型DF（和类型E实现Into<ParseError>）实现了这个特性，解析器就可以用它来构建最终对象。

一个数据框的示例实现是dataframe::DataFrame，但该特性可以为许多其他现有库实现。

解析 InfluxQL 查询返回的 JSON

可以将 InfluxQL 查询的 JSON 响应解析为数据框。

use rinfluxdb::influxql::{ResponseError, StatementResult, from_str};
use rinfluxdb::dataframe::DataFrame;

let input: String = todo!();

let response: Result<Vec<StatementResult<DataFrame>>, ResponseError> =
    from_str(&input);

解析 FLUX 查询返回的带注释的 CSV

可以将 FLUX 查询的带注释 CSV 响应解析。

use rinfluxdb::flux::{ResponseError, from_str};
use rinfluxdb::dataframe::DataFrame;

let input: String = todo!();

let response: Result<DataFrame, ResponseError> = from_str(&input);

(可选) 使用基于 Reqwest 的客户端执行常见查询

上述函数可用于将查询和数据序列化及反序列化为原始文本，并将它们集成到现有应用程序中。作为替代，此库还实现了一个基于 Reqwest 的可选客户端 API，以直接与 InfluxDB 实例交互。提供阻塞和非阻塞客户端，并支持常见查询。

通过 client Cargo 功能启用客户端。

使用 InfluxQL 查询 InfluxDB

# use std::collections::HashMap;
# use url::Url;
#
use rinfluxdb::influxql::QueryBuilder;
use rinfluxdb::influxql::blocking::Client;
use rinfluxdb::dataframe::DataFrame;

let client = Client::new(
    Url::parse("https://example.com/")?,
    Some(("username", "password")),
)?;

let query = QueryBuilder::from("indoor_environment")
    .database("house")
    .field("temperature")
    .field("humidity")
    .build();
let dataframe: DataFrame = client.fetch_dataframe(query)?;
println!("{}", dataframe);

let query = QueryBuilder::from("indoor_environment")
    .database("house")
    .field("temperature")
    .field("humidity")
    .group_by("room")
    .build();
let tagged_dataframes: HashMap<String, DataFrame> = 
    client.fetch_dataframes_by_tag(query, "room")?;
for (tag, dataframe) in tagged_dataframes {
    println!("{}: {}", tag, dataframe);
}

# Ok::<(), rinfluxdb::influxql::ClientError>(())

使用 FLUX 查询 InfluxDB

unimplemented!()

使用行协议将数据发送到 InfluxDB

# use url::Url;
#
use rinfluxdb::line_protocol::LineBuilder;
use rinfluxdb::line_protocol::blocking::Client;

let client = Client::new(
    Url::parse("https://example.com/")?,
    Some(("username", "password")),
)?;

let lines = vec![
    LineBuilder::new("measurement")
        .insert_field("field", 42.0)
        .build(),
    LineBuilder::new("measurement")
        .insert_field("field", 43.0)
        .insert_tag("tag", "value")
        .build(),
];

client.send("database", &lines)?;

# Ok::<(), rinfluxdb::line_protocol::ClientError>(())

(可选) 使用 Reqwest 对象包装器构建请求并解析响应

此 crate 通过 HTTP(s) 与 InfluxDB 实例通信。HTTP 请求和响应的内容必须遵循 InfluxDB 规范和协议，但它们可以被定制，例如通过添加基本身份验证。

为了确保最大限度的自由，构建了一个围绕 Reqwest 的 Client 的小型包装器，以便它可以创建一个已准备好与 InfluxDB 通信的请求构建器。然后，可以将此构建器转换为常规请求构建器并执行。

# use url::Url;
#
use rinfluxdb::influxql::Query;

// Bring into scope the trait implementation
use rinfluxdb::influxql::blocking::InfluxqlClientWrapper;

// Create Reqwest client
let client = reqwest::blocking::Client::new();

// Create InfluxQL request
let base_url = Url::parse("https://example.com")?;
let mut builder = client
    // (this is a function added by the trait above)
    .influxql(&base_url)?
    // (this functions are defined on influxql::RequestBuilder)
    .database("house")
    .query(Query::new("SELECT temperature FROM indoor_temperature"))
    // (this function returns a regular Reqwest builder)
    .into_reqwest_builder();

// Now this is a regular Reqwest builder, and can be customized as usual
if let Some((username, password)) = Some(("username", "password")) {
    builder = builder.basic_auth(username, Some(password));
}

// Create a request from the builder
let request = builder.build()?;

// Execute the request through Reqwest and obtain a response
let response = client.execute(request)?;

# Ok::<(), rinfluxdb::influxql::ClientError>(())

同样，也构建了一个围绕 Reqwest 的 Response 的小型包装器，以便添加一个新功能来解析从它中获取的数据框。

# use std::collections::HashMap;
#
# use url::Url;
#
use rinfluxdb::influxql::Query;

use rinfluxdb::influxql::StatementResult;
use rinfluxdb::influxql::blocking::InfluxqlClientWrapper;
use rinfluxdb::dataframe::DataFrame;

// Bring into scope the trait implementation
use rinfluxdb::influxql::blocking::InfluxqlResponseWrapper;

// Create Reqwest client
let client = reqwest::blocking::Client::new();

// Create InfluxQL request
let base_url = Url::parse("https://example.com")?;
let mut request = client
    .influxql(&base_url)?
    .database("house")
    .query(Query::new("SELECT temperature FROM indoor_temperature"))
    .into_reqwest_builder()
    .build()?;

// Execute the request through Reqwest and obtain a response
let response = client.execute(request)?;

// Return an error if response status is not 200
// (this is a function from Reqwest's response)
let response = response.error_for_status()?;

// Parse the response from JSON to a list of dataframes
// (this is a function added by the trait above)
let results: Vec<StatementResult<DataFrame>> = response.dataframes()?;

# Ok::<(), rinfluxdb::influxql::ClientError>(())

为 Reqwest 的阻塞 API（influxql::blocking::InfluxqlClientWrapper，influxql::blocking::InfluxqlResponseWrapper）和异步 API（influxql::r#async::InfluxqlClientWrapper，influxql::r#async::InfluxqlResponseWrapper）定义了包装器，并通过 client Cargo 功能启用。

用法

此 crate 是一个简单的聚合器，覆盖了较小的 crate，每个 crate 都通过 Cargo 功能启用，并实现 InfluxDB 支持的特定部分。

rinfluxdb
├── rinfluxdb-types
├── rinfluxdb-lineprotocol
├── rinfluxdb-influxql
├── rinfluxdb-flux
└── rinfluxdb-dataframe

客户端可以依赖于 rinfluxdb 并启用必要的功能，或者它们可以显式依赖于 rinfluxdb-* crate。

[dependencies.rinfluxdb]
version = "0.2.0"
features = ["lineprotocol", "influxql", "client"]

# Or

[dependencies]
rinfluxdb-lineprotocol = { version = "0.2.0", features = ["client"] }
rinfluxdb-influxql = { version = "0.2.0", features = ["client"] }

Cargo 功能

此 crate 支持以下 Cargo 功能。

• lineprotocol：重新导出 rinfluxdb-lineprotocol crate；
• influxql：重新导出 rinfluxdb-influxql crate；
• flux：重新导出 rinfluxdb-flux crate；
• dataframe：重新导出 rinfluxdb-dataframe crate；
• client：在所有 rinfluxdb-* crate 中启用 client 功能。

当启用 client 功能时，这些 crate 定义了行协议、InfluxQL 和 Flux 的客户端。客户端使用 Reqwest 实现，并提供阻塞和异步模式。

许可证

版权 Claudio Mattera 2021

您可以在归功于原作者的条件下自由复制、修改和分发此应用程序，具体条款如下：

• Apache License, Version 2.0 (LICENSE-Apache-2.0 或 https://opensource.org/licenses/Apache-2.0)
• MIT许可证（《LICENSE-MIT》或https://opensource.org/licenses/MIT）

根据您的选择。

本项目完全是原创作品，与InfluxData无关，也没有得到InfluxData的任何形式的认可或支持。