-
Notifications
You must be signed in to change notification settings - Fork 9
docs(analytics): document transaction-commit-time metric #572
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
kriszyp
wants to merge
2
commits into
main
Choose a base branch
from
kris/txn-commit-latency-592
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -169,6 +169,25 @@ Harper automatically tracks the following metrics for all services. Applications | |||||
| | `bytes-received` | node.database | `replication` | `blob` | bytes | Bytes received for blob replication | | ||||||
| | `replication-latency` | node.database.table | | `ingest` | ms | Time difference from source commit timestamp to local time | | ||||||
|
|
||||||
| ### Storage Metrics | ||||||
|
|
||||||
| | `metric` | `path` | `method` | `type` | Unit | Description | | ||||||
| | ------------------------- | ------ | -------- | ------ | ---- | ----------------------------------------------------------------- | | ||||||
| | `transaction-commit-time` | | | | ms | Time a write transaction is outstanding (submit → durable commit) | | ||||||
|
|
||||||
| `transaction-commit-time` is recorded as a distribution (`mean`, `median`, `p90`, `p95`, `p99`, | ||||||
| `p999`, `count`) per write commit. It measures the same interval the storage engine's overload guard | ||||||
| uses: when the oldest outstanding commit exceeds `storage.maxTransactionQueueTime` (default 45s), | ||||||
| Harper rejects new write transactions with `Outstanding write transactions have too long of queue, | ||||||
| please try again later` (HTTP 503). | ||||||
|
|
||||||
| Because it is measured on that same clock, it is the leading indicator for that rejection: a rising | ||||||
| `p99`/`p999` means commits are taking longer to drain — from write volume, large transactions, or a | ||||||
| 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. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The configuration option
Suggested change
|
||||||
|
|
||||||
| ### Resource Usage Metrics | ||||||
|
|
||||||
| | `metric` | Key attributes | Other | Unit | Description | | ||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documented error message contains a grammatical typo:
too long of queueshould betoo long of a queue(ortoo 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.