openkruise · chethanac15 · Aug 8, 2025 · Aug 8, 2025 · Aug 8, 2025 · Aug 9, 2025
diff --git a/FEATURE_DOCUMENTATION.md b/FEATURE_DOCUMENTATION.md
@@ -0,0 +1,118 @@
+# Canary Batch Timing Feature
+
+## Overview
+
+This feature adds the ability to track start and end times for every canary batch/step in Rollout resources. This addresses issue #112 where users previously could not know the start and end times for each canary batch.
+
+## Changes Made
+
+### 1. API Changes
+
+#### BatchReleaseCanaryStatus (v1alpha1 and v1beta1)
+Added `BatchStartTime` field to track when each batch starts processing:
+
+```go
+type BatchReleaseCanaryStatus struct {
+    // ... existing fields ...
+
+    // BatchStartTime is the start timestamp of the current batch.
+    // This field is updated when a batch starts processing.
+    // +optional
+    BatchStartTime *metav1.Time `json:"batchStartTime,omitempty"`
+
+    // BatchReadyTime is the ready timestamp of the current batch or the last batch.
+    // This field is updated once a batch ready, and the batches[x].pausedSeconds
+    // relies on this field to calculate the real-time duration.
+    BatchReadyTime *metav1.Time `json:"batchReadyTime,omitempty"`
+
+    // ... other fields ...
+}
+```
+
+#### Rollout CanaryStatus (v1beta1)
+Added timing fields to track step timing information:
+
+```go
+type CanaryStatus struct {
+    // ... existing fields ...
+
+    // CurrentStepStartTime is the start timestamp of the current canary step/batch.
+    // This field is updated when a step starts processing.
+    // +optional
+    CurrentStepStartTime *metav1.Time `json:"currentStepStartTime,omitempty"`
+
+    // CurrentStepEndTime is the end timestamp of the current canary step/batch.
+    // This field is updated when a step completes.
+    // +optional
+    CurrentStepEndTime *metav1.Time `json:"currentStepEndTime,omitempty"`
+
+    // ... other fields ...
+}
+```
+
+### 2. Controller Logic Changes
+
+#### BatchRelease Executor
+- **Setting Start Time**: `BatchStartTime` is set when a batch first enters `UpgradingBatchState`
+- **Resetting Start Time**: `BatchStartTime` is reset to `nil` when:
+  - Moving to the next batch
+  - Restarting a batch
+  - Recalculating due to plan changes
+
+#### Rollout Controller
+- **Syncing Timing**: The `syncBatchRelease` function now syncs timing information from `BatchRelease` to `Rollout` status
+- **Status Updates**: `CurrentStepStartTime` and `CurrentStepEndTime` are updated based on the corresponding `BatchRelease` timing
+
+### 3. Conversion Functions
+Updated conversion functions in `api/v1alpha1/conversion.go` to properly handle the new `BatchStartTime` field when converting between API versions.
+
+## Usage
+
+### Viewing Timing Information
+
+You can now view timing information for canary batches:
+
+```bash
+# View BatchRelease timing
+kubectl get batchrelease <name> -o yaml
+
+# View Rollout timing
+kubectl get rollout <name> -o yaml
+```
+
+### Example Output
+
+```yaml
+status:
+  canaryStatus:
+    currentBatch: 1
+    batchState: "UpgradingBatchState"
+    batchStartTime: "2023-01-06T10:30:00Z"
+    batchReadyTime: "2023-01-06T10:35:00Z"
+    updatedReplicas: 2
+    updatedReadyReplicas: 2
+```
+
+## Benefits
+
+1. **Visibility**: Users can now track how long each canary batch takes to complete
+2. **Monitoring**: Enables better monitoring and alerting based on batch timing
+3. **Debugging**: Helps identify performance issues or bottlenecks in specific batches
+4. **Compliance**: Provides audit trail for deployment timing
+
+## Backward Compatibility
+
+- The new fields are optional (`+optional` tag)
+- Existing Rollouts and BatchReleases will continue to work without the new timing fields
+- The fields will be populated for new deployments or when existing resources are updated
+
+## Testing
+
+The feature has been tested with:
+- Unit tests for the batchrelease controller
+- API validation and conversion tests
+- Build verification to ensure no compilation errors
+
+## Related Issues
+
+- Fixes #112: [Feature] need record the starttime and endtime for every canary batch in Rollout
diff --git a/api/v1alpha1/batchrelease_plan_types.go b/api/v1alpha1/batchrelease_plan_types.go
@@ -124,6 +124,10 @@ type BatchReleaseCanaryStatus struct {
 	CurrentBatchState BatchReleaseBatchStateType `json:"batchState,omitempty"`
 	// The current batch the rollout is working on/blocked, it starts from 0
 	CurrentBatch int32 `json:"currentBatch"`
+	// BatchStartTime is the start timestamp of the current batch.
+	// This field is updated when a batch starts processing.
+	// +optional
+	BatchStartTime *metav1.Time `json:"batchStartTime,omitempty"`
 	// BatchReadyTime is the ready timestamp of the current batch or the last batch.
 	// This field is updated once a batch ready, and the batches[x].pausedSeconds
 	// relies on this field to calculate the real-time duration.

diff --git a/api/v1alpha1/conversion.go b/api/v1alpha1/conversion.go
@@ -387,6 +387,7 @@ func (src *BatchRelease) ConvertTo(dst conversion.Hub) error {
 		obj.Status.CanaryStatus = v1beta1.BatchReleaseCanaryStatus{
 			CurrentBatchState:    v1beta1.BatchReleaseBatchStateType(src.Status.CanaryStatus.CurrentBatchState),
 			CurrentBatch:         src.Status.CanaryStatus.CurrentBatch,
+			BatchStartTime:       src.Status.CanaryStatus.BatchStartTime,
 			BatchReadyTime:       src.Status.CanaryStatus.BatchReadyTime,
 			UpdatedReplicas:      src.Status.CanaryStatus.UpdatedReplicas,
 			UpdatedReadyReplicas: src.Status.CanaryStatus.UpdatedReadyReplicas,
@@ -466,6 +467,7 @@ func (dst *BatchRelease) ConvertFrom(src conversion.Hub) error {
 		dst.Status.CanaryStatus = BatchReleaseCanaryStatus{
 			CurrentBatchState:    BatchReleaseBatchStateType(srcV1beta1.Status.CanaryStatus.CurrentBatchState),
 			CurrentBatch:         srcV1beta1.Status.CanaryStatus.CurrentBatch,
+			BatchStartTime:       srcV1beta1.Status.CanaryStatus.BatchStartTime,
 			BatchReadyTime:       srcV1beta1.Status.CanaryStatus.BatchReadyTime,
 			UpdatedReplicas:      srcV1beta1.Status.CanaryStatus.UpdatedReplicas,
 			UpdatedReadyReplicas: srcV1beta1.Status.CanaryStatus.UpdatedReadyReplicas,

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/api/v1beta1/batchrelease_plan_types.go b/api/v1beta1/batchrelease_plan_types.go
@@ -126,6 +126,10 @@ type BatchReleaseCanaryStatus struct {
 	CurrentBatchState BatchReleaseBatchStateType `json:"batchState,omitempty"`
 	// The current batch the rollout is working on/blocked, it starts from 0
 	CurrentBatch int32 `json:"currentBatch"`
+	// BatchStartTime is the start timestamp of the current batch.
+	// This field is updated when a batch starts processing.
+	// +optional
+	BatchStartTime *metav1.Time `json:"batchStartTime,omitempty"`
 	// BatchReadyTime is the ready timestamp of the current batch or the last batch.
 	// This field is updated once a batch ready, and the batches[x].pausedSeconds
 	// relies on this field to calculate the real-time duration.

diff --git a/api/v1beta1/rollout_types.go b/api/v1beta1/rollout_types.go
@@ -445,6 +445,14 @@ type CanaryStatus struct {
 	CanaryReplicas int32 `json:"canaryReplicas"`
 	// CanaryReadyReplicas the numbers of ready canary revision pods
 	CanaryReadyReplicas int32 `json:"canaryReadyReplicas"`
+	// CurrentStepStartTime is the start timestamp of the current canary step/batch.
+	// This field is updated when a step starts processing.
+	// +optional
+	CurrentStepStartTime *metav1.Time `json:"currentStepStartTime,omitempty"`
+	// CurrentStepEndTime is the end timestamp of the current canary step/batch.
+	// This field is updated when a step completes.
+	// +optional
+	CurrentStepEndTime *metav1.Time `json:"currentStepEndTime,omitempty"`
 }
 
 // BlueGreenStatus status fields that only pertain to the blueGreen rollout

diff --git a/api/v1beta1/zz_generated.deepcopy.go b/api/v1beta1/zz_generated.deepcopy.go
diff --git a/pkg/controller/batchrelease/batchrelease_executor.go b/pkg/controller/batchrelease/batchrelease_executor.go
@@ -142,9 +142,19 @@ func (r *Executor) progressBatches(release *v1beta1.BatchRelease, newStatus *v1b
 	default:
 		// for compatibility. if it is an unknown state, should start from beginning.
 		newStatus.CanaryStatus.CurrentBatchState = v1beta1.UpgradingBatchState
+		// Set batch start time when entering a new batch
+		if newStatus.CanaryStatus.BatchStartTime == nil {
+			now := metav1.Now()
+			newStatus.CanaryStatus.BatchStartTime = &now
+		}
 		fallthrough
 
 	case v1beta1.UpgradingBatchState:
+		// Set batch start time when entering upgrading state for the first time
+		if newStatus.CanaryStatus.BatchStartTime == nil {
+			now := metav1.Now()
+			newStatus.CanaryStatus.BatchStartTime = &now
+		}
 		// modify workload replicas/partition based on release plan in this state.
 		err = workloadController.UpgradeBatch()
 		switch {
@@ -257,6 +267,8 @@ func (r *Executor) moveToNextBatch(release *v1beta1.BatchRelease, status *v1beta
 	}
 	if release.Spec.ReleasePlan.BatchPartition == nil || *release.Spec.ReleasePlan.BatchPartition > status.CanaryStatus.CurrentBatch {
 		status.CanaryStatus.CurrentBatch++
+		// Reset batch start time for the new batch
+		status.CanaryStatus.BatchStartTime = nil
 	}
 	status.CanaryStatus.CurrentBatchState = v1beta1.UpgradingBatchState
 	klog.V(3).Infof("BatchRelease(%v) finished one batch, release current batch: %v", klog.KObj(release), status.CanaryStatus.CurrentBatch)

diff --git a/pkg/controller/batchrelease/batchrelease_status.go b/pkg/controller/batchrelease/batchrelease_status.go
@@ -210,11 +210,13 @@ func isRollbackInBatchSatisfied(workloadInfo *util.WorkloadInfo, release *v1beta
 func signalRePrepareRollback(newStatus *v1beta1.BatchReleaseStatus) {
 	newStatus.Phase = v1beta1.RolloutPhasePreparing
 	newStatus.CanaryStatus.BatchReadyTime = nil
+	newStatus.CanaryStatus.BatchStartTime = nil
 	newStatus.CanaryStatus.CurrentBatchState = v1beta1.UpgradingBatchState
 }
 
 func signalRestartBatch(status *v1beta1.BatchReleaseStatus) {
 	status.CanaryStatus.BatchReadyTime = nil
+	status.CanaryStatus.BatchStartTime = nil
 	status.CanaryStatus.CurrentBatchState = v1beta1.UpgradingBatchState
 }
 
@@ -243,6 +245,7 @@ func signalRecalculate(release *v1beta1.BatchRelease, newStatus *v1beta1.BatchRe
 	klog.Infof("BatchRelease(%v) canary batch changed from %v to %v when the release plan changed, observed-rollout-id: %s, current-rollout-id: %s",
 		client.ObjectKeyFromObject(release), newStatus.CanaryStatus.CurrentBatch, currentBatch, observedRolloutID, release.Spec.ReleasePlan.RolloutID)
 	newStatus.CanaryStatus.BatchReadyTime = nil
+	newStatus.CanaryStatus.BatchStartTime = nil
 	newStatus.CanaryStatus.CurrentBatch = currentBatch
 	newStatus.ObservedRolloutID = release.Spec.ReleasePlan.RolloutID
 	newStatus.CanaryStatus.CurrentBatchState = v1beta1.UpgradingBatchState

diff --git a/pkg/controller/rollout/rollout_canary.go b/pkg/controller/rollout/rollout_canary.go
@@ -452,6 +452,9 @@ func (m *canaryReleaseManager) syncBatchRelease(br *v1beta1.BatchRelease, canary
 	// sync from BatchRelease status to Rollout canaryStatus
 	canaryStatus.CanaryReplicas = br.Status.CanaryStatus.UpdatedReplicas
 	canaryStatus.CanaryReadyReplicas = br.Status.CanaryStatus.UpdatedReadyReplicas
+	// Sync timing information from BatchRelease to Rollout
+	canaryStatus.CurrentStepStartTime = br.Status.CanaryStatus.BatchStartTime
+	canaryStatus.CurrentStepEndTime = br.Status.CanaryStatus.BatchReadyTime
 	// Do not remove this line currently, otherwise, users will be not able to judge whether the BatchRelease works
 	// in the scene where only rollout-id changed.
 	// TODO: optimize the logic to better understand

diff --git a/pkg/util/lua_configuration.go b/pkg/util/lua_configuration.go
@@ -44,7 +44,9 @@ func init() {
 			klog.Errorf("Read file %s failed: %s", path, err.Error())
 			return err
 		}
-		luaConfigurationList[path] = string(data)
+		// Normalize key to use forward slashes so lookups are OS-independent
+		normalizedPath := filepath.ToSlash(path)
+		luaConfigurationList[normalizedPath] = string(data)
 		return nil
 	})
 	klog.Infof("Init Lua Configuration(%s)", DumpJSON(luaConfigurationList))