lukaszraczylo/graphql-monitoring-proxy
1
0
Fork 0
mirror of https://github.com/lukaszraczylo/graphql-monitoring-proxy.git synced 2026-10-12 05:32:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: ground README and landing page in the actual behavior

Browse Source 
An audit against the code found stale defaults, wrong numbers, an
invented error-response example, and capability claims for features that
do not exist (query-complexity limiting, IP-based and per-endpoint rate
limits, config hot-reload).

Correct the env-var defaults, the degraded-retry and keepalive numbers,
and the circuit-open response example. Reframe the cache-key isolation as
a correctness boundary, not an authentication one, because the proxy does
not verify JWT signatures. Document the admin dashboard exposure, the API
key scope, the WebSocket ban and rate-limit checks, and the new
BIND_ADDRESS option.
This commit is contained in:
lukaszraczylo
2026-08-14 13:01:34 +01:00
parent 6171436a99
commit aaa08dfbb2
2 changed files with 74 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/index.html
+9 -15
View File
@@ -6,7 +6,7 @@
<title>GraphQL Monitoring Proxy - High-Performance GraphQL Gateway</title>
<meta
name="description"
content="High-performance GraphQL proxy with monitoring, caching, circuit breaker, rate limiting, and security features. Zero cost monitoring at 100k+ req/s."
content="High-performance GraphQL proxy with monitoring, caching, circuit breaker, rate limiting, and security features. Zero cost monitoring, tested at 30k queries/second."
/>
<script src="https://cdn.tailwindcss.com"></script>
<script>
@@ -179,8 +179,8 @@
<div class="max-w-6xl mx-auto px-4 sm:px-6">
<div class="grid sm:grid-cols-4 gap-4 text-center">
<div class="glass p-6 rounded-xl">
<div class="text-4xl font-bold gradient-text mb-2">100k+</div>
<p class="text-sm text-gray-600 dark:text-gray-400">Requests/second</p>
<div class="text-4xl font-bold gradient-text mb-2">30k+</div>
<p class="text-sm text-gray-600 dark:text-gray-400">Queries/second</p>
</div>
<div class="glass p-6 rounded-xl">
<div class="text-4xl font-bold gradient-text mb-2">10MB</div>
@@ -448,7 +448,7 @@ GMP_ALLOWED_INTROSPECTION="__typename"</code></pre>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i><strong>Read-only mode:</strong> Block all mutations</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i><strong>URL allowlist:</strong> Restrict accessible endpoints</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i><strong>JWT claim extraction:</strong> User ID and role from tokens</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i><strong>API authentication:</strong> Optional X-API-Key for admin endpoints</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i><strong>API authentication:</strong> Optional X-API-Key for the monitoring API only, not the /admin dashboard</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i><strong>Log sanitization:</strong> Automatic redaction of sensitive data</li>
<li class="flex items-start gap-2"><i class="fas fa-check text-green-500 mt-1"></i><strong>SQL injection prevention:</strong> Parameterized queries</li>
</ul>
@@ -516,17 +516,11 @@ GMP_RETRY_BUDGET_MAX_TOKENS=100</code></pre>
<i class="fas fa-triangle-exclamation mr-2 text-orange-500"></i>
Graceful Degradation
</h3>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">Informative error responses with retry recommendations.</p>
<pre class="bg-gray-900 text-gray-100 p-3 rounded-lg text-xs overflow-x-auto"><code>{
"errors": [{
"message": "Backend temporarily unavailable",
"extensions": {
"code": "SERVICE_UNAVAILABLE",
"retryable": true,
"retry_after": 60
}
}]
}</code></pre>
<p class="text-sm text-gray-600 dark:text-gray-400 mb-4">When the circuit is open, the proxy serves a cached response if one is available; otherwise it returns HTTP 503.</p>
<pre class="bg-gray-900 text-gray-100 p-3 rounded-lg text-xs overflow-x-auto"><code>HTTP/1.1 503 Service Unavailable
Content-Type: text/plain
circuit breaker is open</code></pre>
</div>
</div>
</div>