Skip to main content

Documentation Index

Fetch the complete documentation index at: https://codspeed.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

CodSpeed is a continuous performance testing platform to track, compare and optimize the performance of your codebase during development, before having performance issues in production. Running benchmarks using a traditional statistical approaches is usually unreliable on CI environments. To measure the performance of your code in an accurate and reproducible way, CodSpeed uses various instruments when running your code. Those instruments isolate noisy neighbors and all the side effect they can have on when measuring the performance of our workloads. CodSpeed then brings concise performance reports during your development process. To help you improve your codebase performance and find bottlenecks, CodSpeed gives you extended insights, including detailed execution profiles for all your performance tests. For the most convenience, all these perks are directly available within your repository provider (Pull Requests comments and Merge checks).

​
What can be measured?

CodSpeed can measure the performance of different types of code, thanks to its instruments:
  • The core of CodSpeed is the CPU instrument. Use it measure the performance of algorithms, data processing steps, mathematical operations, and basically any kind CPU-bound tasks. Extensive data is collected during the execution of the code, which is used to create consistent performance measurement and detailed flame-graphs of the code.
  • The Walltime instrument measures the real time taken by your code to execute. It is useful to measure end-to-end performance of your code, including system calls, I/O operations, network requests, and database queries. It leverages CodSpeed’s Macro Runners to provide a stable and isolated environment for running your benchmarks with low noise and high precision.
  • The Databases instrument measure the performance of database queries. They allow you to track and compare the performance of your database queries during development.

​
How does it work?

Overview of CodSpeed's architecture The core of the performance measurement is done directly within your CI environment through the CodSpeed Action, allowing you to stay the sole owner of your data and to keep your codebase private. Once the performance data is generated, only the benchmark results are sent to the CodSpeed servers to be analyzed. Then, performance reports are generated and published directly within your Pull/Merge Request comments.

​
How long does it take to install?

The fastest way to get started is the CodSpeed Wizard, which automates the entire setup: it analyzes your repository, configures benchmarks, generates a CI workflow, and opens a pull request — all in minutes. If you prefer to set things up manually, you can plug your existing benchmark suites into CodSpeed in less than 5 minutes since CodSpeed’s benchmark API is compatible with the most popular benchmarking frameworks for each language. If you don’t have any benchmarks yet, you can get started by creating benchmarks. You can create your first benchmarks in just a few minutes by reusing existing unit tests.