Skip to content

Add source entry point to logs #4724

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

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

Add source entry point to logs #4724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 7 additions & 1 deletion pkg/sources/source_manager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ import (
"github.com/trufflesecurity/trufflehog/v3/pkg/pb/sourcespb"
)

const sourceEntryPointLogKey = "source_entry_point"

// SourceManager provides an interface for starting and managing running
// sources.
type SourceManager struct {
Expand Down Expand Up @@ -471,6 +473,7 @@ func (s *SourceManager) enumerateWithUnits(ctx context.Context, source SourceUni
report.ReportError(Fatal{err})
catchFirstFatal(Fatal{err})
})
ctx := context.WithValue(ctx, sourceEntryPointLogKey, "Enumerate")
if err := source.Enumerate(ctx, reporter); err != nil {
report.ReportError(Fatal{err})
catchFirstFatal(Fatal{err})
Expand Down Expand Up @@ -508,7 +511,7 @@ func (s *SourceManager) runWithoutUnits(ctx context.Context, source Source, repo
// stack.
defer wg.Wait()
defer close(ch)
if err := source.Chunks(ctx, ch, targets...); err != nil {
if err := source.Chunks(context.WithValue(ctx, sourceEntryPointLogKey, "Chunks"), ch, targets...); err != nil {
report.ReportError(Fatal{err})
return Fatal{err}
}
Expand Down Expand Up @@ -543,6 +546,7 @@ func (s *SourceManager) runWithUnits(ctx context.Context, source SourceUnitEnumC
report.ReportError(Fatal{err})
catchFirstFatal(Fatal{err})
})
ctx := context.WithValues(ctx, sourceEntryPointLogKey, "Enumerate")
if err := source.Enumerate(ctx, unitReporter); err != nil {
report.ReportError(Fatal{err})
catchFirstFatal(Fatal{err})
Expand Down Expand Up @@ -572,6 +576,7 @@ func (s *SourceManager) runWithUnits(ctx context.Context, source SourceUnitEnumC
report.ReportError(Fatal{ChunkError{Unit: unit, Err: err}})
catchFirstFatal(Fatal{err})
})
ctx = context.WithValues(ctx, sourceEntryPointLogKey, "ChunkUnit")
if err := source.ChunkUnit(ctx, unit, chunkReporter); err != nil {
report.ReportError(Fatal{ChunkError{Unit: unit, Err: err}})
catchFirstFatal(Fatal{err})
Expand Down Expand Up @@ -621,6 +626,7 @@ func (s *SourceManager) scanWithUnit(ctx context.Context, source SourceUnitChunk
report.ReportError(Fatal{ChunkError{Unit: unit, Err: err}})
chunkErr = Fatal{err}
})
ctx = context.WithValues(ctx, sourceEntryPointLogKey, "ChunkUnit")
if err := source.ChunkUnit(ctx, unit, chunkReporter); err != nil {
report.ReportError(Fatal{ChunkError{Unit: unit, Err: err}})
chunkErr = Fatal{err}
Expand Down
9 changes: 8 additions & 1 deletion pkg/sources/sources.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,14 @@ func (c *ConfiguredSource) Init(ctx context.Context, sourceID SourceID, jobID Jo
return nil, errors.New("source already initialized")
}
src := c.source
err := src.Init(ctx, c.Name, jobID, sourceID, c.initParams.verify, c.initParams.conn, c.initParams.concurrency)
err := src.Init(
context.WithValue(ctx, sourceEntryPointLogKey, "Init"),
c.Name,
jobID,
sourceID,
c.initParams.verify,
c.initParams.conn,
c.initParams.concurrency)
c.source = nil
return src, err
}
Expand Down
Loading