Skip to content

eventpb: new JSON serialization with redaction markers#57990

Merged
craig[bot] merged 1 commit intocockroachdb:masterfrom
knz:20201216-eventlog-json
Dec 21, 2020
Merged

eventpb: new JSON serialization with redaction markers#57990
craig[bot] merged 1 commit intocockroachdb:masterfrom
knz:20201216-eventlog-json

Conversation

@knz
Copy link
Copy Markdown
Contributor

@knz knz commented Dec 16, 2020

Fixes #45643

All commits but the last from #58070 and prior
This is a prereq for presenting structured events "inline" in #57170.

This patch introduces a new code generator and infrastructure to emit
structured event payloads using the JSON syntax, but also including
redaction markers for fields not marked explicitly as safe for
reporting.

This is not yet connected to the remainder of the logging system --
this change will be performed in a later commit.

Release note: None

@knz knz requested a review from itsbilal December 16, 2020 17:45
@knz knz force-pushed the 20201216-eventlog-json branch from 719b601 to 92bc29a Compare December 16, 2020 17:47
@cockroach-teamcity
Copy link
Copy Markdown
Member

This change is Reviewable

@knz knz force-pushed the 20201216-eventlog-json branch 2 times, most recently from 5bee92b to 8e2c2f2 Compare December 16, 2020 19:38
@knz knz force-pushed the 20201216-eventlog-json branch from 8e2c2f2 to d2318da Compare December 18, 2020 15:45
@knz knz force-pushed the 20201216-eventlog-json branch from d2318da to ba9e26d Compare December 18, 2020 17:19
@knz knz requested a review from a team as a code owner December 18, 2020 17:19
@knz knz force-pushed the 20201216-eventlog-json branch 2 times, most recently from 76a294d to e265fcf Compare December 18, 2020 20:03
Copy link
Copy Markdown
Contributor

@itsbilal itsbilal 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 1 of 1 files at r1, 8 of 8 files at r2, 20 of 20 files at r3.
Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @knz)


docs/generated/eventlog.md, line 1241 at r3 (raw file):

### Common fields

| Field | Description | Sensitive |

Is there room to clarify what sensitive means, somewhere near the top of this file? At first I was slightly confused as it could also mean "case sensitive" when in reality it's redaction/PII sensitive. Maybe I'm thinking too much, feel free to ignore this point.

This patch introduces a new code generator and infrastructure to emit
structured event payloads using the JSON syntax, but also including
redaction markers for fields not marked explicitly as safe for
reporting.

This is not yet connected to the remainder of the logging system --
this change will be performed in a later commit.

Release note: None
@knz knz force-pushed the 20201216-eventlog-json branch from e265fcf to cb1a2ce Compare December 21, 2020 17:36
Copy link
Copy Markdown
Contributor Author

@knz knz 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! 1 of 0 LGTMs obtained (waiting on @itsbilal)


docs/generated/eventlog.md, line 1241 at r3 (raw file):

Previously, itsbilal (Bilal Akhtar) wrote…

Is there room to clarify what sensitive means, somewhere near the top of this file? At first I was slightly confused as it could also mean "case sensitive" when in reality it's redaction/PII sensitive. Maybe I'm thinking too much, feel free to ignore this point.

Good idea. Done.

@knz
Copy link
Copy Markdown
Contributor Author

knz commented Dec 21, 2020

TFYR!

bors r=itsbilal

@craig craig bot merged commit e552218 into cockroachdb:master Dec 21, 2020
@craig
Copy link
Copy Markdown
Contributor

craig bot commented Dec 21, 2020

Build succeeded:

@knz knz deleted the 20201216-eventlog-json branch December 22, 2020 10:42
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.

bulkio: provide visibility for events in debug logs

3 participants