Skip to content

feat: add checkInfo as log context for k6-related checks #1443

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: add checkInfo as log context for k6-related checks #1443

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
14 changes: 6 additions & 8 deletions internal/k6runner/local.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ func (r Local) WithLogger(logger *zerolog.Logger) Runner {
}

func (r Local) Run(ctx context.Context, script Script, secretStore SecretStore) (*RunResponse, error) {
logger := r.logger.With().Object("checkInfo", &script.CheckInfo).Logger()

afs := afero.Afero{Fs: r.fs}

checkTimeout := time.Duration(script.Settings.Timeout) * time.Millisecond
Expand All @@ -52,7 +50,7 @@ func (r Local) Run(ctx context.Context, script Script, secretStore SecretStore)

defer func() {
if err := r.fs.RemoveAll(workdir); err != nil {
logger.Error().Err(err).Str("severity", "critical").Msg("cannot remove temporary directory")
r.logger.Error().Err(err).Str("severity", "critical").Msg("cannot remove temporary directory")
}
}()

Expand Down Expand Up @@ -93,7 +91,7 @@ func (r Local) Run(ctx context.Context, script Script, secretStore SecretStore)
}
defer cleanup()

logger.Debug().
r.logger.Debug().
Str("secret_config_file", configFile).
Str("secrets_url", secretStore.Url).
Msg("Using secret config file")
Expand All @@ -119,7 +117,7 @@ func (r Local) Run(ctx context.Context, script Script, secretStore SecretStore)
cmd.Env = k6Env(os.Environ())

start := time.Now()
logger.Info().Str("command", cmd.String()).Msg("running k6 script")
r.logger.Info().Str("command", cmd.String()).Msg("running k6 script")
err = cmd.Run()

duration := time.Since(start)
Expand All @@ -129,7 +127,7 @@ func (r Local) Run(ctx context.Context, script Script, secretStore SecretStore)
err = errors.Join(err, ctx.Err())

if err != nil && !isUserError(err) {
logger.Error().
r.logger.Error().
Err(err).
Dur("duration", duration).
Msg("cannot run k6")
Expand Down Expand Up @@ -157,7 +155,7 @@ func (r Local) Run(ctx context.Context, script Script, secretStore SecretStore)
return nil, fmt.Errorf("reading k6 logs: %w", err)
}
if truncated {
logger.Warn().
r.logger.Warn().
Str("filename", logsFn).
Int("limitBytes", maxLogsSizeBytes).
Msg("Logs output larger than limit, truncating")
Expand All @@ -171,7 +169,7 @@ func (r Local) Run(ctx context.Context, script Script, secretStore SecretStore)
return nil, fmt.Errorf("reading k6 metrics: %w", err)
}
if truncated {
logger.Warn().
r.logger.Warn().
Str("filename", metricsFn).
Int("limitBytes", maxMetricsSizeBytes).
Msg("Metrics output larger than limit, truncating")
Expand Down
4 changes: 2 additions & 2 deletions internal/prober/browser/browser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,13 @@ func (p Prober) Name() string {

func (p Prober) Probe(ctx context.Context, target string, registry *prometheus.Registry, logger logger.Logger) (bool, float64) {
secretStore, err := p.secretsRetriever(ctx)

if err != nil {
p.logger.Error().Err(err).Msg("running probe")
return false, 0
}

success, err := p.processor.Run(ctx, registry, logger, p.logger, secretStore)
runLogger := p.logger.With().Object("checkInfo", &p.module.Script.CheckInfo).Logger()
success, err := p.processor.Run(ctx, registry, logger, runLogger, secretStore)
if err != nil {
p.logger.Error().Err(err).Msg("running probe")
return false, 0
Expand Down
4 changes: 2 additions & 2 deletions internal/prober/multihttp/multihttp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,13 @@ func (p Prober) Name() string {

func (p Prober) Probe(ctx context.Context, target string, registry *prometheus.Registry, logger logger.Logger) (bool, float64) {
secretStore, err := p.secretsRetriever(ctx)

if err != nil {
p.logger.Error().Err(err).Msg("running probe")
return false, 0
}

success, err := p.processor.Run(ctx, registry, logger, p.logger, secretStore)
runLogger := p.logger.With().Object("checkInfo", &p.module.Script.CheckInfo).Logger()
success, err := p.processor.Run(ctx, registry, logger, runLogger, secretStore)
if err != nil {
p.logger.Error().Err(err).Msg("running probe")
return false, 0
Expand Down
3 changes: 2 additions & 1 deletion internal/prober/scripted/scripted.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ func (p Prober) Probe(ctx context.Context, target string, registry *prometheus.R
return false, 0
}

success, err := p.processor.Run(ctx, registry, logger, p.logger, secretStore)
runLogger := p.logger.With().Object("checkInfo", &p.module.Script.CheckInfo).Logger()
success, err := p.processor.Run(ctx, registry, logger, runLogger, secretStore)
if err != nil {
p.logger.Error().Err(err).Msg("running probe")
return false, 0
Expand Down
Loading