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

pkg/server/structlogging: support hot ranges stats with diagnostic reporting disabled #124425

Merged
merged 1 commit into from
May 21, 2024

Conversation

kyle-a-wong
Copy link
Contributor

Previously, enable hot ranges stats also required the enabling of diagnostic reporting. Hot ranges stats doesn't need to be dependent on diagnostic reporting and someone might want to enable hot ranges stats without enabling diagnostic reporting.

Now, server.telemetry.hot_ranges_stats.enabled can be set to true while without setting diagnostics.reporting.enabled

Epic: none
Fixes: #122977
Part of: https://cockroachlabs.atlassian.net/browse/CRDB-38152

Release note: None

@kyle-a-wong kyle-a-wong requested a review from a team as a code owner May 20, 2024 14:55
@kyle-a-wong kyle-a-wong requested review from abarganier and removed request for a team May 20, 2024 14:55
@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Collaborator

@dhartunian dhartunian left a comment

Choose a reason for hiding this comment

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

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


-- commits line 2 at r1:
nit: just structlogging is fine here. this line is probably too long also.


-- commits line 10 at r1:
nit: grammar "while without"


-- commits line 14 at r1:
nit: no need to repeat the ticket that 122977 is already linked to. They're identical and once the github ticket is closed, the Jira ticket will get closed automatically.


-- commits line 16 at r1:
This change should have a release note explaining the modified behavior.

@kyle-a-wong kyle-a-wong force-pushed the diagnostic_telemetry_settings branch 2 times, most recently from 29c82e3 to 8db9740 Compare May 20, 2024 18:35
…abled

Previously, enabling hot ranges stats also required the enabling of diagnostic
reporting. Hot ranges stats doesn't need to be dependent on diagnostic
reporting and someone might want to enable hot ranges stats without enabling
diagnostic reporting.

Now, `server.telemetry.hot_ranges_stats.enabled` can be set to true without
setting `diagnostics.reporting.enabled`.

Epic: none
Fixes: cockroachdb#122977
Release note (ops change): Enabling the
`server.telemetry.hot_ranges_stats.enabled` setting no longer requires the
`diagnostics.reporting.enabled` setting to be set to true. Because
`server.telemetry.hot_ranges_stats.enabled` is enabled by default, those who
have `diagnostics.reporting.enabled` set to false and no explicit setting
for `server.telemetry.hot_ranges_stats.enabled` will now see hot ranges stats
in their telemetry logs.
@kyle-a-wong kyle-a-wong force-pushed the diagnostic_telemetry_settings branch from 8db9740 to fd57c1b Compare May 20, 2024 18:36
Copy link
Contributor Author

@kyle-a-wong kyle-a-wong left a comment

Choose a reason for hiding this comment

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

Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (waiting on @abarganier, @dhartunian, and @xinhaoz)


-- commits line 16 at r1:

Previously, dhartunian (David Hartunian) wrote…

This change should have a release note explaining the modified behavior.

Done.

Copy link
Collaborator

@dhartunian dhartunian left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed all commit messages.
Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @abarganier and @xinhaoz)

@kyle-a-wong
Copy link
Contributor Author

bors r+

@craig
Copy link
Contributor

craig bot commented May 21, 2024

Build failed (retrying...):

@craig craig bot merged commit 3685bb0 into cockroachdb:master May 21, 2024
22 checks passed
@kyle-a-wong kyle-a-wong deleted the diagnostic_telemetry_settings branch May 21, 2024 18:32
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.

diagnostics.reporting.enabled cluster setting is required to enable server.telemetry.hot_ranges_stats.enabled.
3 participants