Registry / communication / artillery-plugin-slack

artillery-plugin-slack

library1.19.0jsnpmunverified

The `artillery-plugin-slack` package provides a robust integration for Artillery.io, enabling users to send real-time test run notifications directly to a specified Slack channel. Currently at version 1.19.0 (last updated roughly 2 months ago), this plugin integrates seamlessly into Artillery's YAML test scripts. It publishes critical test summary information including whether a test run succeeded or failed, its total duration, the number of Virtual Users (VUs) completed, any encountered errors, and a direct link to the test run's view in Artillery Cloud if applicable. Developed and maintained by the Artillery team, its release cadence is tied to the main Artillery CLI, ensuring compatibility and continuous improvements. This plugin serves as a crucial component for CI/CD pipelines and monitoring setups, providing immediate feedback on performance test outcomes without needing to log into the Artillery dashboard.

communication devops testing

npm install artillery-plugin-slack

package ↗homepage ↗

INSTALL

IMPORT

SIG · ARTILLERY-PLUGIN-S

artillery-plugin-slack

communicationjavascriptv1.19.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Slack Plugin Configuration

✓ plugins: slack: webhookUrl: 'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX'

✗ import { Slack } from 'artillery-plugin-slack'; // Incorrect: Plugins are configured, not imported in JS/TS

Artillery plugins are enabled and configured within the `config.plugins` section of an Artillery YAML test script. There are no direct JavaScript/TypeScript import statements for using this plugin's functionality in a runtime script. The `webhookUrl` is mandatory for sending notifications.

Artillery Test Script (main execution)

✓ artillery run my-test.yml

✗ node my-test.js // Incorrect: Artillery tests are run via the Artillery CLI, typically with a YAML file.

The `artillery-plugin-slack` plugin is activated implicitly when an Artillery test script containing its configuration is executed via the `artillery` CLI. It doesn't expose exportable symbols for direct programmatic use.

Debugging

✓ DEBUG=plugin:slack artillery run my-test.yml

✗ console.log('Debugging Slack plugin'); // Not effective for internal plugin logging

To enable debug logging for the Slack plugin and troubleshoot issues, set the `DEBUG` environment variable to `plugin:slack` before running your Artillery test. This applies specifically to the internal workings of the plugin itself.

This Artillery YAML configuration demonstrates how to enable the `slack` plugin and provides a basic load test scenario. The Slack webhook URL is loaded from an environment variable for security, and two load phases are defined for a typical test workflow.

config: target: "https://api.example.com" phases: - duration: 60 arrivalRate: 5 name: "Warm up" - duration: 120 arrivalRate: 10 name: "Peak load" plugins: slack: webhookUrl: "${process.env.SLACK_WEBHOOK_URL ?? ''}" # Optional: custom messages for success/failure # message: # success: "Artillery test '{{ testName }}' completed successfully!" # failure: "Artillery test '{{ testName }}' *FAILED* with {{ errorCount }} errors." scenarios: - name: "Homepage Load" flow: - get: url: "/" match: "Homepage" - post: url: "/login" json: username: "testuser" password: "password" capture: json: "$.token" as: "authToken" - get: url: "/dashboard" headers: Authorization: "Bearer {{ authToken }}"

Debug

Known issues

breakingThe Slack API frequently deprecates older methods and requires migration to newer approaches (e.g., conversations API, changes to file uploads, discontinuing legacy custom bots). While the plugin itself aims to stay updated, older versions of the plugin or misconfigured Slack apps may cease to function without warning due to Slack API changes.

fix

Ensure your Slack App is up-to-date with Slack's latest API requirements. Always use the latest stable version of `artillery-plugin-slack` and Artillery. Consult the Artillery and Slack documentation for migration guides related to API changes.

affects: >=1.0.0

gotchaIn certain distributed testing scenarios (e.g., `artillery run-fargate`), the Slack plugin might incorrectly report a 'failed' test run even if Artillery Cloud dashboard shows 'Succeeded'. This discrepancy can lead to false alarms in CI/CD pipelines.

fix

Check Artillery's main changelog and plugin release notes for specific fixes related to distributed testing status reporting. Ensure you are running a recent version of Artillery and `artillery-plugin-slack`. It has been noted that some fixes were introduced in Artillery CLI v2.0.24 and v2.0.12 concerning Slack plugin reporting.

affects: <=1.19.0

gotchaAn invalid or expired Slack `webhookUrl` will silently prevent notifications from being sent. Artillery will report that the plugin was configured, but no messages will appear in Slack.

fix

Double-check that the `webhookUrl` in your Artillery configuration is correct, active, and has the necessary permissions in your Slack workspace. It's recommended to store this URL in an environment variable (`${process.env.SLACK_WEBHOOK_URL}`) for security and easier management.

affects: >=1.0.0

gotchaIf the `artillery-plugin-slack` package is not correctly installed or if the plugin name is misspelled in the Artillery configuration, Artillery will fail to load the plugin without providing a clear 'plugin not found' error during the initial validation step, often leading to no Slack messages being sent.

fix

Verify that `artillery-plugin-slack` is installed correctly, either globally (`npm install -g artillery-plugin-slack`) or as a local dev dependency (`npm install --save-dev artillery-plugin-slack`). Ensure the plugin name `slack` is correctly nested under `plugins:` in your YAML configuration.

affects: >=1.0.0

Errors

Common errors & fixes

Slack plugin reports "Artillery test run failed" message while Artillery Cloud dashboard shows "Succeeded" status

Discrepancy in exit code handling or status reporting between Artillery CLI/Fargate execution and the Slack plugin's interpretation.

fix

Upgrade to the latest versions of Artillery CLI and `artillery-plugin-slack`. This issue has received attention and fixes in recent Artillery releases. Verify the Artillery Cloud dashboard for the definitive test status.

No Slack notifications are received after an Artillery test run completes.

Incorrect or expired Slack Webhook URL, missing `webhookUrl` configuration, or network issues preventing communication with Slack.

fix

Ensure `webhookUrl` is correctly configured in your Artillery YAML. Validate the webhook URL in Slack settings and confirm network connectivity from where Artillery is executed. Enable `DEBUG=plugin:slack` to check for specific errors during plugin execution.

Error: Cannot find module 'artillery-plugin-slack'

The `artillery-plugin-slack` npm package is not installed or not discoverable in the current environment where Artillery is being run.

fix

Install the plugin globally (`npm install -g artillery-plugin-slack`) if Artillery is installed globally, or as a local dev dependency (`npm install --save-dev artillery-plugin-slack`) if Artillery is installed locally within your project. Ensure the installation path is accessible.

Upgrade

Version history

1.19.0latest on npm

Audit

Dependencies

artilleryrequiredThis is an Artillery plugin and requires the Artillery CLI to function. It is configured within Artillery's test scripts rather than being directly imported in user code.

Agent activity

34 hits · last 30 days

node

OpenAI (training)

Resources

packagehttps://www.npmjs.com/package/artillery-plugin-slack ↗

homepagehttps://www.artillery.io ↗