Configuration: Tideways

It is possible to run sw-bench without connecting a Tideways account, but it does not provide a full performance picture.

To connect with Tideways, follow these steps:

1. If you haven't created a project on Tideways yet, you can start a 14 day trial.

2. Create an API Access Token with the scopes "cli", "traces", "metrics", "issues". See the Tideways documentation for details on Authentication and Scopes.

3. Copy the API access token into the tideways.apiToken section of the benchmarking profile JSON file.

4. Set the name of the project in the format "organization/project" into the tideways.project section of the benchmarking profile JSON file.

5. If you are using multiple environments in the Tideways project and the benchmark is using a different environment than the default production environment, then make sure to put the name in the tideways.environment section.

6. To generate detailed function-level callgraphs during the benchmark, set the tideways.apiKey to the projects API key. This is a different key from the REST API Access Token configured above. Note: We are working to making this configuration obselete in the near future. You also need to configure a sampling rate for callgraphs, and since these come with some overhead you should either disable them by setting them to "0" or use a low digit number such as 1.