graphql-monitoring-proxy/README.md

graphql monitoring proxy

Creates a passthrough proxy to a graphql endpoint(s), allowing you for analysis of the queries and responses, producing the prometheus metrics at a fraction of the cost - because as we know - $0 is a fair price.

This project is in active use by telegram-bot.app, and was tested with 30k queries per second on a single instance, consuming 10mb of RAM and 0.1% CPU.

You can find the example of the kubernetes manifest in the example deployment file.

Why this project exists

I wanted to monitor the queries and responses of our graphql endpoint, but we didn't want to pay the price of the graphql server itself ( and I will not point fingers and certain well-known project), as monitoring and basic security features should be a common, free functionality.

Endpoints

• :8080/v1/graphql - the graphql endpoint
• :9393/metrics - the prometheus metrics endpoint
• :8080/healthz - the healthcheck endpoint

Features

Category	Detail
MONITORING	Prometheus / VictoriaMetrics metrics
MONITORING	Extracting user id from JWT token and adding it as a label to metrics
MONITORING	Extracting the query name and type and adding it as a label to metrics
MONITORING	Calculating the query duration and adding it to the metrics
SPEED	Caching the queries, together with per-query cache and TTL
SECURITY	Blocking schema introspection
SECURITY	Rate limiting queries based on user role
SECURITY	Blocking mutations in read only mode

Configuration

Parameter	Description	Default Value
MONITORING_PORT	The port to expose the metrics endpoint	9393
PORT_GRAPHQL	The port to expose the graphql endpoint	8080
HOST_GRAPHQL	The host to proxy the graphql endpoint	http://localhost/v1/graphql
JWT_USER_CLAIM_PATH	Path to the user claim in the JWT token	``
JWT_ROLE_CLAIM_PATH	Path to the role claim in the JWT token	``
JWT_ROLE_RATE_LIMITING	Enable request rate limiting based on role	false
ENABLE_GLOBAL_CACHE	Enable the cache	false
CACHE_TTL	The cache TTL	60
LOG_LEVEL	The log level	info
BLOCK_SCHEMA_INTROSPECTION	Blocks the schema introspection	false
ENABLE_ACCESS_LOG	Enable the access log	false
READ_ONLY_MODE	Enable the read only mode	false

Caching

Cache engine is enabled in background as it does not use any additional resources. You can then start using the cache by setting the ENABLE_GLOBAL_CACHE environment variable to true - which will enable the cache for all queries, without introspection of the query. You can leave the global cache disabled and enable the cache for specific queries by adding the @cached directive to the query.

In case of the @cached you can add additional parameters to the directive which will set the cache for specific query to provided time. For example query MyCachedQuery @cached(ttl: 90) .... will set the cache for the query to 90 seconds.

Role based rate limiting

You are able to rate limit requests using the JWT_ROLE_RATE_LIMITING environment variable. If enabled, the proxy will rate limit the requests based on the role claim in the JWT token. You can then provide the json file in following format to specify the limits. Default interval is second, but you can use other values as well. If you want to disable the rate limiting for specific role, you can set the req to 0.

Available values: nano, micro, milli, second, minute, hour, day

To define path in JWT token where current user role is present use the JWT_ROLE_CLAIM_PATH environment variable.

Default / sample configuration:

{
  "ratelimit": {
      "admin": {
          "req": 100,
          "interval": "second"
      },
      "guest": {
          "req": 50,
          "interval": "minute"
      },
      "-": {
          "req": 100,
          "interval": "day"
      }
  }
}

If you'd like to change it - mount your configmap as /app/ratelimit.json file. Remember to include the - role, which is used for unauthenticated users or when claim can't be found for any reason. If rate limit has been reached - the proxy will return 429 Too Many Requests error.

Read only mode

You can enable the read only mode by setting the READ_ONLY_MODE environment variable to true - which will block all the mutation queries.

Monitoring endpoint

Example metrics produced by the proxy:

graphql_proxy_timed_query_bucket{cached="false",user_id="-",op_type="mutation",op_name="updateUserDetails",vmrange="1.000e-02...1.136e-02"} 6
graphql_proxy_timed_query_count{op_name="",cached="false",user_id="-",op_type=""} 78
graphql_proxy_timed_query_bucket{op_name="MyQuery",cached="false",user_id="-",op_type="query",vmrange="5.995e+00...6.813e+00"} 1
graphql_proxy_timed_query_sum{op_name="MyQuery",cached="false",user_id="-",op_type="query"} 6
graphql_proxy_timed_query_count{op_name="MyQuery",cached="false",user_id="-",op_type="query"} 1
graphql_proxy_executed_query{user_id="-",op_type="mutation",op_name="updateKnownSpammer",cached="false"} 1486
graphql_proxy_executed_query{user_id="-",op_type="query",op_name="checkIfAdminsNeedRefreshing",cached="false"} 13167
graphql_proxy_executed_query{user_id="1337",op_type="query",op_name="checkIfKnownMedia",cached="false"} 429
graphql_proxy_executed_query{user_id="-",op_type="query",op_name="checkIfSpamAIRequiresUpdate",cached="false"} 8891
graphql_proxy_requests_failed 324
graphql_proxy_requests_skipped 0
graphql_proxy_requests_succesful 454823