Docs: Adds info about Monitoring > Operations enabling response body analysis and query variables

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7229
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
GitOrigin-RevId: 98b1ed714d99b0e474d990c9da007ec47b897b24
This commit is contained in:
Sean Park-Ross 2022-12-14 15:45:44 +02:00 committed by hasura-bot
parent e0113dca95
commit 9006ddd2d7
5 changed files with 29 additions and 7 deletions

View File

@ -17,6 +17,35 @@ import HeadingIcon from '@site/src/components/HeadingIcon';
<div className='badge badge--primary heading-badge'>Available on: Cloud Standard</div>
## Introduction
The Operations tab will present a processed real-time log of all requests to the GraphQL Engine. Here you
can also inspect individual operations.
<Thumbnail src='/img/observability/operations_overview_2.16.0.png' alt='Hasura Cloud Console list operations' />
<Thumbnail src='/img/observability/pro-tab-operations-inspect.png' alt='Hasura Cloud Console inspect operation' />
## Enable response body analysis and capture query variables
At the top of the `Monitoring > Operations` page in the Console, you can select whether to turn on "Enable response body
analysis" and "Capture query variables". These options are disabled by default.
<Thumbnail src='/img/observability/operations_enable-extra-features_2.16.0.png' alt='Hasura Cloud Console enable
extra Operations features' />
When "Enable response body analysis" is enabled, the GraphQL Engine will capture any empty arrays and nulls in a
response and let you know where, if any, they are in the response body. This is useful for debugging and identifying
possible gaps in your data.
<Thumbnail src='/img/observability/operations_empty-arrays-and-nulls_2.16.0.png' alt='Hasura Cloud Console
Operations response body analysis' />
When "Capture query variables" is enabled, you are also able to inspect the query variables provided for each request.
<Thumbnail src='/img/observability/operations_capture-query-variables_2.16.0.png' alt='Hasura Cloud Console
Operations capture query variables' />
## Terminology
**Operation**
@ -54,13 +83,6 @@ A unique ID generated by the server when a websocket connection is established b
**Websocket Operation ID**
A unique ID generated by the websocket client for each operation it is sending to the server
## Operations
Processed real-time logs of all requests to the GraphQL Engine. View all and inspect individual operations:
<Thumbnail src='/img/observability/pro-tab-operations.png' alt='Hasura Cloud Console list operations' />
<Thumbnail src='/img/observability/pro-tab-operations-inspect.png' alt='Hasura Cloud Console inspect operation' />
## Filtering operations

Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 272 KiB