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

Start using new eval history table #3703

Merged
merged 3 commits into from
Jun 26, 2024
Merged

Start using new eval history table #3703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbaa6d4
Start using new eval history table
dmjb Jun 24, 2024
b6d11cb
remove non enum attributes on metrics
dmjb Jun 25, 2024
a1d2120
Merge branch 'main' into wire-up-history-logs
dmjb Jun 25, 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
2 changes: 1 addition & 1 deletion database/query/eval_history.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,5 @@ INSERT INTO latest_evaluation_statuses(
$1,
$2
)
ON CONFLICT (rule_entity_id, evaluation_history_id) DO UPDATE
ON CONFLICT (rule_entity_id) DO UPDATE
SET evaluation_history_id = $2;
3 changes: 2 additions & 1 deletion internal/controlplane/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ func NewServer(
sessionService session.ProviderSessionService,
projectDeleter projects.ProjectDeleter,
projectCreator projects.ProjectCreator,
featureFlagClient *openfeature.Client,
) *Server {
return &Server{
store: store,
Expand All @@ -152,7 +153,7 @@ func NewServer(
profiles: profileService,
ruleTypes: ruleService,
providerStore: providerStore,
featureFlags: openfeature.NewClient(cfg.Flags.AppName),
featureFlags: featureFlagClient,
ghClient: &ghprov.ClientServiceImplementation{},
providerManager: providerManager,
providerAuthManager: providerAuthManager,
Expand Down
2 changes: 1 addition & 1 deletion internal/db/eval_history.sql.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

53 changes: 45 additions & 8 deletions internal/engine/eval_status.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import (
evalerrors "github.com/stacklok/minder/internal/engine/errors"
engif "github.com/stacklok/minder/internal/engine/interfaces"
ent "github.com/stacklok/minder/internal/entities"
"github.com/stacklok/minder/internal/flags"
pb "github.com/stacklok/minder/pkg/api/protobuf/go/minder/v1"
)

Expand Down Expand Up @@ -126,8 +127,21 @@ func (e *Executor) createOrUpdateEvalStatus(
return nil
}

// Get rule instance ID
// TODO: we should use the rule instance table in the evaluation process
// it should not be necessary to query it here.
ruleID, err := e.querier.GetIDByProfileEntityName(ctx, db.GetIDByProfileEntityNameParams{
ProfileID: params.ProfileID,
EntityType: params.EntityType,
Name: params.Rule.Name,
})
if err != nil {
return fmt.Errorf("unable to retrieve rule instance ID from DB: %w", err)
}

// Upsert evaluation
id, err := e.querier.UpsertRuleEvaluations(ctx, db.UpsertRuleEvaluationsParams{
// TODO: replace this table with the evaluation statuses table
evalID, err := e.querier.UpsertRuleEvaluations(ctx, db.UpsertRuleEvaluationsParams{
ProfileID: params.ProfileID,
RepositoryID: params.RepoID,
ArtifactID: params.ArtifactID,
Expand All @@ -136,7 +150,6 @@ func (e *Executor) createOrUpdateEvalStatus(
PullRequestID: params.PullRequestID,
RuleName: params.Rule.Name,
})

if err != nil {
logger.Err(err).Msg("error upserting rule evaluation")
return err
Expand All @@ -148,9 +161,9 @@ func (e *Executor) createOrUpdateEvalStatus(
return err
}
status := evalerrors.ErrorAsEvalStatus(params.GetEvalErr())
e.metrics.CountEvalStatus(ctx, status, params.ProfileID, params.ProjectID, entityID, entityType)
e.metrics.CountEvalStatus(ctx, status, entityType)
_, err = e.querier.UpsertRuleDetailsEval(ctx, db.UpsertRuleDetailsEvalParams{
RuleEvalID: id,
RuleEvalID: evalID,
Comment on lines -153 to +166
Copy link
Member

Choose a reason for hiding this comment

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

I suppose it's intended but why did we switched from one to another?

Status: evalerrors.ErrorAsEvalStatus(params.GetEvalErr()),
Details: evalerrors.ErrorAsEvalDetails(params.GetEvalErr()),
})
Expand All @@ -161,9 +174,12 @@ func (e *Executor) createOrUpdateEvalStatus(
}

// Upsert remediation details
remediationStatus := evalerrors.ErrorAsRemediationStatus(params.GetActionsErr().RemediateErr)
e.metrics.CountRemediationStatus(ctx, remediationStatus)

_, err = e.querier.UpsertRuleDetailsRemediate(ctx, db.UpsertRuleDetailsRemediateParams{
RuleEvalID: id,
Status: evalerrors.ErrorAsRemediationStatus(params.GetActionsErr().RemediateErr),
RuleEvalID: evalID,
Status: remediationStatus,
Details: errorAsActionDetails(params.GetActionsErr().RemediateErr),
Metadata: params.GetActionsErr().RemediateMeta,
})
Expand All @@ -172,16 +188,37 @@ func (e *Executor) createOrUpdateEvalStatus(
}

// Upsert alert details
alertStatus := evalerrors.ErrorAsAlertStatus(params.GetActionsErr().AlertErr)
e.metrics.CountAlertStatus(ctx, alertStatus)

_, err = e.querier.UpsertRuleDetailsAlert(ctx, db.UpsertRuleDetailsAlertParams{
RuleEvalID: id,
Status: evalerrors.ErrorAsAlertStatus(params.GetActionsErr().AlertErr),
RuleEvalID: evalID,
Status: alertStatus,
Details: errorAsActionDetails(params.GetActionsErr().AlertErr),
Metadata: params.GetActionsErr().AlertMeta,
})
if err != nil {
logger.Err(err).Msg("error upserting rule alert details")
}

if flags.Bool(ctx, e.featureFlags, flags.EvalHistory) {
// Log in the evaluation history tables
_, err = db.WithTransaction(e.querier, func(qtx db.ExtendQuerier) (uuid.UUID, error) {
return e.historyService.StoreEvaluationStatus(
ctx,
qtx,
ruleID,
params.EntityType,
entityID,
params.GetEvalErr(),
)
})
if err != nil {
logger.Err(err).Msg("error logging evaluation status")
return err
}
}

return err
}

Expand Down
11 changes: 10 additions & 1 deletion internal/engine/executor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (

"github.com/ThreeDotsLabs/watermill/message"
"github.com/google/uuid"
"github.com/open-feature/go-sdk/openfeature"
"github.com/rs/zerolog"

"github.com/stacklok/minder/internal/db"
Expand All @@ -33,6 +34,7 @@ import (
"github.com/stacklok/minder/internal/engine/ingestcache"
engif "github.com/stacklok/minder/internal/engine/interfaces"
"github.com/stacklok/minder/internal/events"
"github.com/stacklok/minder/internal/history"
minderlogger "github.com/stacklok/minder/internal/logger"
"github.com/stacklok/minder/internal/profiles"
"github.com/stacklok/minder/internal/providers/manager"
Expand Down Expand Up @@ -61,6 +63,8 @@ type Executor struct {
terminationcontext context.Context
providerManager manager.ProviderManager
metrics *ExecutorMetrics
historyService history.EvaluationHistoryService
featureFlags openfeature.IClient
}

// NewExecutor creates a new executor
Expand All @@ -71,6 +75,8 @@ func NewExecutor(
providerManager manager.ProviderManager,
handlerMiddleware []message.HandlerMiddleware,
metrics *ExecutorMetrics,
historyService history.EvaluationHistoryService,
featureFlags openfeature.IClient,
) *Executor {
return &Executor{
querier: querier,
Expand All @@ -80,6 +86,8 @@ func NewExecutor(
handlerMiddleware: handlerMiddleware,
providerManager: providerManager,
metrics: metrics,
historyService: historyService,
featureFlags: featureFlags,
}
}

Expand Down Expand Up @@ -390,7 +398,8 @@ func (e *Executor) releaseLockAndFlush(
func logEval(
ctx context.Context,
inf *entities.EntityInfoWrapper,
params *engif.EvalStatusParams) {
params *engif.EvalStatusParams,
) {
evalLog := params.DecorateLogger(
zerolog.Ctx(ctx).With().
Str("eval_status", string(evalerrors.ErrorAsEvalStatus(params.GetEvalErr()))).
Expand Down
14 changes: 14 additions & 0 deletions internal/engine/executor_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ import (
"github.com/stacklok/minder/internal/engine/actions/remediate"
"github.com/stacklok/minder/internal/engine/entities"
"github.com/stacklok/minder/internal/events"
"github.com/stacklok/minder/internal/flags"
mock_history "github.com/stacklok/minder/internal/history/mock"
"github.com/stacklok/minder/internal/logger"
"github.com/stacklok/minder/internal/metrics/meters"
"github.com/stacklok/minder/internal/providers"
Expand Down Expand Up @@ -255,6 +257,15 @@ default allow = true`,
Details: "",
}).Return(ruleEvalDetailsId, nil)

ruleInstanceID := uuid.New()
mockStore.EXPECT().
GetIDByProfileEntityName(gomock.Any(), db.GetIDByProfileEntityNameParams{
ProfileID: profileID,
EntityType: db.EntitiesRepository,
Name: passthroughRuleType,
}).
Return(ruleInstanceID, nil)

// Mock upserting remediate status
ruleEvalRemediationId := uuid.New()
mockStore.EXPECT().
Expand Down Expand Up @@ -350,6 +361,7 @@ default allow = true`,

execMetrics, err := engine.NewExecutorMetrics(&meters.NoopMeterFactory{})
require.NoError(t, err)
historyService := mock_history.NewMockEvaluationHistoryService(ctrl)

e := engine.NewExecutor(
ctx,
Expand All @@ -358,6 +370,8 @@ default allow = true`,
providerManager,
[]message.HandlerMiddleware{},
execMetrics,
historyService,
&flags.FakeClient{},
)
require.NoError(t, err, "expected no error")

Expand Down
23 changes: 4 additions & 19 deletions internal/engine/metrics.go
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

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

This cleanup is not directly related to the rest of the PR, right? (It's okay, just trying to make sure I understand.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I realized when I wired these metrics into the engine that I was using the wrong type for status.

Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ import (
"context"
"fmt"

"github.com/google/uuid"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/metric"

Expand Down Expand Up @@ -68,15 +67,9 @@ func NewExecutorMetrics(meterFactory meters.MeterFactory) (*ExecutorMetrics, err
func (e *ExecutorMetrics) CountEvalStatus(
ctx context.Context,
status db.EvalStatusTypes,
profileID uuid.UUID,
projectID uuid.UUID,
entityID uuid.UUID,
entityType db.Entities,
) {
e.evalCounter.Add(ctx, 1, metric.WithAttributes(
attribute.String("profile_id", profileID.String()),
attribute.String("project_id", projectID.String()),
attribute.String("entity_id", entityID.String()),
attribute.String("entity_type", string(entityType)),
attribute.String("status", string(status)),
))
Expand All @@ -85,27 +78,19 @@ func (e *ExecutorMetrics) CountEvalStatus(
// CountRemediationStatus counts remediation events by status.
func (e *ExecutorMetrics) CountRemediationStatus(
ctx context.Context,
status string,
evalID uuid.UUID,
projectID uuid.UUID,
status db.RemediationStatusTypes,
) {
e.evalCounter.Add(ctx, 1, metric.WithAttributes(
attribute.String("profile_id", evalID.String()),
attribute.String("project_id", projectID.String()),
attribute.String("status", status),
attribute.String("status", string(status)),
))
}

// CountAlertStatus counts alert events by status.
func (e *ExecutorMetrics) CountAlertStatus(
ctx context.Context,
status string,
evalID uuid.UUID,
projectID uuid.UUID,
status db.AlertStatusTypes,
) {
e.evalCounter.Add(ctx, 1, metric.WithAttributes(
attribute.String("profile_id", evalID.String()),
attribute.String("project_id", projectID.String()),
attribute.String("status", status),
attribute.String("status", string(status)),
))
}
2 changes: 2 additions & 0 deletions internal/flags/constants.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,6 @@ package flags
const (
// UserManagement enables user management, i.e. invitations, role assignments, etc.
UserManagement Experiment = "user_management"
// EvalHistory enables logging of evaluation history in the new tables.
EvalHistory Experiment = "eval_history"
)
57 changes: 57 additions & 0 deletions internal/history/mock/service.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading