introducing server-timing-header config parameter (#700)
This commit is contained in:
@@ -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 <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/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
|
||||
|
||||
@@ -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 <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing>`_ header.
|
||||
See :ref:`server-timing_header`.
|
||||
|
||||
.. _server-unix-socket:
|
||||
|
||||
server-unix-socket
|
||||
|
||||
Reference in New Issue
Block a user