## 1. Project Overview & Quickstart (grafana/k6)

Like unit testing, for performance

**k6** is a modern load-testing tool, built on [our years of experience](https://k6.io/about) in the performance and testing industries. It's built to be powerful, extensible, and full-featured. The key design goal is to provide **the best developer experience**. Its core features are: - **Configurable load generation.** Even lower-end machines can simulate lots of traffic. - **Tests as code.** Reuse scripts, modularize logic, version control, and integrate tests with your CI. - **A full-featured API.** The scripting API is packed with features that help you simulate real application traffic. - **An embedded JavaScript engine.** The performance of Go, the scripting familiarity of JavaScript. - **Multiple Protocol support**. HTTP, WebSockets, gRPC, Browser, and more. - **Large extension ecosystem.** You can extend k6 to support your needs. And many people have already shared their extensions with the community! [Explore](https://grafana.com/docs/k6/latest/extensions/explore) the available extensions. - **Flexible metrics storage and visualization**. Summary statistics or granular metrics, exported to the service of your choice. - **Native integration with Grafana cloud**. [SaaS solution](https://grafana.com/products/cloud/k6/) for test execution, metrics correlation, data analysis, and more. This is what load testing looks like in the 21st century. ## Example script ```js import http from "k6/http"; import { check, sleep } from "k6"; // Test configuration export const options = { thresholds: { // Assert that 99% of requests finish within 3000ms. http_req_duration: ["p(99) < 3000"], }, // Ramp the number of virtual users up and down stages: [ { duration: "30s", target: 15 }, { duration: "1m", target: 15 }, { duration: "20s", target: 0 }, ], }; // Simulated user behavior export default function () { let res = http.get("https://quickpizza.grafana.com"); // Validate response status check(res, { "status was 200": (r) => r.status == 200 }); sleep(1); } ``` You can run scripts like this on the CLI, or in your CI, or across a Kubernetes cluster. > [!NOTE] > Don't want to write code ? > > We got you! Meet [k6 Studio](https://github.com/grafana/k6-studio), a desktop application made to help you generate k6 scripts without having to touch code! ## Documentation The docs cover all aspects of using k6. Some highlights include: - [Get Started](https://grafana.com/docs/k6/latest/). Install, run a test, inspect results. - [HTTP requests](https://grafana.com/docs/k6/latest/using-k6/http-requests/). Have your virtual users use HTTP methods. Or, check the other [Protocols](https://grafana.com/docs/k6/latest/using-k6/protocols/). - [Thresholds](https://grafana.com/docs/k6/latest/using-k6/thresholds/). Set goals for your test, and codify your SLOs. - [Options](https://grafana.com/docs/k6/latest/using-k6/k6-options/). Configure your load, duration, TLS certificates, and much, much more. - [Scenarios](https://grafana.com/docs/k6/latest/using-k6/scenarios/). Choose how to model your workload: open models, closed models, constant RPS, fixed iterations, and more. - [Results output](https://grafana.com/docs/k6/latest/results-output/). Study, filter, and export your test results. - [JavaScript API](https://grafana.com/docs/k6/latest/javascript-api/). Reference and examples of all k6 modules. - [Extensions](https://grafana.com/docs/k6/latest/extensions/). Extend k6 for new protocols and use cases. These links barely scratch the surface! If you're looking for conceptual information, you can read about [Test types](https://grafana.com/docs/k6/latest/testing-guides/test-types/), [Test strategies](https://grafana.com/docs/k6/latest/testing-guides/), or one of the many informative [Blog posts](https://k6.io/blog). ## Roadmap Our team is dedicated to continuously improving and providing the best user experience possible. The [public roadmap](https://github.com/orgs/grafana/projects/443/views/1) covers user-oriented features, UX improvements and JavaScript support that our team will focus on. Remember that timeframes and priorities may shift, but we believe it's important to share our vision. We hope it provides a clear overview of our plans for future development. We welcome feedback, corrections, and suggestions via GitHub to make it more comprehensive, accessible, and valuable for the community. It's worth mentioning that we consider [upvotes (thumbs-up)](https://github.com/grafana/k6/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc) to be one of the essential metrics for determining community needs. If you want to show us the importance of a feature, please give it a thumbs-up. ## Contribute If you want to contribute or help with the development of k6, start by reading [CONTRIBUTING.md](CONTRIBUTING.md). Before you start coding, it might be a good idea to first discuss your plans and implementation details with the k6 maintainers—especially when it comes to big changes and features. You can do this in the [GitHub issue](https://github.com/grafana/k6/issues) for the problem you're solving (create one if it doesn't exist). > **Note:** To disclose security issues, refer to [SECURITY.md](https://github.com/grafana/k6?tab=security-ov-file). ## Support To get help, report bugs, suggest features, and discuss k6 with others, refer to [SUPPORT.md](SUPPORT.md). ## License k6 is distributed under the [AGPL-3.0 license](https://github.com/grafana/k6/blob/master/LICENSE.md). ## 2. Official Technical Reference & Guides (grafana/k6-docs) # k6 Documentation Welcome to the k6 docs! This repo contains the source code of the [k6 documentation](https://grafana.com/docs/k6/). Some key facts: - Issues and contributions are **always welcome**! - The docs are written in Markdown and built with Hugo. - The [Contributor's guide](./CONTRIBUTING) has meta-documentation about building locally, using special components and styling, deploying, troubleshooting, and more. - We have a [Code of conduct](https://github.com/grafana/k6-docs/blob/main/CODE_OF_CONDUCT.md). - We follow the Grafana Style Guide, and you can find more information about it in the [Writers' Toolkit](https://grafana.com/docs/writers-toolkit/). ## Contributing Don't feel shy about contributing! All input is welcome. No fix is too trivial. If something confuses you or feels lacking about the docs, make an issue. If you find something that you think you can fix, please go ahead. You don't need to ask permission. Markdown files for the documentation are located in the [`docs/sources/`](docs/sources) folder, with sub-folders for each k6 version. The URL structure is generated based on the folder structure and file names. For small changes and spelling fixes, the GitHub UI is the most convenient way to contribute. For larger contributions, consider running the project locally to see how the changes look like before making a pull request. The following docs cover the different stages of the writing workflow: - [Local development](#local-development). For any large changes, being able to see a preview of the site can help make sure things are rendered correctly, and spot any issues before they're deployed to production. - [Writers' Toolkit](https://grafana.com/docs/writers-toolkit/). Learn more about the Grafana writing style guide, front matter properties, how to upload and add images, and much more. - [Preview and deploy](./CONTRIBUTING#deploy). Changes made to the files inside of `docs/sources` are automatically deployed to production once they're merged to the main branch. For more details, refer to the [CONTRIBUTING](./CONTRIBUTING/README.md) section. ## Local development ### Before you begin To build the k6 docs in your machine, you'll need: - [Docker](https://docs.docker.com/engine/install/) or [Podman](https://podman.io/docs/installation) If you're using Docker, make sure you have the Docker Desktop application running. ### Build and preview Clone the repository to your machine: ```bash git clone https://github.com/grafana/k6-docs.git ``` Run `npm start`: ```bash npm start ``` You should see an output similar to this when the site finishes building: ```bash View documentation locally: http://localhost:3002/docs/k6/ Press Ctrl+C to stop the server ``` Go to http://localhost:3002/docs/k6/, and you should be able to see a preview of the docs.