hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-14 17:02:49 +03:00
Code Issues Projects Releases Wiki Activity

Docs: improve query variable logging

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/11060
GitOrigin-RevId: 700fd87354854d854de81b6e77c1c4fffed8d01a
This commit is contained in:
Rob Dominguez 2024-10-24 07:32:11 -05:00 committed by hasura-bot
parent be748992f4
commit b0f940f66c
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/docs/api-reference/metadata-api/observability.mdx
View File

@ -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 |