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-23.2: obs: export metrics about Go GC Assist work; add chart #130126

Merged

Conversation

nicktrav
Copy link
Collaborator

@nicktrav nicktrav commented Sep 5, 2024

Backport:

Please see individual PRs for details.

/cc @cockroachdb/release


Release note: None.

Release justification: Low risk observability change.

This commit introduced functions to extract exposed metrics in go runtime
metrics api. The runtime metrics is sampled along in SampleEnvironment call
every 10 seconds. New metric GcAssistNS is added as an estimate to amount
of effort of user go routines assist in gc activities in nanoseconds.

Fixes: cockroachdb#88178

Release note: None
This commit adds a line chart contains gc assist duration on the runtime page.
The goal is to present the estimated time user go routines spend on assisting
gc tasks.

Informs: cockroachdb#118875

Release note: None
@nicktrav nicktrav requested review from a team as code owners September 5, 2024 03:02
@nicktrav nicktrav requested review from kyle-a-wong and removed request for a team September 5, 2024 03:02
Copy link

blathers-crl bot commented Sep 5, 2024

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Backports should only be created for serious
    issues
    or test-only changes.
  • Backports should not break backwards-compatibility.
  • Backports should change as little code as possible.
  • Backports should not change on-disk formats or node communication protocols.
  • Backports should not add new functionality (except as defined
    here).
  • Backports must not add, edit, or otherwise modify cluster versions; or add version gates.
  • All backports must be reviewed by the owning areas TL. For more information as to how that review should be conducted, please consult the backport
    policy
    .
If your backport adds new functionality, please ensure that the following additional criteria are satisfied:
  • 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. State changes must be further protected such that nodes running old binaries will not be negatively impacted by the new state (with a mixed version test added).
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.
  • Your backport must be accompanied by a post to the appropriate Slack
    channel (#db-backports-point-releases or #db-backports-XX-X-release) for awareness and discussion.

Also, please add a brief release justification to the body of your PR to justify this
backport.

@blathers-crl blathers-crl bot added the backport Label PR's that are backports to older release branches label Sep 5, 2024
@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Member

@nvanbenschoten nvanbenschoten left a comment

Choose a reason for hiding this comment

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

:lgtm: did you manually confirm that this works when compiled with v23.2 and its version of Go? The runtime/metrics is unfortunately weakly typed and won't complain about unsupported metrics, it will just populate values with KindBad when sampling at runtime.

Reviewed 2 of 2 files at r1, 1 of 1 files at r2, all commit messages.
Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @kyle-a-wong)

@nicktrav
Copy link
Collaborator Author

nicktrav commented Sep 6, 2024

did you manually confirm that this works when compiled with v23.2 and its version of Go?

Here's a look at this, running locally for around 10 mins of a KV50 run. I assume that the proof is in the pudding - we see the GC assist timeseries on the new chart.

Screenshot 2024-09-06 at 11 59 56 AM

@nvanbenschoten
Copy link
Member

I assume that the proof is in the pudding - we see the GC assist timeseries on the new chart.

Yes, that proves it. Thanks for checking.

@nicktrav nicktrav merged commit 094f4bf into cockroachdb:release-23.2 Sep 6, 2024
5 of 6 checks passed
@nicktrav nicktrav deleted the nickt.23.2-backport-gcassist-obs branch September 6, 2024 22:15
@nicktrav
Copy link
Collaborator Author

nicktrav commented Sep 6, 2024

Adding a note here that this technically adds new functionality, but there is precedence for backporting obs changes, and we're ok with that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Label PR's that are backports to older release branches
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants