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

api: revert breaking change in proto #2332

Closed
wants to merge 1 commit into from

Conversation

willfindlay
Copy link
Contributor

Commit b6d3583 introduced a breaking change in our protobuf API by renaming the existing stack_trace field in the kprobe message to kernel_stack_trace when introducing user stack traces. While a change of this nature is not ordinarily problematic in protocol buffer APIs, it is an issue for Tetragon specifically since we rely on protojson for event exports. This effectively means that renaming a field breaks compatibility for downstream consumers of event exports. Revert the rename to prevent breakages.

Fix an accidental renaming of the stack_traces field in the kprobe gRCP message which would have broken our JSON API.

@willfindlay willfindlay added the release-note/bug This PR fixes an issue in a previous release of Tetragon. label Apr 12, 2024
@willfindlay willfindlay requested a review from a team as a code owner April 12, 2024 14:10
Copy link

netlify bot commented Apr 12, 2024

Deploy Preview for tetragon ready!

Name Link
🔨 Latest commit 89700d7
🔍 Latest deploy log https://app.netlify.com/sites/tetragon/deploys/661940be466156000972ff4b
😎 Deploy Preview https://deploy-preview-2332--tetragon.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@willfindlay willfindlay force-pushed the pr/willfindlay/revert-breaking-api-change branch from 89700d7 to cf341b4 Compare April 12, 2024 14:12
Commit b6d3583 introduced a breaking change in our
protobuf API by renaming the existing stack_trace field in the kprobe message to
kernel_stack_trace when introducing user stack traces. While a change of this nature is
not ordinarily problematic in protocol buffer APIs, it is an issue for Tetragon
specifically since we rely on protojson for event exports. This effectively means that
renaming a field breaks compatibility for downstream consumers of event exports. Revert
the rename to prevent breakages.

Signed-off-by: William Findlay <[email protected]>
@willfindlay willfindlay force-pushed the pr/willfindlay/revert-breaking-api-change branch from cf341b4 to 6ab0d82 Compare April 12, 2024 14:20
Copy link
Member

@mtardy mtardy left a comment

Choose a reason for hiding this comment

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

While a change of this nature is not ordinarily problematic in protocol buffer APIs, it is an issue for Tetragon specifically since we rely on protojson for event exports.

indeed

@willfindlay
Copy link
Contributor Author

After some discussion offline, we determined that in this case the breakage is probably ok because of the nature of the feature. If this is not the case for someone, I'd be happy to hear an argument to reopen this. Closing for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note/bug This PR fixes an issue in a previous release of Tetragon.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants