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

Document telemetry in README, backtrace only on crash, ignore errors #388

Merged
merged 5 commits into from
May 24, 2022
Merged

Document telemetry in README, backtrace only on crash, ignore errors #388

merged 5 commits into from
May 24, 2022

Conversation

kke
Copy link
Contributor

@kke kke commented May 23, 2022 •
edited
Loading

Fixes #387

Adds information about the telemetry into README.

The crash handler telemetry event no longer sends the error message, just a backtrace that looks like:

k0sproject/k0sctl/cmd/flags.go:96 +0x6e
k0sproject/k0sctl/cmd/flags.go:81 +0x5d
urfave/cli/v2@v2.3.0/command.go:151 +0x52a
urfave/cli/v2@v2.3.0/app.go:313 +0xb48
urfave/cli/v2@v2.3.0/app.go:224

Any errors to submit telemetry will only be reported in the debug log and will not cause the operation to fail.

@kke kke added documentation Improvements or additions to documentation enhancement New feature or request labels May 23, 2022
twz123
twz123 approved these changes May 23, 2022
View reviewed changes
Copy link
Member

@twz123 twz123 left a comment

Choose a reason for hiding this comment

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

What about suppressing telemetry errors, as suggested in the linked issue?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@kke kke changed the title Document telemetry in README and improve crash message redaction Document telemetry in README and ignore any errors while submitting May 23, 2022
@kke kke changed the title Document telemetry in README and ignore any errors while submitting Document telemetry in README, only send backtrace on crash, ignore submit errors May 23, 2022
@kke kke changed the title Document telemetry in README, only send backtrace on crash, ignore submit errors Document telemetry in README, backtrace only on crash, ignore errors May 23, 2022
@kke kke requested a review from twz123 May 23, 2022 11:36
@kke kke merged commit a2d5fc2 into main May 24, 2022
@kke kke deleted the readme-telemetry branch May 24, 2022 06:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@twz123 twz123 Awaiting requested review from twz123

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document that k0sctl uses telemetry
2 participants
@kke @twz123