Skip to content

docs: document log store configuration via [log_store] - #6739

Open
mikeua wants to merge 1 commit into
graphprotocol:masterfrom
mikeua:docs-log-store-toml-config
Open

mikeua wants to merge 1 commit into
graphprotocol:masterfrom
mikeua:docs-log-store-toml-config

Conversation

@mikeua

@mikeua mikeua commented Oct 13, 2026

Copy link
Copy Markdown

docs/log-store.md and the "Log Store Configuration" section of docs/environment-variables.md describe --log-store-* CLI flags and GRAPH_LOG_STORE_* environment variables (plus "deprecated" GRAPH_ELASTICSEARCH_* aliases). None of these exist: node/src/opt.rs has no such flags, nothing reads those variables, and per #6278 the log store is configured only through the [log_store] section of the TOML config (LogStoreSection in node/src/config.rs). Someone following the guide today gets no log store and no error.

Changes:

  • Replace every backend's CLI/env-var examples with [log_store] TOML examples.
  • Replace the "Environment Variables / CLI Arguments / Configuration Precedence" section with a table of the actual [log_store] keys, their backends and defaults (index = "subgraph", timeout_secs = 10, retention_hours = 0), and a short migration note for the removed --elasticsearch-* flags / ELASTICSEARCH_* variables.
  • Drop the nonexistent file MAX_SIZE / RETENTION_DAYS options; the file backend only has retention_hours.
  • Document Loki username/password, which the code supports but the guide didn't mention.
  • Since graphql, graph: Error on _logs query when log store disabled #6637, _logs returns a NotSupported error when no store is configured, not empty results; update the two places in the guide that said otherwise, and the matching startup info! message in node/src/launcher.rs.
  • Update the troubleshooting entries that pointed at the nonexistent variables.

Docs-only apart from the one log message string.

The log store guide and the environment variable reference described
--log-store-* flags and GRAPH_LOG_STORE_* environment variables that do
not exist; the log store is only configurable through the [log_store]
section of the TOML config (graphprotocol#6278). Replace those examples with TOML,
document every [log_store] key with its defaults, drop the nonexistent
max-size/retention-days options in favour of retention_hours, and note
that _logs returns a NotSupported error when no store is configured
(graphprotocol#6637). Also update the matching startup message.
@mikeua
mikeua force-pushed the docs-log-store-toml-config branch from adae6fd to 5f7be1f Compare October 13, 2026 15:59

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant