Skip to content

docs(analytics): document transaction-commit-time metric#572

Draft
kriszyp wants to merge 2 commits into
mainfrom
kris/txn-commit-latency-592
Draft

docs(analytics): document transaction-commit-time metric#572
kriszyp wants to merge 2 commits into
mainfrom
kris/txn-commit-latency-592

Conversation

@kriszyp

@kriszyp kriszyp commented Jul 7, 2026

Copy link
Copy Markdown
Member

Summary

Adds a Storage Metrics section documenting transaction-commit-time (write commit submit→durable duration distribution) and how its upper percentiles serve as the leading indicator for the storage overload (503) rejection.

Purpose

Companion docs for HarperFast/harper#1688 (harper#592).

Generated by Claude Opus 4.8.

Add a Storage Metrics section documenting transaction-commit-time (write commit
submit->durable duration distribution) and how its upper percentiles serve as the
leading indicator for the storage overload (503) rejection.

Companion to harper#592.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-572

This preview will update automatically when you push new commits.

@github-actions github-actions Bot temporarily deployed to pr-572 July 7, 2026 15:50 Inactive

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds documentation for a new transaction-commit-time storage metric in reference/analytics/overview.md, detailing its distribution and its relationship with the overload guard configuration. The feedback suggests correcting a grammatical typo in the documented error message and adding backticks around a configuration parameter for markdown consistency.

Comment on lines +181 to +182
Harper rejects new write transactions with `Outstanding write transactions have too long of queue,
please try again later` (HTTP 503).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The documented error message contains a grammatical typo: too long of queue should be too long of a queue (or too long a queue). Please verify if the actual database implementation has this typo and correct it there as well, while updating the documentation here to match.

Suggested change
Harper rejects new write transactions with `Outstanding write transactions have too long of queue,
please try again later` (HTTP 503).
Harper rejects new write transactions with `Outstanding write transactions have too long of a queue,
please try again later` (HTTP 503).

saturated storage volume — and is the signal to shed or throttle write load before commits start
timing out. Unlike an in-flight transaction count, this reflects transaction size and the shared
write path rather than per-thread submission concurrency, so alert on the upper percentiles trending
toward `maxTransactionQueueTime`. Tune the threshold against a baseline for your workload.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The configuration option storage.maxTransactionQueueTime should be enclosed in backticks for consistency with its earlier mention on line 180 and to maintain proper markdown formatting for configuration parameters.

Suggested change
toward `maxTransactionQueueTime`. Tune the threshold against a baseline for your workload.
toward `storage.maxTransactionQueueTime`. Tune the threshold against a baseline for your workload.

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-572

This preview will update automatically when you push new commits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant