hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-10-26 10:20:54 +03:00
Code Issues Projects Releases Wiki Activity

docs: high cardinality label for metrics toggle

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9135
Co-authored-by: Rob Dominguez <24390149+robertjdominguez@users.noreply.github.com>
GitOrigin-RevId: 75932f6848c9df74f5d11023e29702b9ff124c35
This commit is contained in:
paritosh-08 2023-05-17 11:06:22 +05:30 committed by hasura-bot
parent 48d4882b6c
commit 67044e6675
2 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs/deployment/graphql-engine-flags/reference.mdx
View File

@ -339,6 +339,20 @@ Enable the Hasura Console (served by the server on `/` and `/console`).
| **Default** | **CE**, **Enterprise Edition**: `false` <br />**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).

10
docs/docs/enterprise/metrics.mdx
View File

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