Skip to content

Commit 8beeaf3

Browse files
amnnabhinavg6
andauthored
docs: graphql config updates (#24423)
## Description Clarifications on how GraphQL Alt is configured. ## Test plan :eyes: --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] gRPC: - [ ] JSON-RPC: - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK: - [ ] Indexing Framework: --------- Co-authored-by: Abhinav Garg <[email protected]>
1 parent fda4bef commit 8beeaf3

File tree

2 files changed

+45
-6
lines changed

2 files changed

+45
-6
lines changed

docs/content/guides/operator/indexer-stack-setup.mdx

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ Multiple `--indexer-config` parameters can be provided, one for each general-pur
340340

341341
| CLI parameter | Description |
342342
|----------------------------------|------------------------------------------------------------------------------------|
343-
| `CONFIG_FILE` | Path to GraphQL RPC server configuration file |
343+
| `CONFIG_FILE` | Path to the optional GraphQL RPC server configuration file |
344344
| `INDEXER_CONFIG_FILE` | Path to general-purpose indexer configuration file; can be set multiple times for different pipelines |
345345
| `LEDGER_GRPC_URL` | URL to Archival service's `LedgerService` gRPC API |
346346
| `CONSISTENT_STORE_URL` | URL to [Consistent store](#consistent-store-setup) API |
@@ -365,13 +365,21 @@ sui-indexer-alt-graphql rpc \
365365
--fullnode-rpc-url https://localhost:9000
366366
```
367367

368-
### Configuration recommendations
368+
### Generating Configuration
369369

370-
The default GraphQL RPC configuration is provided in the `examples` directory of the Sui repo.
370+
You can run the GraphQL RPC server without a configuration file, which will use default values. To customize settings, generate a config file using the command below and edit it as needed:
371371

372-
<ImportContent source="/examples/prod-config/graphql.toml" mode="code" />
373-
|-----------------------------------------------------------------------------------------------|-----------------------------------|
374-
| [`graphql.toml`](https://github.com/MystenLabs/sui/blob/main/examples/prod-config/graphql.toml) | Default GraphQL API configuration |
372+
```sh
373+
374+
sui-indexer-alt-graphql generate-config > <PATH_TO_GRAPHQL_CONFIG_FILE>
375+
```
376+
377+
It will produce output similar to the following:
378+
379+
<details>
380+
<summary>`graphql.toml`</summary>
381+
<ImportContent source="examples/prod-config/graphql.toml" mode="code" />
382+
</details>
375383

376384
## Related links
377385

examples/prod-config/graphql.toml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,36 @@
11
[limits]
2+
mutation-timeout-ms = 74000
3+
query-timeout-ms = 40000
4+
max-query-depth = 20
5+
max-query-nodes = 300
6+
max-output-nodes = 1000000
7+
max-tx-payload-size = 174763
8+
max-query-payload-size = 5000
9+
default-page-size = 20
10+
max-page-size = 50
11+
max-multi-get-size = 200
12+
page-size-override-fx-object-changes = 1024
13+
page-size-override-packages = 200
14+
max-type-argument-depth = 16
15+
max-type-argument-width = 32
16+
max-type-nodes = 256
17+
max-move-value-depth = 128
18+
max-move-value-bound = 1048576
19+
max-display-field-depth = 10
20+
max-display-output-size = 1048576
21+
max-disassembled-module-size = 1048576
222

323
[health]
24+
max-checkpoint-lag-ms = 300000
25+
26+
[name-service]
27+
package-address = "0xd22b24490e0bae52676651b4f56660a5ff8022a2576e0089f79b3c88d44e08f0"
28+
registry-id = "0xe64cd9db9f829c6cc405d9790bd71567ae07259855f4fba6f02c84f52298c106"
29+
reverse-registry-id = "0x2fd099e17a292d2bc541df474f9fafa595653848cbabb2d7a4656ec786a1969f"
430

531
[watermark]
32+
watermark-polling-interval-ms = 500
33+
34+
[zklogin]
35+
env = "Prod"
36+
max-epoch-upper-bound-delta = 30

0 commit comments

Comments
 (0)