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: sql: Enable telemetry query_sampling by default #71117

Merged
merged 1 commit into from
Oct 5, 2021

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Oct 5, 2021

Backport 1/1 commits from #70890 on behalf of @logston.

/cc @cockroachdb/release


This commit changes the default for the
"sql.telemetry.query_sampling.enabled" setting to true. The CC team
would like this setting enabled by default as turning it on per tenant
cluster during cluster creation and before any SQL is processed is
inefficient in a number of ways.

Release note: None

Closes #70775


Release justification: Category 4

  This commits a new environment variable
  `COCKROACH_SQL_TELEMETRY_QUERY_SAMPLING_ENABLED` that can be used to
  enable the "sql.telemetry.query_sampling.enabled" cluster setting
  without the use of a SQL query.

  The CC team would like this environment variable so that telemetry
  query sampling can be enabled immediately upon tenant cluster creation
  and without the need for issuing further cluster setting SQL queries.

  There are a number of methods of providing the ability to toggle on
  query sampling and an alternate that should be noted is the use of a
  environment variable that overrides the user-set cluster setting. For
  example, a variable that when set forces query sampling regardless of
  what cluster setting queries a user or CC automation has run. One pro
  to this approach is that query sampling can not be turned off by the
  user. One con is that the setting can not be easily disabled by SRE in
  CC in the event of an incident. For the sake of simplicity and
  expedience of delivery prior to a launch, the imperfect approach
  presented in this commit was chosen.

Release note: None
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-21.2-70890 branch from 46900a0 to e5abebf Compare October 5, 2021 00:09
@blathers-crl
Copy link
Author

blathers-crl bot commented Oct 5, 2021

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues.
  • 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 requested review from knz, logston, shermanCRL, stevendanna and a team October 5, 2021 00:09
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@otan otan removed request for a team, stevendanna and shermanCRL October 5, 2021 03:05
Copy link
Contributor

@maryliag maryliag left a comment

Choose a reason for hiding this comment

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

:lgtm:

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

@maryliag maryliag merged commit 7e38d69 into release-21.2 Oct 5, 2021
@jlinder jlinder deleted the blathers/backport-release-21.2-70890 branch October 5, 2021 13:39
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.

3 participants