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

chore: Print trace ID in panic when available. #16132

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jeschkies
Copy link
Contributor

What this PR does / why we need it:
Debugging a panic log is simplified if the trace ID is printed as well.

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@jeschkies jeschkies requested a review from benclive February 6, 2025 13:28
@jeschkies jeschkies requested a review from a team as a code owner February 6, 2025 13:28
// keep a multiline stack
fmt.Fprintf(os.Stderr, "panic: %v\n%s", p, stack)
fmt.Fprintf(os.Stderr, "panic: %v %s\n%s", p, traceID, stack)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'd change it to

Suggested change
fmt.Fprintf(os.Stderr, "panic: %v %s\n%s", p, traceID, stack)
fmt.Fprintf(os.Stderr, "panic=%v %s\n%s", p, traceID, stack)

but am afraid that this would break some alerts.

Copy link
Collaborator

Choose a reason for hiding this comment

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

You good do also:

fmt.Fprintf(os.Stderr, `panic:"Look into panic=" panic=%v %s\n%s`, p, traceID, stack)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants