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.

Sign up for GitHub

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

Jump to bottom

fix(commands): Remove misleading help messages #2048

Closed
wants to merge 1 commit into from
Closed

fix(commands): Remove misleading help messages #2048

wants to merge 1 commit into from

Conversation

elramen
Copy link
Contributor

@elramen elramen commented Apr 30, 2024 •
edited

Remove "Check debug output for transmission errors by passing --log-level=debug" from send-envelope's and send-event's help message as this functionality does not seem to exist, e.g., turning off wifi does not give the user any error info. I believe this is a consequence of the actual transmission being handled in sentry-core which does not propagate errors back to sentry-cli.

Fixes GH-2049

@szokeasaurusrex
Copy link
Member

@elramen, I am not convinced that it makes sense to make this change. Although it is possible that --log-level=debug does not provide helpful output when there is no network available, there should be output available for other error cases (e.g. HTTP 4xx or 5xx errors), and we typically ask users for --log-level output whenever they experience a bug to help diagnose the problem

@szokeasaurusrex
Copy link
Member

I think the bigger problem would be if we don't have a helpful error message when the network is unavailable. What happens when you run this command with WiFi disabled (what is the log output)?

@szokeasaurusrex szokeasaurusrex mentioned this pull request Apr 30, 2024
Closed
@elramen
Copy link
Contributor Author

elramen commented Apr 30, 2024 •
edited

I think the bigger problem would be if we don't have a helpful error message when the network is unavailable. What happens when you run this command with WiFi disabled (what is the log output)?

@szokeasaurusrex when the network is not working, we get the exact same debug output as when it is working. You can try it with sentry-cli send-event -m "Hello" --log-level debug. As mentioned in the PR description, I think this is because the transmission is handled in sentry-core which does not propagate transmission errors back to sentry-cli (at least not in the case of these commands). I agree that such functionality would be good to add, but until then, I think it's misleading to print that debug will show transmission errors when it doesn't.

@szokeasaurusrex
Copy link
Member

Following offline discussion, we decided to close this issue. Instead, we will work on getting error messages to be logged

@elramen elramen deleted the command_help_messages branch May 28, 2024 11:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@szokeasaurusrex szokeasaurusrex Awaiting requested review from szokeasaurusrex

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

send_envelope och send_event help msg change
2 participants
@elramen @szokeasaurusrex