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-22.1: sql, telemetry: show correctly redacted error message #85403

Merged
merged 1 commit into from
Aug 2, 2022

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Aug 1, 2022

Backport 1/1 commits from #83807 on behalf of @dhartunian.

/cc @cockroachdb/release


Previously, the error string from an executed SQL statement was treated
as a string type which would get fully redacted on its way out to the
telemetry log.

This change writes the error type into a RedactableString which
preserves the redaction in the error as intended. This will preserve the
template string which we consider safe by default, for instance.

The CommonSQLExecDetails type in sql_audit_events.proto has been
modified to have the error_text field represented as a
RedactableString which helps us maintain the preservation of redaction
markers.

Resolves: #78353

Release note (ops change): Telemetry logs will now display more finely
redacted error messages from sql execution. Previously, the entire error
string was fully redacted.


Release justification: low-risk logging-only change that improves telemetry.

Previously, the error string from an executed SQL statement was treated
as a `string` type which would get fully redacted on its way out to the
telemetry log.

This change writes the `error` type into a `RedactableString` which
preserves the redaction in the error as intended. This will preserve the
template string which we consider safe by default, for instance.

The `CommonSQLExecDetails` type in `sql_audit_events.proto` has been
modified to have the `error_text` field represented as a
`RedactableString` which helps us maintain the preservation of redaction
markers.

Resolves: #78353

Release note (ops change): Telemetry logs will now display more finely
redacted error messages from sql execution. Previously, the entire error
string was fully redacted.
@blathers-crl blathers-crl bot requested a review from a team as a code owner August 1, 2022 13:52
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-22.1-83807 branch from baa9017 to 8b59d7a Compare August 1, 2022 13:52
@blathers-crl blathers-crl bot requested a review from abarganier August 1, 2022 13:52
@blathers-crl
Copy link
Author

blathers-crl bot commented Aug 1, 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 Aug 1, 2022
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@dhartunian dhartunian merged commit 2492b62 into release-22.1 Aug 2, 2022
@dhartunian dhartunian deleted the blathers/backport-release-22.1-83807 branch August 2, 2022 13:50
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