Skip to content

Commit ce726e6

Browse files
committed
Update cache plugin docs
1 parent 2dc2557 commit ce726e6

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

plugins/gatewayd-plugin-cache.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
last_modified_date: 2024-05-31 20:16:38
2+
last_modified_date: 2024-09-14 13:37:00
33
layout: default
44
title: gatewayd-plugin-cache
55
description: GatewayD plugin for caching query results in Redis.
@@ -79,12 +79,13 @@ plugins:
7979
- METRICS_ENABLED=True
8080
- METRICS_UNIX_DOMAIN_SOCKET=/tmp/gatewayd-plugin-cache.sock
8181
- METRICS_PATH=/metrics
82+
- API_GRPC_ADDRESS=localhost:19090
8283
- PERIODIC_INVALIDATOR_ENABLED=True
8384
- PERIODIC_INVALIDATOR_INTERVAL=1m
8485
- PERIODIC_INVALIDATOR_START_DELAY=1m
85-
- API_ADDRESS=localhost:18080
8686
- EXIT_ON_STARTUP_ERROR=False
8787
- SENTRY_DSN=https://70eb1abcd32e41acbdfc17bc3407a543@o4504550475038720.ingest.sentry.io/4505342961123328
88+
- CACHE_CHANNEL_BUFFER_SIZE=100
8889
checksum: 3988e10aefce2cd9b30888eddd2ec93a431c9018a695aea1cea0dac46ba91cae
8990
```
9091
@@ -100,12 +101,13 @@ plugins:
100101
| `METRICS_ENABLED` | Whether to enable metrics. | `True` |
101102
| `METRICS_UNIX_DOMAIN_SOCKET` | The path to the Unix domain socket for exposing metrics. This must be accessible to GatewayD. | `/tmp/gatewayd-plugin-cache.sock` |
102103
| `METRICS_PATH` | The path for exposing metrics. | `/metrics` |
104+
| `API_GRPC_ADDRESS` | The address for the GatewayD gRPC API server. | `localhost:19090` |
103105
| `PERIODIC_INVALIDATOR_ENABLED` | Whether to enable periodic cache invalidation. This runs every `PERIODIC_INVALIDATOR_INTERVAL` and removes stale client keys, not cached values. | `True` |
104106
| `PERIODIC_INVALIDATOR_INTERVAL` | The interval for periodic cache invalidation. | `1m` |
105107
| `PERIODIC_INVALIDATOR_START_DELAY` | The delay before starting periodic cache invalidation. | `1m` |
106-
| `API_ADDRESS` | The address for the GatewayD REST API server. | `localhost:18080` |
107108
| `EXIT_ON_STARTUP_ERROR` | Whether to exit the plugin if there is an error during startup. | `False` |
108109
| `SENTRY_DSN` | Sentry DSN. Set to empty string to disable Sentry. | `https://70eb1abcd32e41acbdfc17bc3407a543@o4504550475038720.ingest.sentry.io/4505342961123328` |
110+
| `CACHE_CHANNEL_BUFFER_SIZE` | The buffer size for the cache channel. | `100` |
109111

110112
### Command-line arguments
111113

0 commit comments

Comments
 (0)