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

feat(log): add stacktrace display option #16825

Merged
merged 4 commits into from
Jul 4, 2023
Merged

feat(log): add stacktrace display option #16825

merged 4 commits into from
Jul 4, 2023

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jul 4, 2023

Description

In the SDK implementation of cosmossdk.io/log there is a confusion between the trace level (like error,info,debug,...) and displaying the stack trace of an error. The logger currently does not support the latter, while the --trace flag is for that. This PR adds the functionality to the logger lib.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@github-actions github-actions bot added the C:log label Jul 4, 2023
@@ -3,6 +3,7 @@ module cosmossdk.io/log
go 1.20

require (
github.com/pkg/errors v0.9.1
Copy link
Member

Choose a reason for hiding this comment

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

This is a archived dependency. Any chance we can use std lib or hashicorp errors

Copy link
Member Author

@julienrbrt julienrbrt Jul 4, 2023

Choose a reason for hiding this comment

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

It was based on https://github.com/rs/zerolog#error-logging-with-stacktrace.
I'll see if creating a custom ErrorStackMarshaler make sense 👀

@julienrbrt julienrbrt mentioned this pull request Jul 4, 2023
19 tasks
@julienrbrt julienrbrt marked this pull request as ready for review July 4, 2023 12:56
@julienrbrt julienrbrt requested a review from a team as a code owner July 4, 2023 12:56
@tac0turtle
Copy link
Member

Lgtm. We can worry about the dev later as it won't cause issues

logger := log.NewLogger(buf, log.TraceOption(true), log.ColorOption(false))
logger.Error("this log should be displayed", "error", inner())
if strings.Count(buf.String(), "logger_test.go") != 1 {
t.Fatalf("stack trace not found, got: %s", buf.String())
Copy link
Member Author

@julienrbrt julienrbrt Jul 4, 2023

Choose a reason for hiding this comment

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

This is currently failing, It seems like ErrorStackMarshaler is only called in Err() but not when using Fields.

Copy link
Member Author

Choose a reason for hiding this comment

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

@julienrbrt julienrbrt enabled auto-merge July 4, 2023 15:51
@julienrbrt
Copy link
Member Author

I will not tag after this PR but use a pseudo version in the SDK until #16825 (comment) is merged. If it gets merge then we can tag a 1.2.0.

@julienrbrt julienrbrt added this pull request to the merge queue Jul 4, 2023
Merged via the queue into main with commit 88f2c83 Jul 4, 2023
49 of 50 checks passed
@julienrbrt julienrbrt deleted the julien/logger branch July 4, 2023 16:11
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