Skip to content

Commit

Permalink
cdc: remove 'nonsensitive' tag from changefeed description in telemet…
Browse files Browse the repository at this point in the history
…ry logs

Previously, the description field in changefeed telemetry logs was marked as
`nonsensitive`. This is incorrect because the description field may contain
an SQL statement which is not safe to report. This change removes the
`nonsensitive` tag so the field is redacted by default.

Epic: none
Release note: none
jayshrivastava committed Jan 25, 2023
1 parent c08b21e commit ebd73ee
Showing 3 changed files with 6 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/generated/eventlog.md
Original file line number Diff line number Diff line change
@@ -2697,7 +2697,7 @@ was triggered.

| Field | Description | Sensitive |
|--|--|--|
| `Description` | The description of that would show up in the job's description field, redacted | no |
| `Description` | The description of that would show up in the job's description field, redacted | yes |
| `SinkType` | The type of sink being emitted to (ex: kafka, nodelocal, webhook-https). | no |
| `NumTables` | The number of tables listed in the query that the changefeed is to run on. | no |
| `Resolved` | The behavior of emitted resolved spans (ex: yes, no, 10s) | no |
@@ -2717,7 +2717,7 @@ ChangefeedFailed events.

| Field | Description | Sensitive |
|--|--|--|
| `Description` | The description of that would show up in the job's description field, redacted | no |
| `Description` | The description of that would show up in the job's description field, redacted | yes |
| `SinkType` | The type of sink being emitted to (ex: kafka, nodelocal, webhook-https). | no |
| `NumTables` | The number of tables listed in the query that the changefeed is to run on. | no |
| `Resolved` | The behavior of emitted resolved spans (ex: yes, no, 10s) | no |
2 changes: 1 addition & 1 deletion pkg/util/log/eventpb/events.proto
Original file line number Diff line number Diff line change
@@ -82,7 +82,7 @@ message CommonChangefeedEventDetails {
CommonEventDetails common = 1 [(gogoproto.nullable) = false, (gogoproto.jsontag) = "", (gogoproto.embed) = true];

// The description of that would show up in the job's description field, redacted
string description = 2 [(gogoproto.jsontag) = ",omitempty", (gogoproto.moretags) = "redact:\"nonsensitive\""];
string description = 2 [(gogoproto.jsontag) = ",omitempty"];

// The type of sink being emitted to (ex: kafka, nodelocal, webhook-https).
string sink_type = 3 [(gogoproto.jsontag) = ",omitempty", (gogoproto.moretags) = "redact:\"nonsensitive\""];
4 changes: 3 additions & 1 deletion pkg/util/log/eventpb/json_encode_generated.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ebd73ee

Please sign in to comment.