Skip to content

Commit

Permalink
feat: ⬆️ Dependencies update
Browse files Browse the repository at this point in the history
  • Loading branch information
fungiboletus committed Aug 13, 2024
1 parent 27203d7 commit 847b2cd
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "rrdcached-client"
version = "0.1.1"
version = "0.1.2"
edition = "2021"
description = "A RRDCached (RRDtool) client library"
license = "Apache-2.0"
Expand All @@ -11,9 +11,9 @@ repository = "https://github.com/SINTEF/rrdcached-client"
include = ["README.md", "LICENSE", "src/*.rs", "Cargo.toml", "Cargo.lock"]

[dependencies]
tokio = { version = "1.36", features = ["full"] }
tokio = { version = "1.39", features = ["full"] }
nom = "7.1"
thiserror = "1.0"

[dev-dependencies]
serial_test = "3.0"
serial_test = "3.1"
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,33 @@ RRDtool databases are time series databases using a round-robin data structure.

While this technology fell out of fashion compared to the more modern time series databases, such as Prometheus or InfluxDB, it is still appreciated because it is simple and works well for some workloads.

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
rrdcached-client = "0.1"
```

## Example

```rust
let mut client = RRDCachedClient::connect_tcp("localhost:42217")
.await?;

create_simple_rrd(&mut client, "hello".to_string()).await;
client.create("hello", &[
RRA::Gauge {
xff: 0.5,
steps: 1,
rows: 10,
}
]).await?;

client.update_one("hello", None, 4.2).await?;
```

## Running a RRDCached server.
## Running a RRDCached server

The repository includes a Dockerfile to quickly run an RRDCached server for testing and development purposes. It listens on localhost:42217 (tcp).

Expand Down Expand Up @@ -50,4 +65,4 @@ As the license says, there is no warranty for this free software. It has been de

The unit and integration test coverage is relatively high, and the library is designed to be safe and robust, thanks to the great Rust ecosystem. But it's a young project, and it must have bugs.

You should probably use a more modern time series database in production. But you may be an RRDTool enthusiast and find this library useful.
You should probably use a more modern time series database in production. But you may be an RRDTool enthusiast and find this library useful.

0 comments on commit 847b2cd

Please sign in to comment.