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

feat: The trace of log can be clicked as a link #735

Merged
merged 5 commits into from
Nov 29, 2024
Merged

feat: The trace of log can be clicked as a link #735

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0f93dae
make logs filename clickable
kkumar-gcc Nov 26, 2024
f645fd3
separate logic of formatStack
kkumar-gcc Nov 28, 2024
40788f6
add test cases
kkumar-gcc Nov 29, 2024
0ff312d
Merge branch 'master' into kkumar-gcc/#397
kkumar-gcc Nov 29, 2024
831df3e
Merge branch 'master' into kkumar-gcc/#397
kkumar-gcc Nov 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion log/formatter/general.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,13 +122,26 @@
root := traces.Root
if len(root.Stack) > 0 {
for _, stackStr := range root.Stack {
formattedTraces.WriteString(fmt.Sprintf("\t%s\n", stackStr))
formattedTraces.WriteString(formatStackTrace(stackStr))
}
}

return formattedTraces.String(), nil
}

func formatStackTrace(stackStr string) string {
kkumar-gcc marked this conversation as resolved.
Show resolved Hide resolved
lastColon := strings.LastIndex(stackStr, ":")
if lastColon > 0 && lastColon < len(stackStr)-1 {
secondLastColon := strings.LastIndex(stackStr[:lastColon], ":")
if secondLastColon > 0 {
fileLine := stackStr[secondLastColon+1:]
method := stackStr[:secondLastColon]
return fmt.Sprintf("\t%s [%s]\n", fileLine, method)
}

Check warning on line 140 in log/formatter/general.go

View check run for this annotation

Codecov / codecov/patch

log/formatter/general.go#L137-L140 

Added lines #L137 - L140 were not covered by tests
}
return fmt.Sprintf("\t%s\n", stackStr)
}

func deleteKey(data logrus.Fields, keyToDelete string) logrus.Fields {
dataCopy := make(logrus.Fields)
for key, value := range data {
Expand Down
20 changes: 10 additions & 10 deletions log/formatter/general_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,16 +200,16 @@ func (s *GeneralTestSuite) TestFormatStackTraces() {
"root": map[string]any{
"message": "error bad request", // root cause
"stack": []string{
"main.main:/dummy/examples/logging/example.go:143", // original calling method
"main.ProcessResource:/dummy/examples/logging/example.go:71",
"main.(*Request).Validate:/dummy/examples/logging/example.go:29", // location of Wrap call
"main.(*Request).Validate:/dummy/examples/logging/example.go:28", // location of the root
"/dummy/examples/logging/example.go:143 [main.main]", // original calling method
"/dummy/examples/logging/example.go:71 [main.ProcessResource]",
"/dummy/examples/logging/example.go:29 [main.(*Request).Validate]", // location of Wrap call
"/dummy/examples/logging/example.go:28 [main.(*Request).Validate]", // location of the root
},
},
"wrap": []map[string]any{
{
"message": "received a request with no ID", // additional context
"stack": "main.(*Request).Validate:/dummy/examples/logging/example.go:29", // location of Wrap call
"message": "received a request with no ID", // additional context
"stack": "/dummy/examples/logging/example.go:29 [main.(*Request).Validate]", // location of Wrap call
},
},
}
Expand All @@ -218,10 +218,10 @@ func (s *GeneralTestSuite) TestFormatStackTraces() {
traces, err := general.formatStackTraces(stackTraces)
s.Nil(err)
stackTraces := []string{
"main.main:/dummy/examples/logging/example.go:143",
"main.ProcessResource:/dummy/examples/logging/example.go:71",
"main.(*Request).Validate:/dummy/examples/logging/example.go:29",
"main.(*Request).Validate:/dummy/examples/logging/example.go:28",
"/dummy/examples/logging/example.go:143 [main.main]",
"/dummy/examples/logging/example.go:71 [main.ProcessResource]",
"/dummy/examples/logging/example.go:29 [main.(*Request).Validate]",
"/dummy/examples/logging/example.go:28 [main.(*Request).Validate]",
}
formattedStackTraces := "trace:\n\t" + strings.Join(stackTraces, "\n\t") + "\n"

Expand Down
Loading