From 7b5c2f03fcd64279c91f4c955fd7c6573671d431 Mon Sep 17 00:00:00 2001 From: Andrei Dziahel Date: Fri, 24 Nov 2023 22:50:28 +0100 Subject: [PATCH] introducing server-timing-header config parameter (#700) --- docs/references/admin.rst | 27 +++++++++++++++++++++++++++ docs/references/configuration.rst | 18 +++++++++++++++++- 2 files changed, 44 insertions(+), 1 deletion(-) diff --git a/docs/references/admin.rst b/docs/references/admin.rst index e54d542a9..de1075594 100644 --- a/docs/references/admin.rst +++ b/docs/references/admin.rst @@ -143,6 +143,33 @@ You can enable tracing HTTP requests by setting :ref:`server-trace-header`. Spec HTTP/1.1 200 OK X-Request-Id: 123 +.. _server-timing_header: + +`Server-Timing` Header +---------------------- + +You can enable the `Server-Timing `_ header by setting :ref:`server-timing-enabled` on. +This header provides timing information about the different phases of the request-response cycle. + +.. code:: bash + + server-timing-header = "on" + +.. tabs:: + + .. code-tab:: http + + GET /users HTTP/1.1 + + .. code-tab:: bash Curl + + curl "http://localhost:3000/users" + +.. code:: + + HTTP/1.1 200 OK + Server-Timing: jwt;dur=16.0, render;dur=8.8, plan;dur=16956.1, query;dur=763.5 + .. _explain_plan: Execution plan diff --git a/docs/references/configuration.rst b/docs/references/configuration.rst index 9f2ce8667..5a02bf624 100644 --- a/docs/references/configuration.rst +++ b/docs/references/configuration.rst @@ -781,7 +781,7 @@ server-cors-allowed-origins =============== =================================== **Type** String - **Default** `n/a` + **Default** `n/a` **Reloadable** N **Environment** PGRST_SERVER_CORS_ALLOWED_ORIGINS **In-Database** `pgrst.server_cors_allowed_origins` @@ -842,6 +842,22 @@ server-trace-header The header name used to trace HTTP requests. See :ref:`trace_header`. +.. _server-timing-enabled: + +server-timing-enabled +--------------------- + + =============== ================================= + **Type** Boolean + **Default** False + **Reloadable** Y + **Environment** PGRST_SERVER_TIMING_ENABLED + **In-Database** `n/a` + =============== ================================= + + Enables the `Server-Timing `_ header. + See :ref:`server-timing_header`. + .. _server-unix-socket: server-unix-socket