Nyrkiö is an open source platform for change detection in a Continuous Performance Engineering workflow.
- Submit results using a REST API or GitHub Action
- Uses state of the art change point detection algorithm to find performance regressions and improvements in noisy data. Nyrkiö can find even small regressions down to 0.5% - 1%.
- Integrates with GitHub to identify the git commit that caused a change in performance
This software runs nyrkio.com. Some links to get you started:
Getting Started with Nyrkiö in 3 easy steps
Read more about how it works and who else is using it
Nyrkiö is a web service around the 8 year old, battle tested Apache Otava (incubating) command line tool. Otava was created and open sourced by the performance teams at MongoDB (2017) and Datastax (2020). It is used by technology companies large and small, such as Netflix, Dremio, Hazelcast...
Also the web service itself is open source.
The frontend is implemented using React and the backend is built on top of FastAPI and Pydantic.
If you want to hack on the frontend you can run npm directly from inside of the frontend directory.
The configuration file vite.config.js can be pointing to the real nyrkio.com backend API.
npm install
npm run devTo run the full stack on your own, use the docker-compose.dev.yml file which will start services
for the proxy (nginx), the frontend (ReactSingle-page app) and the backend (FastAPI app).
PACMAN=apt
#PACMAN=yum
#PACMAN=brew
git clone git@github.com:nyrkio/nyrkio.git
cd nyrkio
git submodule init
git submodule update
cat > .env.backend << END
DB_URL=mongodb://mongodb:27017/mongodb
DB_NAME=nyrkiodb
POSTMARK_API_KEY=
GITHUB_CLIENT_SECRET=
SECRET_KEY=
#HUNTER_CONFIG=
#GRAFANA_USER=
#GRAFANA_PASSWORD=
END
sudo $PACMAN install docker.io docker-compose-v2
sudo usermod -a -G docker $USER
newgrp docker
docker compose -f docker-compose.dev.yml up --buildPlease open a pull request with your changes against the main branch. PRs allow us to run linters and tests against your modifications.
- The Use of Change Point Detection to Identify Software Performance Regressions in a Continuous Integration System
- Hunter: Using Change Point Detection to Hunt for Performance
Licensed under the Apache License, Version 2.0 ("the license"); you may not use these files except in compliance with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Apache and Apache Otava are trademarks of the Apache Software Foundation Nyrkiö and Nyrkiö Change Detection are trademarks of Nyrkiö Oy