Document chproxy caching TTL configuration #581
Draft
+496
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds comprehensive documentation for chproxy's query caching TTL configuration. The
expireparameter undercachescontrols cache lifetime but was not well documented.Created documentation:
CACHING_TTL.md- Full guide covering TTL configuration, implementation details, best practicesCACHING_TTL_QUICK_REFERENCE.md- Fast lookup table with common TTL values by use caseconfig/examples/cache_ttl_examples.yml- 7 cache configurations demonstrating different TTL patterns (10s, 5m, 1h, 24h, 7d)config/examples/simple_cache_ttl_test.yml- Minimal working exampleUpdated:
README.md- Added key features section linking to caching documentationKey information documented:
expire: <duration>is required (no default)10s,5m,1h,24h,7d)Example configuration:
Pull request type
Checklist
Does this introduce a breaking change?
Further comments
Documentation-only change. All example configurations validated against chproxy config parser.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
127.12.0.10/tmp/go-build2516421963/b305/cache.test /tmp/go-build2516421963/b305/cache.test -test.testlogfile=/tmp/go-build2516421963/b305/testlog.txt -test.paniconexit0 -test.timeout=10m0s /tmp/go-build2516421963/b224/vet.cfg cgo -I ux_amd64/asm --gdwarf-5 --64 -o ux_amd64/asm -I g_.a -I ux_amd64/compile-c=4 --gdwarf-5 --64 -o ux_amd64/compile-buildtags(packet block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.