Skip to content

Commit

Permalink
docs: added info about Redis
Browse files Browse the repository at this point in the history
  • Loading branch information
frolvanya committed Jun 10, 2024
1 parent 1a6c04a commit 2a04ba3
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion rpc-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -113,4 +117,4 @@ For example, method `block` will have these metrics:
- `BLOCK_ERROR_1`
- `BLOCK_ERROR_2`
- `BLOCK_ERROR_3`
- `BLOCK_ERROR_4`
- `BLOCK_ERROR_4`

0 comments on commit 2a04ba3

Please sign in to comment.