refactor(sbom): add sbom prefix + filepaths for decode log messages #7074
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DmitriyLewen
changed the title
logger with sbom prefixsbom prefix + filepaths for decode log messages
knqyf263
reviewed
Jul 2, 2024
pkg/sbom/cyclonedx/unmarshal_test.go
Outdated
Comment on lines
762
to
763
| ctx := log.WithContextAttrs(context.Background(), log.String("filepath", tt.inputFile)) | ||
| err = sbomio.NewDecoder(cdx.BOM).Decode(ctx, &got) |
There was a problem hiding this comment.
I don't think we need to pass attributes in tests.
Suggested change
| ctx := log.WithContextAttrs(context.Background(), log.String("filepath", tt.inputFile)) | |
| err = sbomio.NewDecoder(cdx.BOM).Decode(ctx, &got) | |
| err = sbomio.NewDecoder(cdx.BOM).Decode(context.Background(), &got) |
There was a problem hiding this comment.
removed e0b36ca
pkg/sbom/spdx/unmarshal_test.go
Outdated
Comment on lines
362
to
363
| ctx := log.WithContextAttrs(context.Background(), log.String("filepath", tt.inputFile)) | ||
| err = sbomio.NewDecoder(v.BOM).Decode(ctx, &got) |
There was a problem hiding this comment.
removed in e0b36ca
pkg/fanal/analyzer/sbom/sbom.go
Outdated
| // Format auto-detection | ||
| format, err := sbom.DetectFormat(input.Content) | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("failed to detect SBOM format: %w", err) | ||
| } | ||
|
|
||
| bom, err := sbom.Decode(input.Content, format) | ||
| ctx = log.WithContextAttrs(ctx, log.String("file", input.FilePath)) |
There was a problem hiding this comment.
What if adding log.FilePath(filePath string) in pkg/log and using it so we can use the consistent key name?
func FilePath(filePath string) slog.Attr {
return String("file_path", filePath)
}
There was a problem hiding this comment.
You are right. The number of filepaths used was more than i expected.
I created #7080
There was a problem hiding this comment.
updated this PR
DmitriyLewen
changed the title
sbom prefix + filepaths for decode log messageslog.FilePath() function
DmitriyLewen
changed the title
log.FilePath() functionlog.FilePath() function for logger
DmitriyLewen
changed the title
log.FilePath() function for logger
DmitriyLewen
force-pushed
the
fix-sbom/add-sbom-prefixes
branch
from
ae1e4d8 to
cf30a86
Compare
knqyf263
approved these changes
Jul 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add
file_path+sbomprefix for log messages indecode.go.before:
after:
2024-07-02T14:44:45+06:00 WARN [sbom] Ignore the OS package as no OS is detected. file_path="var/lib/db/sbom/apk-tools-2.14.4-r0.spdx.json"Related discussions
Checklist