From 50d8a22aea131e9b6bb6de6ba0931d7ed59dd795 Mon Sep 17 00:00:00 2001 From: paritosh-08 <85472423+paritosh-08@users.noreply.github.com> Date: Wed, 22 May 2024 20:46:45 +0530 Subject: [PATCH] docs: add list of metrics affected by cardinality config PR-URL: https://github.com/hasura/graphql-engine-mono/pull/10829 Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com> GitOrigin-RevId: 87dd08edf04fa6e35fee66322751defa14278a06 --- .../graphql-engine-flags/reference.mdx | 39 +++++++++++++------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/docs/docs/deployment/graphql-engine-flags/reference.mdx b/docs/docs/deployment/graphql-engine-flags/reference.mdx index 5c61cfc890f..01807d0babd 100644 --- a/docs/docs/deployment/graphql-engine-flags/reference.mdx +++ b/docs/docs/deployment/graphql-engine-flags/reference.mdx @@ -448,18 +448,6 @@ Enable the Hasura Console (served by the server on `/` and `/console`). | **Default** | **CE**, **Enterprise Edition**: `false`
**Cloud**: Console is always enabled | | **Supported in** | CE, Enterprise Edition | -### Header Size Limit - -Sets the maximum cumulative length of all headers in bytes. - -| | | -| ------------------- | ---------------------------------------- | -| **Flag** | `--max-total-header-length` | -| **Env var** | `HASURA_GRAPHQL_MAX_TOTAL_HEADER_LENGTH` | -| **Accepted values** | Integer | -| **Default** | `1024*1024` (1MB) | -| **Supported in** | CE, Enterprise Edition | - ### Enable High-cardinality Labels for Metrics Enable high-cardinality labels for [Prometheus Metrics](/observability/enterprise-edition/prometheus/metrics.mdx). @@ -475,6 +463,21 @@ metrics). | **Default** | `true` | | **Supported in** | Enterprise Edition | +The list of affected metrics are: + +| Metric | High Cardinality enabled | High Cardinality disabled | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------- | +| [hasura_event_queue_time_seconds](/observability/enterprise-edition/prometheus/metrics.mdx/#event-queue-time) | trigger_name, source_name | None | +| [hasura_event_processed_total](/observability/enterprise-edition/prometheus/metrics.mdx/#event-processed-total) | trigger_name, source_name | None | +| [hasura_event_webhook_processing_time_seconds](/observability/enterprise-edition/prometheus/metrics.mdx/#event-webhook-processing-time) | trigger_name, source_name | None | +| [hasura_event_processing_time_seconds](/observability/enterprise-edition/prometheus/metrics.mdx/#event-processing-time) | trigger_name, source_name | None | +| [hasura_event_invocations_total](/observability/enterprise-edition/prometheus/metrics.mdx/#event-invocations-total) | trigger_name, source_name | None | +| [hasura_graphql_requests_total](/observability/enterprise-edition/prometheus/metrics.mdx/#hasura-graphql-requests-total) | operation_type, response_status, parameterized_query_hash, operation_name | operation_type, response_status | +| [hasura_websocket_messages_sent_bytes_total](/observability/enterprise-edition/prometheus/metrics.mdx/#websocket-egress) | parameterized_query_hash, operation_name | None | +| [hasura_subscription_total_time_seconds](/observability/enterprise-edition/prometheus/metrics.mdx#subscription-total-time) | subscription_kind, parameterized_query_hash, operation_name | subscription_kind | +| [hasura_subscription_db_execution_time_seconds](/observability/enterprise-edition/prometheus/metrics.mdx#subscription-database-execution-time) | subscription_kind, parameterized_query_hash, operation_name | subscription_kind | +| [hasura_active_subscriptions](/observability/enterprise-edition/prometheus/metrics.mdx#active-subscriptions) | subscription_kind, parameterized_query_hash, operation_name | subscription_kind | + ### Enable Log Compression Enable sending compressed logs to [metrics server](/observability/enterprise-edition/prometheus/metrics.mdx). @@ -618,6 +621,18 @@ List of experimental features to be enabled. | **Default** | `null` | | **Supported in** | CE, Enterprise Edition, Cloud | +### Header Size Limit + +Sets the maximum cumulative length of all headers in bytes. + +| | | +| ------------------- | ---------------------------------------- | +| **Flag** | `--max-total-header-length` | +| **Env var** | `HASURA_GRAPHQL_MAX_TOTAL_HEADER_LENGTH` | +| **Accepted values** | Integer | +| **Default** | `1024*1024` (1MB) | +| **Supported in** | CE, Enterprise Edition | + ### Graceful Shutdown Timeout The timeout, expressed in seconds, to wait for in-flight events (such as [Event Triggers](/event-triggers/overview.mdx)