Skip to content
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

release-21.2: colfetcher: fix the bytes read statistic collection #75260

Merged
merged 1 commit into from
Jan 28, 2022

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Jan 21, 2022

Backport 1/1 commits from #75175 on behalf of @yuzefovich.

/cc @cockroachdb/release


During 21.2 release we adjusted the cFetcher to be Closed eagerly
when it is returning the zero-length batch. This was done in order to
release some references in order for the memory to be GCed sooner;
additionally, the cFetcher started being used for the index join where
the fetcher is restarted from scratch for every batch of spans, so it
seemed reasonable to close it automatically.

However, that eager closure broke "bytes read" statistic collection
since the row.KVFetcher was responsible for providing it, and we were
zeroing it out. This commit fixes this problem by the cFetcher
memorizing the number of bytes it has read in Close. Some care needs
to be taken to not double-count the bytes read in the index join, so
a couple of helper methods have been introduced.

Additionally this commit applies the same eager-close optimization to
the cFetcher when the last batch is returned (which makes it so that
if we've just exhausted all KVs, we close the fetcher - previously, we
would set the zero length on the batch and might never get into
stateFinished).

This commit additionally includes
562d860 which fixes the bytes read
statistic collection for Get requests.

Fixes: #75128.

Release note (bug fix): Previously, CockroachDB could incorrectly report
KV bytes read statistic in EXPLAIN ANALYZE output. The bug is
present only in 21.2.x versions.


Release justification: low-risk bug fix.

@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-21.2-75175 branch from 2ca4bdc to abfe192 Compare January 21, 2022 03:16
@blathers-crl
Copy link
Author

blathers-crl bot commented Jan 21, 2022

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Jan 21, 2022
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@yuzefovich yuzefovich force-pushed the blathers/backport-release-21.2-75175 branch from abfe192 to e93eb09 Compare January 26, 2022 16:59
@yuzefovich
Copy link
Member

I also squashed 562d860 into this backport. PTAL.

Copy link
Collaborator

@rharding6373 rharding6373 left a comment

Choose a reason for hiding this comment

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

:lgtm: but it looks like the new test is failing CI.

Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @rytaft and @yuzefovich)

During 21.2 release we adjusted the `cFetcher` to be `Close`d eagerly
when it is returning the zero-length batch. This was done in order to
release some references in order for the memory to be GCed sooner;
additionally, the `cFetcher` started being used for the index join where
the fetcher is restarted from scratch for every batch of spans, so it
seemed reasonable to close it automatically.

However, that eager closure broke "bytes read" statistic collection
since the `row.KVFetcher` was responsible for providing it, and we were
zeroing it out. This commit fixes this problem by the `cFetcher`
memorizing the number of bytes it has read in `Close`. Some care needs
to be taken to not double-count the bytes read in the index join, so
a couple of helper methods have been introduced.

Additionally this commit applies the same eager-close optimization to
the `cFetcher` when the last batch is returned (which makes it so that
if we've just exhausted all KVs, we close the fetcher - previously, we
would set the zero length on the batch and might never get into
`stateFinished`).

This commit additionally includes
562d860 which fixes the bytes read
statistic collection for Get requests.

Release note (bug fix): Previously, CockroachDB could incorrectly report
`KV bytes read` statistic in `EXPLAIN ANALYZE` output. The bug is
present only in 21.2.x versions.
@yuzefovich yuzefovich force-pushed the blathers/backport-release-21.2-75175 branch from e93eb09 to 912f000 Compare January 28, 2022 20:55
@yuzefovich
Copy link
Member

Yep, there were other minor changes on master that this backport needed.

@yuzefovich yuzefovich merged commit 443e039 into release-21.2 Jan 28, 2022
@yuzefovich yuzefovich deleted the blathers/backport-release-21.2-75175 branch January 28, 2022 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants