For a basic product overview, check out our setup documentation.
For installation, configuration, and details about using the API, check out our API documentation.
For descriptions of terminology used in APM, take a look at the official documentation.
Before contributing to this open source project, read our CONTRIBUTING.md.
Since this project supports multiple Node versions, using a version manager such as nvm is recommended.
We use yarn for its workspace functionality, so make sure to install that as well.
To get started once you have Node and yarn installed, run:
Before running the tests, the data stores need to be running. The easiest way to start all of them is to use the provided docker-compose configuration:
$ docker-compose up -d -V --remove-orphans --force-recreate
To run the unit tests, use:
$ yarn test
To run the unit tests continuously in watch mode while developing, use:
$ yarn tdd
To run the memory leak tests, use:
$ yarn leak
Please note that memory leak tests only run on Node
We use ESLint to make sure that new code is conform to our coding standards.
To run the linter, use:
$ yarn lint
We rely on CircleCI 2.0 for our tests. If you want to test how the CI behaves locally, you can use the CircleCI Command Line Interface as described here: https://circleci.com/docs/2.0/local-jobs/
After installing the
circleci CLI, simply run one of the following:
$ circleci build --job lint $ circleci build --job node-leaks $ circleci build --job node-core-8 $ circleci build --job node-core-10 $ circleci build --job node-core-12 $ circleci build --job node-core-latest
When two or more approaches must be compared, please write a benchmark
benchmark/index.js module so that we can keep track of the
most efficient algorithm. To run your benchmark, just:
$ yarn bench