mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Lina JodoinandGitHub
a646b2d5ef
I'm sending the review for the mechanism (and an example callsite), and I'll send out a review that makes use of it throughout the scheduler code afterwards. ## What changed? - CHASM scheduler components each parent a new EventLog component, which we'll use to record decision logic details that are normally too spammy for logs. - No plan to expose this through any APIs just yet; it isn't meant to be customer-facing (though, I am thinking about how we can make it easy for dev success to get at) ## Why? - V1 debugging was often done through use of the workflow's event history; without an analogue for V2, it's difficult to get a clear picture of how the logic arrived at a certain output state. - Info logging in the same capacity would likely be too spammy for our observability system. - It's difficult to trace a complete picture for an individual schedule *over time* using just Loki. Schedules are often long-lived, with state transitions taking place in short blips over periods of days or weeks. Being able to get a complete list on demand for a relevant scheduler will greatly improve debugging time. ## How did you test it? - [ ] built - [ ] run locally and tested manually - [ ] covered by existing tests - [x] added new unit test(s) - [ ] added new functional test(s) ## Potential risks - This could increase scheduler state size, however: - V2 already measures notably lighter on storage than V1 (not to mention, no event history data whatsoever) - Log is bounded to max 30 messages per component (usually scheduler, generator, invoker) of max 1000 characters each (e.g., ~100KB), as a safety mechanism - Most messages logged will be small and informational, not large state dumps (e.g., "scheduler unpaused", "generator scheduled for ..."). - Backfillers each get their own log, which shares a Backfiller's lifecycle.
90 lines
2.4 KiB
Go
90 lines
2.4 KiB
Go
package scheduler
|
|
|
|
import (
|
|
"time"
|
|
|
|
schedulespb "go.temporal.io/server/api/schedule/v1"
|
|
"go.temporal.io/server/chasm"
|
|
"go.temporal.io/server/chasm/lib/scheduler/gen/schedulerpb/v1"
|
|
schedulescommon "go.temporal.io/server/common/schedules"
|
|
"google.golang.org/protobuf/types/known/timestamppb"
|
|
)
|
|
|
|
// The Backfiller component is responsible for buffering manually
|
|
// requested actions. Each backfill request has its own Backfiller node.
|
|
type Backfiller struct {
|
|
chasm.UnimplementedComponent
|
|
|
|
*schedulerpb.BackfillerState
|
|
|
|
Scheduler chasm.ParentPtr[*Scheduler]
|
|
|
|
EventLog chasm.Field[*EventLog]
|
|
}
|
|
|
|
type BackfillRequestType int
|
|
|
|
const (
|
|
RequestTypeTrigger BackfillRequestType = iota
|
|
RequestTypeBackfill
|
|
)
|
|
|
|
// addBackfiller returns an initialized backfiller, adding it to the scheduler's
|
|
// Backfillers.
|
|
func addBackfiller(
|
|
ctx chasm.MutableContext,
|
|
scheduler *Scheduler,
|
|
) *Backfiller {
|
|
id := schedulescommon.GenerateBackfillerID()
|
|
backfiller := newBackfillerWithState(ctx, &schedulerpb.BackfillerState{
|
|
BackfillId: id,
|
|
LastProcessedTime: timestamppb.New(ctx.Now(scheduler)),
|
|
})
|
|
|
|
if scheduler.Backfillers == nil {
|
|
scheduler.Backfillers = make(chasm.Map[string, *Backfiller])
|
|
}
|
|
scheduler.Backfillers[id] = chasm.NewComponentField(ctx, backfiller)
|
|
|
|
return backfiller
|
|
}
|
|
|
|
func newBackfillerWithState(ctx chasm.MutableContext, state *schedulerpb.BackfillerState) *Backfiller {
|
|
backfiller := &Backfiller{
|
|
BackfillerState: state,
|
|
EventLog: chasm.NewComponentField(ctx, NewEventLog(ctx)),
|
|
}
|
|
backfiller.scheduleTask(ctx, chasm.TaskScheduledTimeImmediate)
|
|
return backfiller
|
|
}
|
|
|
|
// scheduleTask schedules a BackfillerTask at the given time.
|
|
func (b *Backfiller) scheduleTask(ctx chasm.MutableContext, scheduledTime time.Time) {
|
|
ctx.AddTask(b, chasm.TaskAttributes{
|
|
ScheduledTime: scheduledTime,
|
|
}, &schedulerpb.BackfillerTask{})
|
|
}
|
|
|
|
func (b *Backfiller) LifecycleState(ctx chasm.Context) chasm.LifecycleState {
|
|
return chasm.LifecycleStateRunning
|
|
}
|
|
|
|
func (b *Backfiller) RequestType() BackfillRequestType {
|
|
if b.GetTriggerRequest() != nil {
|
|
return RequestTypeTrigger
|
|
}
|
|
|
|
return RequestTypeBackfill
|
|
}
|
|
|
|
type backfillProgressResult struct {
|
|
// BufferedStarts that should be enqueued to the Invoker.
|
|
BufferedStarts []*schedulespb.BufferedStart
|
|
|
|
// High water mark for when state was last updated.
|
|
LastProcessedTime time.Time
|
|
|
|
// When true, the backfill has completed and the node can be deleted.
|
|
Complete bool
|
|
}
|