Fred
====
[](https://opensource.org/licenses/MIT)
[](https://opensource.org/licenses/Apache-2.0)
[](https://travis-ci.com/aembke/fred.rs)
[](https://crates.io/crates/fred)
[](https://docs.rs/fred)
A high level async Redis client for Rust built on Tokio and Futures.
## Example
```rust
use fred::prelude::*;
#[tokio::main]
async fn main() -> Result<(), RedisError> {
let config = RedisConfig::default();
let policy = ReconnectPolicy::default();
let client = RedisClient::new(config);
// connect to the server, returning a handle to the task that drives the connection
let _ = client.connect(Some(policy));
// wait for the client to connect
let _ = client.wait_for_connect().await?;
println!("Foo: {:?}", client.get("foo").await?);
let _ = client.set("foo", "bar", None, None, false).await?;
println!("Foo: {:?}", client.get("foo".to_owned()).await?);
let _ = client.quit().await?;
Ok(())
}
```
See the [examples](examples/README.md) for more.
## Install
With [cargo edit](https://github.com/killercup/cargo-edit).
```
cargo add fred
```
## Features
* Flexible and generic client interfaces.
* Supports clustered and centralized Redis deployments.
* Optional built-in reconnection logic with multiple backoff policies.
* Publish-Subscribe and keyspace events interfaces.
* Supports transactions.
* Supports Lua scripts.
* Supports streaming results from the `MONITOR` command.
* Supports custom commands provided by third party modules.
* Supports connections over TLS.
* Handles cluster rebalancing operations without downtime or errors.
* Supports various scanning functions.
* Automatically [pipeline](https://redis.io/topics/pipelining) requests, with an option for callers to disable this.
* Automatically retry requests under bad network conditions.
* Support for configuring global settings that can affect performance under different network conditions. Callers can configure backpressure settings, when and how the underlying socket is flushed, and how many times requests are attempted.
* Built-in tracking for network latency and payload size metrics.
* A client pooling interface to round-robin requests among a pool of clients.
* Built in support for [tracing](https://crates.io/crates/tracing).
## Tracing
This crate supports tracing via the [tracing](https://github.com/tokio-rs/tracing) crate. See the [tracing docs](./src/trace/README.md) for more information.
This feature is disabled by default, but callers can opt-in via the `full-tracing` or `partial-tracing` features.
## Logging
To enable logs use the environment variable `RUST_LOG` with a value of `trace`, `debug`, `warn`, `error`, or `info`. See the documentation for [env_logger](http://rust-lang-nursery.github.io/log/env_logger/) for more information.
When a client is initialized it will generate a unique client name with a prefix of `fred-`. This name will appear in all logging statements on the client in order to associate client and server operations if logging is enabled on both.
## Compile Time Features
| enable-tls | x | Enable TLS support. This requires OpenSSL (or equivalent) dependencies. |
| vendored-tls | | Enable TLS support, using vendored OpenSSL (or equivalent) dependencies, if possible. |
| ignore-auth-error | x | Ignore auth errors that occur when a password is supplied but not required. |
| reconnect-on-auth-error | | A NOAUTH error is treated the same as a general connection failure and the client will reconnect based on the reconnection policy. |
| index-map | | Use [IndexMap](https://docs.rs/indexmap/*/indexmap/) instead of [HashMap](https://doc.rust-lang.org/std/collections/struct.HashMap.html) as the backing store for Redis Map types. This is useful for testing and may also be useful for callers. |
| pool-prefer-active | x | Prefer connected clients over clients in a disconnected state when using the `RedisPool` interface. |
| full-tracing | | Enable full [tracing](./src/trace/README.md) support. This can emit a lot of data so a partial tracing feature is also provided. |
| partial-tracing | | Enable partial [tracing](./src/trace/README.md) support, only emitting traces for top level commands and network latency. Note: this has a non-trivial impact on [performance](./bin/pipeline_test/README.md#Examples). |
| blocking-encoding | | Use a blocking task for encoding or decoding frames over a [certain size](./src/globals.rs). This can be useful for clients that send or receive large payloads, but will only work when used with a multi-thread Tokio runtime. |
| network-logs | | Enable TRACE level logging statements that will print out all data sent to or received from the server. |
| custom-reconnect-errors | | Enable an interface for callers to customize the types of errors that should automatically trigger reconnection logic. |
| monitor | | Enable an interface for running the `MONITOR` command. |
## Environment Variables
| FRED_DISABLE_CERT_VERIFICATION | `false` | Disable certificate verification when using TLS features. |
| FRED_DISABLE_HOST_VERIFICATION | `false` | Disable host verification when using TLS features. |
These are environment variables because they're dangerous in production and callers should be forced to surface them in a loud and obvious way.
## Pipelining
The caller can toggle [pipelining](https://redis.io/topics/pipelining) via flags on the `RedisConfig` provided to a client to enable automatic pipelining for commands whenever possible. These settings can drastically affect performance on both the server and client, but further performance tuning may be necessary to avoid issues such as using too much memory on the client or server while buffering commands.
See the global performance tuning functions for more information on how to tune backpressure or other relevant settings related to pipelining.
This module also contains a [separate test application](bin/pipeline_test) that can be used to demonstrate the effects of pipelining. This test application also contains some helpful information on how to use the tracing features.
## ACL & Authentication
Prior to the introduction of ACL commands in Redis version 6 clients would authenticate with a single password. If callers are not using the ACL interface, or using Redis version <=5.x, they should configure the client to automatically authenticate by using the `password` field on the `RedisConfig` and leaving the `username` field as `None`.
If callers are using ACLs and Redis version >=6.x they can configure the client to automatically authenticate by using the `username` and `password` fields on the provided `RedisConfig`.
**It is required that the authentication information provided to the `RedisConfig` allows the client to run `CLIENT SETNAME` and `CLUSTER NODES`.** Callers can still change users via the `auth` command later, but it recommended to instead use the username and password provided to the `RedisConfig` so that the client can automatically authenticate after reconnecting.
If this is not possible callers need to ensure that the default user can run the two commands above. Additionally, it is recommended to move any calls to the `auth` command inside the `on_reconnect` block.
## Customizing Error Handling
The `custom-reconnect-errors` feature enables an interface on the [globals](src/globals.rs) to customize the list of errors that should automatically trigger reconnection logic (if configured).
In many cases applications respond to Redis errors by logging the error, maybe waiting and reconnecting, and then trying again. Whether to do this often depends on [the prefix](https://github.com/redis/redis/blob/unstable/src/server.c#L2506-L2538) in the error message, and this interface allows callers to specify which errors should be handled this way.
Errors that trigger this can be seen with the [on_error](https://docs.rs/fred/*/fred/client/struct.RedisClient.html#method.on_error) function.
## Tests
To run the unit and integration tests:
```
cargo test -- --test-threads=1
```
OR
```
# run the tests with default features
./tests/run.sh
```
OR
```
# run the tests 3 times, once with default features, once with no features, and once with all features (except chaos monkey)
./tests/run_all.sh
```
Note: a local Redis server must be running on port 6379, and a clustered deployment must be running on ports 30001 - 30006 for the integration tests to pass.
Scripts are included to download and run centralized and clustered redis servers at any Redis version. These scripts will not make any modifications to your system outside the `tests/tmp` folder.
```
export REDIS_VERSION=6.2.2
./tests/scripts/install_redis_centralized.sh
./tests/scripts/install_redis_clustered.sh
```
**Beware: the tests will periodically run `flushall`.**
## Contributing
See the [contributing](CONTRIBUTING.md) documentation for info on adding new commands.