Skip to content

Commit f46ef7b

Browse files
Add cautionary language about resource-based tuner (#4237)
Co-authored-by: Brian MacDonald <brian.macdonald@temporal.io>
1 parent adf43d9 commit f46ef7b

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

docs/develop/worker-performance.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ Available slot suppliers include:
7373
- You cannot guarantee that the targets for resource-based suppliers won't ever be exceeded.
7474
Resources consumed during a task can't be known ahead of time.
7575

76+
- Read about [choosing an appropriate slot supplier type](#choosing-slot-supplier-types) before picking one.
77+
7678
- Worker tuners supersede the existing `maxConcurrentXXXTask` style Worker options.
7779
Using both styles will cause an error at Worker initialization time.
7880

@@ -362,7 +364,7 @@ A **Worker Tuner** instance exists per-Worker, providing slot suppliers for diff
362364
A tuner assigns different suppliers to each slot type.
363365
For example, it might provide a fixed assignment slot supplier for Workflows and use a resource-based supplier for Activities.
364366

365-
### Choosing slot supplier types
367+
### Choosing slot supplier types {#choosing-slot-supplier-types}
366368

367369
Temporal offers three types of slot suppliers: fixed assignment, resource-based, and custom.
368370
Here’s how to choose the best approach based on your system requirements and workload characteristics.
@@ -375,7 +377,13 @@ When choosing whether to opt for fixed assignment or resource-based suppliers, c
375377
- Reserve auto-tuned resource-based slot suppliers for deployments focused on avoiding Worker overload.
376378
They provide excellent balance with built-in throttling that ensures the Worker will be cautious when handing out new executor slots.
377379

378-
The following use cases are particularly well suited to resource-based auto-tuning slot suppliers:
380+
381+
Scenarios with tasks that have variable, or very high, resource needs should rely on fixed-size
382+
suppliers and manual tuning. The resource-based tuner can never perform as well as a fixed-size
383+
tuner with appropriately chosen configuration, but can offer reasonable performance without the
384+
need for profiling.
385+
386+
The following use cases are well suited to resource-based auto-tuning slot suppliers:
379387

380388
- **Fluctuating workloads with low per-Task consumption**:
381389
The resource-based supplier works well when each Task consumes few resources but may run for a (relatively) long time.

0 commit comments

Comments
 (0)