add comments on AutoScalerOptions

Author: shijiesheng

internal/internal_poller_autoscaler.go

@@ -35,11 +35,30 @@ const (
 
 type (
 	AutoScalerOptions struct {
-		Enabled                  bool
-		MinCount                 int
-		MaxCount                 int
-		Cooldown                 time.Duration
+		// Optional: Enable the auto scaler.
+		// default: false
+		Enabled bool
+
+		// Optional: The cooldown period after a scale up or down.
+		// default: 10 seconds
+		Cooldown time.Duration
+
+		// Optional: The minimum number of pollers to start with.
+		// default: 2
+		PollerMinCount int
+
+		// Optional: The maximum number of pollers to start with.
+		// default: 200
+		PollerMaxCount int
+
+		// Optional: The upper bound of poller wait time for poller autoscaler to scale down.
+		// default: 256ms
+		// NOTE: This is normally not needed to be set by user.
 		PollerWaitTimeUpperBound time.Duration
+
+		// Optional: The lower bound of poller wait time for poller autoscaler to scale up.
+		// default: 16ms
+		// NOTE: This is normally not needed to be set by user.
 		PollerWaitTimeLowerBound time.Duration
 	}
 )

internal/internal_worker.go

@@ -1290,11 +1290,11 @@ func AugmentWorkerOptions(options WorkerOptions) WorkerOptions {
 }
 
 func augmentAutoScalerOptions(options AutoScalerOptions) AutoScalerOptions {
-	if options.MinCount <= 1 {
-		options.MinCount = defaultMinPollerSize
+	if options.PollerMinCount <= 1 {
+		options.PollerMinCount = defaultMinPollerSize
 	}
-	if options.MaxCount <= 1 {
-		options.MaxCount = defaultMaxPollerSize
+	if options.PollerMaxCount <= 1 {
+		options.PollerMaxCount = defaultMaxPollerSize
 	}
 	if options.Cooldown == 0 {
 		options.Cooldown = defaultPollerAutoScalerCooldown

internal/internal_worker_base.go

@@ -181,8 +181,8 @@ func newBaseWorker(options baseWorkerOptions, logger *zap.Logger, metricsScope t
 		concurrencyAS = worker.NewConcurrencyAutoScaler(worker.ConcurrencyAutoScalerInput{
 			Concurrency:              concurrency,
 			Cooldown:                 pollerOptions.Cooldown,
-			PollerMaxCount:           pollerOptions.MaxCount,
-			PollerMinCount:           pollerOptions.MinCount,
+			PollerMaxCount:           pollerOptions.PollerMaxCount,
+			PollerMinCount:           pollerOptions.PollerMinCount,
 			PollerWaitTimeUpperBound: pollerOptions.PollerWaitTimeUpperBound,
 			PollerWaitTimeLowerBound: pollerOptions.PollerWaitTimeLowerBound,
 			Logger:                   logger,

internal/internal_worker_test.go

@@ -1320,8 +1320,8 @@ func Test_augmentWorkerOptions(t *testing.T) {
 				Authorization:                           nil,
 				AutoScalerOptions: AutoScalerOptions{
 					Enabled:                  true,
-					MinCount:                 10,
-					MaxCount:                 20,
+					PollerMinCount:           10,
+					PollerMaxCount:           20,
 					Cooldown:                 time.Minute * 3,
 					PollerWaitTimeUpperBound: time.Millisecond * 200,
 					PollerWaitTimeLowerBound: time.Millisecond * 100,
@@ -1360,8 +1360,8 @@ func Test_augmentWorkerOptions(t *testing.T) {
 				Authorization:                           nil,
 				AutoScalerOptions: AutoScalerOptions{
 					Enabled:                  true,
-					MinCount:                 10,
-					MaxCount:                 20,
+					PollerMinCount:           10,
+					PollerMaxCount:           20,
 					Cooldown:                 time.Minute * 3,
 					PollerWaitTimeUpperBound: time.Millisecond * 200,
 					PollerWaitTimeLowerBound: time.Millisecond * 100,
@@ -1404,8 +1404,8 @@ func Test_augmentWorkerOptions(t *testing.T) {
 				Authorization:                           nil,
 				AutoScalerOptions: AutoScalerOptions{
 					Enabled:                  false,
-					MinCount:                 2,
-					MaxCount:                 200,
+					PollerMinCount:           2,
+					PollerMaxCount:           200,
 					Cooldown:                 time.Second * 10,
 					PollerWaitTimeUpperBound: time.Millisecond * 256,
 					PollerWaitTimeLowerBound: time.Millisecond * 16,