diff --git a/docs/docs/deployment/graphql-engine-flags/reference.mdx b/docs/docs/deployment/graphql-engine-flags/reference.mdx index d92b0ddbafb..b41a77383b2 100644 --- a/docs/docs/deployment/graphql-engine-flags/reference.mdx +++ b/docs/docs/deployment/graphql-engine-flags/reference.mdx @@ -339,6 +339,20 @@ 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 | +### Enable High-cardinality Labels for Metrics + +Enable high-cardinality labels for [Prometheus Metrics](/enterprise/metrics.mdx). Enabling this setting will add more labels to +some of the metrics (e.g. `operationName` label for Graphql subscription metrics). + +| | | +| ------------------- | ------------------------------------------------- | +| **Flag** | N/A | +| **Env var** | `HASURA_GRAPHQL_METRICS_ENABLE_HIGH_CARDINALITY_LABELS` | +| **Accepted values** | Boolean | +| **Options** | `true` or `false` | +| **Default** | `true` | +| **Supported in** | Enterprise Edition | + ### Enable Log Compression Enable sending compressed logs to [metrics server](/enterprise/metrics.mdx). diff --git a/docs/docs/enterprise/metrics.mdx b/docs/docs/enterprise/metrics.mdx index 3316937679d..9ca9bc07087 100644 --- a/docs/docs/enterprise/metrics.mdx +++ b/docs/docs/enterprise/metrics.mdx @@ -40,6 +40,16 @@ The metrics endpoint should be configured with a secret to prevent misuse and sh ::: +:::tip High-cardinality Labels + +Starting in `v2.26.0`, Hasura GraphQL Engine exposes metrics with high-cardinality labels by default. + +You can disable [the cardinality of labels for +metrics](/deployment/graphql-engine-flags/reference.mdx#enable-high-cardinality-labels-for-metrics) if you are +experiencing high memory usage, which can be due to a large number of labels in the metrics (typically more than 10000). + +::: + ## Metrics exported The following metrics are exported by Hasura GraphQL Engine: