graphql-engine/docs
Phil Freeman 7fffc11077 Caching, Rate Limiting, Metrics & Session Variable Improvements (#376)
* server: use a leaky bucket algorithm for bytes-per-second cache rate limiting

* Use evalsha properly

* Adds redis cache limit parameters to PoliciesConfig

* Loads Leaky Bucket Script On Server Start

* Adds more redis logging and moves cache update into lua script

* reverts setex in lua and adds notes

* Refactors cacheStore and adds max TTL and cache size limits

* Filter session vars in cache key

* WIP

* parens

* cache-clear-hander POC implementation

* cache-clear-hander POC implementation

* Pro projectId used as cache key

* POC working!

* prefixing query-response keys in redis

* Add cacheClearer to RedisScripts

* Partial implementation of cacheClearer from scripts record

* updating tests

* [automated] stylish-haskell commit

* Adds query look with up with metrics script

* Adds missing module and lua script from last commit

* Changes redis script module structure to match cache clearing branch

* minor change to lua script

* cleaning up cache clearing

* generalising JsonLog

* [automated] stylish-haskell commit

* Draft Cache Metrics Endpoint

* Adds Cache Metrics Handler

* Adds hook handler module

* Missed HandlerHook module in last commit

* glob

* Fixes redis mget bug

* Removes cache totals and changes dashes to colons in metric cache keys

* Adds query param to clear clear endpoint for deleting specific keys

* Adds query param to clear clear endpoint for deleting specific keys

* Cache Metrics on query families rather then queries

* Replace Set with nub

* Base16 Redis Hashes

* Query Family Redis Keys With Roles

* response headers for cache keys

* fixing bug in family key by excluding operation name; using hash for response header instead of entire key

* Adds query family to redis cache keys and cache clear endpoint

* Fixes queryfamily hash bug

* Moves cache endpoints to /pro

* Moved cache clear to POST

* Refactors cache clear function

* Fixes query family format bug

* Adds query cache tests and optional --redis-url flag to python test suite

* Adds session variable cache test

* Update pro changelog

* adding documentation for additional caching features

* more docs

* clearing up units of leaky bucket params

* Adds comments to leaky bucket script

* removes old todo

* Fixes session variable filtering to work with new query rootfield

* more advanced defaulting behaviour for bucket rate and capacity.

* Updates Docs

* Moves Role into QueryFamily hash

* Use Aeson for Cache Clear endpoint response

* Moves trace to bracket the leaky bucket script

* Misc review tweaks

* Adds sum type for cache clear query params

* Hardcodes RegisReplyLog log level

* Update docs/graphql/cloud/response-caching.rst

Co-authored-by: Phil Freeman <phil@hasura.io>

* new prose for rate limiting docs

* [automated] stylish-haskell commit

* make rootToSessVarPreds total

* [automated] stylish-haskell commit

* Fixes out of scope error

* Renamed _acRedis to _acCacheStore

Co-authored-by: Solomon Bothwell <ssbothwell@gmail.com>
Co-authored-by: Lyndon Maydwell <lyndon@sordina.net>
Co-authored-by: David Overton <david@hasura.io>
Co-authored-by: Stylish Haskell Bot <stylish-haskell@users.noreply.github.com>
Co-authored-by: Lyndon Maydwell <lyndon@hasura.io>
GitOrigin-RevId: dda5c1a3f902967b3d78310f950541a55fabb1b0
2021-02-13 00:06:18 +00:00
..
_ext docs: fix docs sitemap link generation (#5498) 2020-07-31 21:56:24 +05:30
_static docs: update marketo form 2021-01-12 15:37:34 +00:00
_theme/djangodocs docs: remove posthog tracking script 2021-01-19 10:15:55 +00:00
algolia_index pep8 fixes for python files (#875) 2018-10-30 14:51:58 +05:30
graphql Caching, Rate Limiting, Metrics & Session Variable Improvements (#376) 2021-02-13 00:06:18 +00:00
img docs: favicon change 2021-02-10 08:19:05 +00:00
.gitignore server: support restified versions of graphql queries (#303) 2021-01-29 01:03:35 +00:00
.python-version docs: console / cli / api workflows (close #3593) (#4948) 2020-10-13 11:07:46 +00:00
404.rst docs: move cloud docs (#5411) 2020-08-25 17:23:25 +05:30
conf.py docs: favicon change 2021-02-10 08:19:05 +00:00
CONTRIBUTING.md Fix case of GitHub 2020-11-17 19:29:41 +05:30
index.rst docs: update paths for core and cloud (#5665) 2020-08-25 21:51:21 +05:30
Makefile docs: fix sitemap generation (#5490) 2020-07-31 14:51:13 +05:30
README.md noop: replace subdomain links with subpath (#3869) 2020-02-27 15:43:07 +05:30
requirements.txt docs: bump MarkupSafe version (#4102) 2020-03-13 13:58:54 +05:30

Hasura GraphQL Engine Docs

The documentation accompanying the Hasura GraphQL engine is written with Sphinx and deployed to hasura.io/docs.

Contributing

Check out the contributing guide for more details.

License

The source code in this directory are under MIT License.