artillery-plugin-tps v1.0.1

Artillery TPS Plugin

A plugin for Artillery, the modern, powerful, and easy-to-use load testing toolkit, to calculate and log Transactions Per Second (TPS).

This plugin monitors requests during your test and calculates TPS over time. It is particularly useful for tracking the performance of your application under load.

Features

• Calculates TPS: Computes the Transactions Per Second (TPS) in real-time.
• Easy Integration: Simple to integrate with your existing Artillery tests.

Installation

To use this plugin, you need to have Artillery installed. Then, you can install the plugin via npm.

1. Install Artillery

If you don't have Artillery installed yet, you can do so with the following command:

npm install -g artillery

2. Install the TPS Plugin

You can install the TPS plugin via npm:

npm install artillery-plugin-tps

Usage

To use the plugin in your Artillery tests, you need to load the plugin in your artillery-config.yml file.

1. Create/Modify artillery-config.yml

Add the plugin to your Artillery configuration file:

config:
  target: 'https://your-api-url.com'
  phases:
    - duration: 60
      arrivalRate: 10

  plugins:
    tps: {}
    
scenarios:
  - flow:
      - get:
          url: "/"

In the plugins section, you just need to specify the plugin, as shown above.

2. Running the Test

Once you’ve set up the configuration, you can run your test as you normally would with Artillery:

artillery run artillery-config.yml