Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d-led/influxdb-cpp-rest
Simple C++ InfluxDB client via MS C++ REST SDK + RxCpp for batching (Windows/OSX/Linux) + a C wrapper
https://github.com/d-led/influxdb-cpp-rest
batching c client cpp cross-platform influxdb rxcpp time-series
Last synced: 5 days ago
JSON representation
Simple C++ InfluxDB client via MS C++ REST SDK + RxCpp for batching (Windows/OSX/Linux) + a C wrapper
- Host: GitHub
- URL: https://github.com/d-led/influxdb-cpp-rest
- Owner: d-led
- License: mpl-2.0
- Created: 2016-10-28T21:14:05.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-06-01T08:56:13.000Z (over 1 year ago)
- Last Synced: 2024-08-02T07:10:05.130Z (3 months ago)
- Topics: batching, c, client, cpp, cross-platform, influxdb, rxcpp, time-series
- Language: Makefile
- Homepage:
- Size: 2.78 MB
- Stars: 44
- Watchers: 4
- Forks: 27
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-influxdb - influxdb-cpp-rest - A C++ InfluxDB client with a batching async interface (Client libraries / Unofficial)
README
# influxdb-cpp-rest
Status: archive as the build & dependenies are out of date
[](https://ci.appveyor.com/project/d-led/influxdb-cpp-rest/branch/master) [](https://travis-ci.org/d-led/influxdb-cpp-rest)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fd-led%2Finfluxdb-cpp-rest?ref=badge_shield)
A naive C++(14) [InfluxDB](https://www.influxdata.com/time-series-platform/influxdb/) client via [C++ REST SDK](https://github.com/Microsoft/cpprestsdk) + a C wrapper of the asynchronous API as a shared library.
See [the demo source](src/demo/main.cpp) for the current api example.
The unbatched aprroach (and without connection reuse) may not be sufficient in some situations, as without batching, about 200 lines/sec can be inserted.
A batching api leans towards thousands inserts per second. Behind the scenes, the API uses [RxCpp](https://github.com/Reactive-Extensions/RxCpp) and [cppformat](https://github.com/fmtlib/fmt).
## Status
- Build and test ok on Win10/Ubuntu64/OSX.
- Feel free to contribute, as the progress is rather sporadic due to lack of spare time.
- tested with InfluxDB v1.2.4, v1.7.5, v1.7.6
## Synchronous insertion
```cpp
influxdb::api::simple_db simpledb("http://localhost:8086", "my_db");
db.insert(
line("log", key_value_pairs("my_tag", 42L), key_value_pairs("value", "hello world!")));
```
## Asynchronous insertion
The asynchronous API inserts the points on an active object with automatic batching, thus increasing throughput.
```cpp
influxdb::async_api::simple_db asyncdb("http://localhost:8086", "my_db");
for (int i = 0; i < 123456; i++) {
asyncdb.insert(
line(
"my_measurements",
key_value_pairs("my_count", i % MAX_VALUES_PER_TAG),
key_value_pairs("value", "hi!")
));
}
```
## C API
see [async_c_test.cpp](src/test-shared/async_c_test.cpp) and the related headers.
## Timestamps
Timestamps can be added as the last parameter to the `line` constructor, and only need to return
a serializable value on `TTimestamp::now()`. There is a default `std::chrono`-based implementation:
```cpp
line(
"my_measurements",
key_value_pairs("my_count", i % MAX_VALUES_PER_TAG),
key_value_pairs("value", "hi!"),
default_timestamp()
// ^^^^^^^^^^^^^^^^^^^
)
```
`MAX_VALUES_PER_TAG` for demo purposes here, as there [is such a maximum](https://docs.influxdata.com/influxdb/v1.4/administration/config#max-values-per-tag-100000) and it has to be observed by the clients.
## Multiple lines in synchronous API
Add lines using the `()` operator on the line:
```cpp
line
("multiple", key_value_pairs("v1", 1), key_value_pairs())
("multiple", key_value_pairs("v2", 2), key_value_pairs())
```
## Query
```cpp
influxdb::raw::db_utf8 raw_db("http://localhost:8086", "my_db");
auto query = std::string("select count(*) from my_db..my_measurements");
auto json_response = raw_db.get(query);
```
↓
```
{"results":[{"series":[{"name":"asynctest","columns":["time","count_value"],"values":[["...Z",123456]]}]}]}
```
## Authentication
Basic authentication can be used with all API variants
```cpp
influxdb::raw::db_utf8 raw_db("http://localhost:8086", "my_db");
raw_db.with_authentication(username, password);
auto query = ...
```
## Error Handling
- Synchronous C++ API will throw exceptions on HTTP errors
- Asynchronous APIs will drop inserts on HTTP errors and print to `stderr`
- C api tries to catch CPP exceptions and
- print exceptions to `stderr`
- return non-zero `int` or `nullptr` where sensible
- Open issue: [#18](https://github.com/d-led/influxdb-cpp-rest/issues/18)
## Build & Test
The library should be easy to build, given `RxCpp` and `cpprestsdk` can be found. The Visual Studio 2015 solution is self-contained. A locally running, authentication-free instance of InfluxDB is required to run the test.
### Dependencies on Linux and OS X
cpprestsdk needs to be built and available, which in turn has platform-specific transient dependencies.
The easiest way to install it on MacOS X and Linux turned out to be via [Homebrew](https://brew.sh) and [Linuxbrew](https://linuxbrew.sh) respectively.
Once the install `brew install cpprestsdk` succeeds, build: `make -C build//gmake config=release_x64` and run the test.
If the build fails due to failed dependencies, check [premake5.lua](premake5.lua) for the build config, and regenerate makefiles if necessary via `premake/premake5 gmake`
## Thanks to
- @kirkshoop for indispensable help with [RxCpp](https://github.com/Reactive-Extensions/RxCpp)
- @nikkov for pointing out the missing essential features
- @promgamer, @garaemon for the identifiers PRs
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fd-led%2Finfluxdb-cpp-rest?ref=badge_large)