From 2a04ba3914128c8a0af01060123b249fda1383fb Mon Sep 17 00:00:00 2001 From: Ivan Frolov Date: Mon, 10 Jun 2024 13:32:34 -0400 Subject: [PATCH] docs: added info about Redis --- rpc-server/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/rpc-server/README.md b/rpc-server/README.md index 02e65a28..ba2c408c 100644 --- a/rpc-server/README.md +++ b/rpc-server/README.md @@ -89,6 +89,10 @@ This feature flag enables the shadow data consistency checks. With this feature We encountered a problem with the design of the table `account_access_keys` and overall design of the logic around it. We had to disable the table and proxy the calls of the `query.access_key_list` method to the real NEAR RPC. However, we still aren't ready to get rid of the code and that's why we hid it under the feature flag. We are planning to remove the code in the future and remove the feature flag. +## Redis (Optional) + +Redis is used as an optional dependency when paired with the near_state_indexer feature. To use Redis, you need to specify the REDIS_URL in the .env file and set up a server using docker or `redis-server` command. Redis can be used to cache the state data indexed by the near_state_indexer for faster retrieval and reduced load on the database. + ## Metrics (Prometheus) The read-rpc-server exposes Prometheus-compatible metrics at the `/metrics` endpoint. @@ -113,4 +117,4 @@ For example, method `block` will have these metrics: - `BLOCK_ERROR_1` - `BLOCK_ERROR_2` - `BLOCK_ERROR_3` -- `BLOCK_ERROR_4` \ No newline at end of file +- `BLOCK_ERROR_4`