Profile Run-nbomber

Runs an n-bomber stress test for a given microservice method

Shell

beam profile run-nbomber <service> <method> [options]

About

N-Bomber is a tool for load testing. The profile run-nbomber command will run an N-bomber load test against a given Microservice method. After the load test is complete, a /reports folder will be generated with the results of the test. The check-nbomber command can be used to assert that the results meet given quality thresholds.

Arguments

Name	Type	Description
service	String	The name of the microservice to stress test. This should be a valid, running, Microservice name. This comes from the [Microservice] attribute argument.
method	String	The method name in the service to stress test

Options

Name	Type	Description
--body	String	The file path containing the json body for each request
--include-prefix	Boolean	If true, the generated .env file will include the local machine name as prefix
--include-auth	Boolean	If true, the requests will be given the CLI's auth token
--rps	Int32	The requested requests per second for the test
--duration	Int32	How long to run the test for
--auth	String	Include an auth header. This will override the --include-auth flag
--dryrun	Boolean	Should any networking happen?
--cid	String	Cid to use; will default to whatever is in the file system
--pid	String	Pid to use; will default to whatever is in the file system
--host	String	The host endpoint for beamable
--refresh-token	String	Refresh token to use for the requests
--log	String	Extra logs gets printed out
--dir	String	Directory to use for configuration
--version	Boolean	Show version information
--help	Boolean	Show help and usage information

Parent Command

profile