DOC-13785 Product Change- PR #147169 - release-25.2: add log and metric for identifying clear access direction #19748
Conversation
…and clear direction metrics and logs.
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
||
| This log message can usually be ignored. However, if it appears repeatedly, it may indicate a load imbalance in the cluster. A load imbalance might occur if a [hot range]({% link {{ page.version.version }}/understand-hotspots.md %}#hot-range) cannot be split because it is effectively a [hot key]({% link {{ page.version.version }}/understand-hotspots.md %}#row-hotspot). For more information about how to reduce hotspots (including hot ranges) on your cluster, refer to [Understand hotspots]({% link {{ page.version.version }}/understand-hotspots.md %}). | ||
|
|
||
| The log message ends with one of the following string combinations, indicating the observed load pattern: |
There was a problem hiding this comment.
clear direction detected indicates that accesses within the range progress steadily in one direction, either increasing or decreasing key order.
Should we call out 'hot index'? (Relatedly to my question above, i'm assuming this error points to a hot index issue.
There was a problem hiding this comment.
It does, do you think saying that it indicates a hot index would be useful here?
There was a problem hiding this comment.
clear direction detected indicates that accesses within the range progress steadily in one direction, either increasing or decreasing key order, generally indicating an index hotspot.
| indicates that CockroachDB wants to [split the range]({% link {{ page.version.version }}/architecture/distribution-layer.md %}#range-splits) due to load, but couldn’t find a key to split at. | ||
| indicates that CockroachDB attempted to [split the range]({% link {{ page.version.version }}/architecture/distribution-layer.md %}#range-splits) due to load, but could not find a key to split at. | ||
|
|
||
| This log message can usually be ignored. However, if it appears repeatedly, it may indicate a load imbalance in the cluster. A load imbalance might occur if a [hot range]({% link {{ page.version.version }}/understand-hotspots.md %}#hot-range) cannot be split because it is effectively a [hot key]({% link {{ page.version.version }}/understand-hotspots.md %}#row-hotspot). For more information about how to reduce hotspots (including hot ranges) on your cluster, refer to [Understand hotspots]({% link {{ page.version.version }}/understand-hotspots.md %}). |
There was a problem hiding this comment.
Can we make the following edits, because I think these sentences can be now genericised further?
A load imbalance might occur if a hot range... -> A load imbalance might occur if a range...
it is effectively a hot key... -> it is effectively a hotspot...
|
|
||
| For more information about how to reduce hotspots (including hot ranges) on your cluster, refer to [Understand hotspots]({% link {{ page.version.version }}/understand-hotspots.md %}). | ||
| Metric | Description |
|
|
||
| This log message can usually be ignored. However, if it appears repeatedly, it may indicate a load imbalance in the cluster. A load imbalance might occur if a [hot range]({% link {{ page.version.version }}/understand-hotspots.md %}#hot-range) cannot be split because it is effectively a [hot key]({% link {{ page.version.version }}/understand-hotspots.md %}#row-hotspot). For more information about how to reduce hotspots (including hot ranges) on your cluster, refer to [Understand hotspots]({% link {{ page.version.version }}/understand-hotspots.md %}). | ||
|
|
||
| The log message ends with one of the following string combinations, indicating the observed load pattern: |
There was a problem hiding this comment.
clear direction detected indicates that accesses within the range progress steadily in one direction, either increasing or decreasing key order, generally indicating an index hotspot.
Fixes DOC-13785 DOC-13379
In load-based-splitting.md, updated monitor section with popular key and clear direction metrics and logs.
Rendered preview
Monitor load-based splitting