Bench subscriber

Use the ably bench subscriber command to run a subscriber benchmark test on an Ably channel.

Synopsis

ably bench subscriber <channel-name> [options]

Arguments

channel-name

Required

The name of the channel to subscribe to.

Options

--duration | -D

The duration of the subscriber benchmark in seconds.

--client-id

The client ID to use for the benchmark.

--json

Output results as compact JSON. Mutually exclusive with --pretty-json.

--pretty-json

Output results in formatted JSON. Mutually exclusive with --json.

--verbose | -v

Enable verbose logging. Can be combined with --json or --pretty-json.

Examples

Run a basic subscriber benchmark:

ably bench subscriber my-channel

Run a subscriber benchmark and output results in JSON format:

ably bench subscriber my-channel --json

See also

• Bench — Explore all ably bench commands.
• CLI reference — Full list of available commands.