Artillery Examples

This repo contains examples of how to use various features in Artillery. Every example is self-contained and can be run as-is without external dependencies (other than those in package.json).

Test scripts

Core features

• using-data-from-csv - using data from an external CSV file in vuser scenarios
• scenario-weights - set weights to change how often Artillery runs a scenario
• script-overrides - override parts of the script such as load phases dynamically at runtime
• multiple-scenario-specs - organizing your Artillery test codebase into separate scenario files

End-to-end examples

• socket-io - testing a Socket.io service
• websockets - testing a WebSocket service
• graphql-api-server - testing a GraphQL API server
• browser-load-testing-playwright - load testing with real browsers
• functional testing - use artillery-plugin-expect to run both load and functional tests
• CSV-driven functional testing - define functional tests with a CSV file

HTTP-specific examples

• http-set-custom-header - set an HTTP header in a beforeRequest hook
• using-cookies - using cookies with HTTP services
• file-uploads - HTTP file uploads with Artillery Pro

Plugins and extensions

• track-custom-metrics - track custom metrics (counters and histograms)
• artillery-plugin-hello-world - a "hello world" plugin

Running Artillery in CI/CD

• cicd examples - using Artillery with Github Actions, Gitlab CI, Azure DevOps, CircleCI and more

Starter kits

• starter-kit - @cfryerdev's Artillery starter kit - an example of how a few different bits fit together

Testing on Kubernetes

• k8s-testing-with-kubectl-artillery-

Contributing

Would you like to share an example showing how to use a feature in Artillery with the community? Send us a PR 💜

License

All code in this repo is licensed under the terms of the MPL2 license.