From b0f940f66cf36b313b6e9a900a2d24116e757ee4 Mon Sep 17 00:00:00 2001 From: Rob Dominguez Date: Thu, 24 Oct 2024 07:32:11 -0500 Subject: [PATCH] Docs: improve query variable logging PR-URL: https://github.com/hasura/graphql-engine-mono/pull/11060 GitOrigin-RevId: 700fd87354854d854de81b6e77c1c4fffed8d01a --- docs/docs/api-reference/metadata-api/observability.mdx | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/docs/api-reference/metadata-api/observability.mdx b/docs/docs/api-reference/metadata-api/observability.mdx index 248d08c1573..e9caf675fcb 100644 --- a/docs/docs/api-reference/metadata-api/observability.mdx +++ b/docs/docs/api-reference/metadata-api/observability.mdx @@ -46,7 +46,8 @@ X-Hasura-Role: admin { "type": "set_metrics_config", "args": { - "analyze_query_variables": false + "analyze_query_variables": false, + "analyze_response_body": false } } ``` @@ -55,7 +56,8 @@ X-Hasura-Role: admin | Key | Required | Schema | Description | | ----------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------- | -| analyze_query_variables | false | boolean | Enables logging of the values of the query variables provided for each request. Default is `false`. | +| analyze_query_variables | true | boolean | Enables logging of the values of the query variables provided for each request. Default is `false`. | +| analyze_response_body | true | boolean | Enables logging of the values of the response body for each request. Default is `false`. | Please see the corresponding [feature documentation for the usage of these configurations](/observability/cloud-monitoring/operations.mdx#capture-query-variables). @@ -144,7 +146,7 @@ X-Hasura-Role: admin | Key | Required | Schema | Description | | -------------------- | -------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | status | false | `String` | Toggle to enable or disable the export. Allowed values are `enabled` and `disabled`. Default is `disabled` (If status is not explicitely passed, then the configuration gets disabled) | -| data_types | false | `[String]` | List of the types of observability data points to be exported. Allowed types: `traces`, `metrics` and `logs` only | +| data_types | false | `[String]` | List of the types of observability data points to be exported. Allowed types: `traces`, `metrics` and `logs` only | | exporter_otlp | false | [OTLPExporter](/api-reference/syntax-defs.mdx#otlpexporter). This is required if status is enabled | OpenTelemetry compliant receiver configuration | | batch_span_processor | false | [OpenTelemetryBatchSpanProcessor](/api-reference/syntax-defs.mdx#opentelemetrybatchspanprocessor) | OpenTelemetry batch export configuration |