This project is for testing load generation scenarios against Temporal. This is primarily used by the Temporal team to benchmark features and situations. Backwards compatibility may not be maintained.
Omes (pronounced oh-mess) is the Hebrew word for "load" (עומס).
- Go 1.20+
protocandprotoc-gen-gomust be installed- tip: don't worry about the specific versions here; instead, the GitHub action will make a diff
available for download that you can use with
git apply
- Java 8+
- TypeScript: Node 16+
- Python 3.10+
- Poetry:
poetry install
- Poetry:
- .NET
And if you're running the fuzzer (see below)
Scenarios are defined using plain Go code. They are located in the scenarios folder. There are already multiple defined that can be used.
A scenario must select an Executor. The most common is the KitchenSinkExecutor which is a wrapper on the
GenericExecutor specific for executing the Kitchen Sink workflow. The Kitchen Sink workflow accepts
actions and is implemented in every worker language.
For example, here is scenarios/workflow_with_single_noop_activity.go:
func init() {
loadgen.MustRegisterScenario(loadgen.Scenario{
Description: "Each iteration executes a single workflow with a noop activity.",
Executor: loadgen.KitchenSinkExecutor{
WorkflowParams: kitchensink.NewWorkflowParams(kitchensink.NopActionExecuteActivity),
},
})
}NOTE: The file name where the
Registerfunction is called, will be used as the name of the scenario.
- Use snake case for scenario file names.
- Use
KitchenSinkExecutorfor most basic scenarios, adding common/generic actions as need, but for unique scenarios useGenericExecutor. - When using
GenericExecutor, use methods of*loadgen.Runin yourExecuteas much as possible. - Liberally add helpers to the
loadgenpackage that will be useful to other scenario authors.
During local development it's typically easiest to run both the worker and the scenario together.
You can do that like follows. If you want an embedded server rather than one you've already started,
pass --embedded-server.
go run ./cmd run-scenario-with-worker --scenario workflow_with_single_noop_activity --language goNotes:
- Cleanup is not automatically performed here
- Accepts combined flags for
run-workerandrun-scenariocommands
go run ./cmd run-worker --scenario workflow_with_single_noop_activity --run-id local-test-run --language goNotes:
--embedded-servercan be passed here to start an embedded localhost server--task-queue-suffix-index-startand--task-queue-suffix-index-endrepresent an inclusive range for running the worker on multiple task queues. The process will create a worker for every task queue from<task-queue>-<start>through<task-queue>-end. This only applies to multi-task-queue scenarios.
go run ./cmd run-scenario --scenario workflow_with_single_noop_activity --run-id local-test-runNotes:
- Run ID is used to derive ID prefixes and the task queue name, it should be used to start a worker on the correct task queue and by the cleanup script.
- By default the number of iterations or duration is specified in the scenario config. They can be overridden with CLI flags.
- See help output for available flags.
go run ./cmd cleanup-scenario --scenario workflow_with_single_noop_activity --run-id local-test-runThe --version flag can be used to specify a version of the SDK to use, it accepts either
a version number lik v1.24.0 or you can also pass a local path to use a local SDK version.
This is useful while testing unreleased or in-development versions of the SDK.
go run ./cmd run-scenario-with-worker --scenario workflow_with_single_noop_activity --language go --version /path/to/go-sdkFor example, to build a go worker image using v1.24.0 of the Temporal Go SDK:
go run ./cmd build-worker-image --language go --version v1.24.0This will produce an image tagged like <current git commit hash>-go-v1.24.0.
Publishing images is typically done via CI, using the push-images command. See the GHA workflows
for more.
The fuzzer scenario makes use of the kitchen sink workflow (see below) to exercise a wide
range of possible actions. Actions are pre-generated by the kitchen-sink-gen tool, written in
Rust, and are some combination of actions provided to the workflow as input, and actions to be
run by a client inside the scenario executor.
You can run the fuzzer with new random actions like so:
go run ./cmd run-scenario-with-worker --scenario fuzzer --iterations 1 --language csBy default, the scenario will spit out a last_fuzz_run.proto binary file containing the generated
actions. To re-run the same set of actions, you can pass in such a file like so:
go run ./cmd run-scenario-with-worker --scenario fuzzer --iterations 1 --language cs --option input-file=last_fuzz_run.protoOr you can run with a specific seed (seeds are printed at the start of the scenario):
go run ./cmd run-scenario-with-worker --scenario fuzzer --iterations 1 --language cs --option seed=131962944538087455However, the fuzzer is also sensitive to its configuration, and thus the seed will only produce the exact same set of actions if the config has also not changed. Thus you should prefer to save binary files rather than seeds.
Please do collect interesting fuzz cases in the scenarios/fuzz_cases.yaml file. This file
currently has seeds, but could also easily reference stored binary files instead.
The Kitchen Sink workflows accepts a DSL generated by the kitchen-sink-gen Rust tool, allowing us
to test a wide variety of scenarios without having to imagine all possible edge cases that could
come up in workflows. Input may be saved for regression testing, or hand written for specific cases.
A scenario can only fail if an Execute method returns an error, that means the control is fully in the scenario
authors's hands. For enforcing a timeout for a scenario, use options like workflow execution timeouts or write a
workflow that waits for a signal for a configurable amount of time.
- Nicer output that includes resource utilization for the worker (when running all-in-one)
- Ruby worker