From cc77887c73580f48cec0249e6e2532900c93faa7 Mon Sep 17 00:00:00 2001 From: Jonathan Visser Date: Mon, 29 Sep 2025 10:17:34 +0200 Subject: [PATCH 1/3] Add documentation for setting up tideways --- .../performance/how-to-set-up-tideways.md | 45 +++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs/best-practices/performance/how-to-set-up-tideways.md diff --git a/docs/best-practices/performance/how-to-set-up-tideways.md b/docs/best-practices/performance/how-to-set-up-tideways.md new file mode 100644 index 00000000..7ab977e1 --- /dev/null +++ b/docs/best-practices/performance/how-to-set-up-tideways.md @@ -0,0 +1,45 @@ +--- +myst: + html_meta: + description: Enable Tideways profiling on Hypernode. Learn how to activate it, set the API key, configure sampling, and set an environment name. + title: How to set up Tideways on Hypernode +redirect_from: + - /en/best-practices/performance/how-to-set-up-tideways/ +--- + +# How to Set Up Tideways on Hypernode + +[Tideways](https://tideways.com/) is an application performance profiling and monitoring tool. On Hypernode you can enable Tideways in minutes using the CLI and control panel. + +## Prerequisites + +- A Tideways account and project. Create a new project in Tideways and note the project API key. + +## How to Activate Tideways + +### Activation Via the CLI + +First, enable Tideways and set your project API key: + +```bash +hypernode-systemctl settings tideways_enabled True +hypernode-systemctl settings tideways_api_key +``` + +After enabling, it can take a short while for data to appear in Tideways. We recommend generating some traffic on your shop to produce samples. + +### Optional: Configure Sample Rate + +Sampling controls the percentage of requests that will be stored in Tideways, which helps manage cost. For example, to store 25% of samples: + +```bash +hypernode-systemctl settings tideways_sample_rate 25 +``` + +### Optional: Set Environment Name + +You can assign an environment label (for example when this node is a staging server): + +```bash +hypernode-systemctl settings tideways_env_name staging +``` From fbaa815429a7154c9a0e57561a0660d757eafe4a Mon Sep 17 00:00:00 2001 From: Jonathan Visser Date: Mon, 29 Sep 2025 10:21:55 +0200 Subject: [PATCH 2/3] Add control panel steps for Tideways configuration --- .../performance/how-to-set-up-tideways.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/best-practices/performance/how-to-set-up-tideways.md b/docs/best-practices/performance/how-to-set-up-tideways.md index 7ab977e1..b33bae34 100644 --- a/docs/best-practices/performance/how-to-set-up-tideways.md +++ b/docs/best-practices/performance/how-to-set-up-tideways.md @@ -28,7 +28,7 @@ hypernode-systemctl settings tideways_api_key After enabling, it can take a short while for data to appear in Tideways. We recommend generating some traffic on your shop to produce samples. -### Optional: Configure Sample Rate +#### Optional: Configure Sample Rate Sampling controls the percentage of requests that will be stored in Tideways, which helps manage cost. For example, to store 25% of samples: @@ -36,10 +36,19 @@ Sampling controls the percentage of requests that will be stored in Tideways, wh hypernode-systemctl settings tideways_sample_rate 25 ``` -### Optional: Set Environment Name +#### Optional: Set Environment Name You can assign an environment label (for example when this node is a staging server): ```bash hypernode-systemctl settings tideways_env_name staging ``` + +### Activation through Control Panel + +It’s also possible to configure Tideways in the Control Panel. + +1. Go to your **Hypernode** in the Control Panel +2. Click **Settings** +3. Go to the tab **Performance & Monitoring** +4. Enable the toggle for **Tideways**, and set your API key in **Tideways API key** \ No newline at end of file From 9bb66510e4cf80eb6256fb65c688b2c5cd3e6cc5 Mon Sep 17 00:00:00 2001 From: Jonathan Visser Date: Mon, 29 Sep 2025 10:45:42 +0200 Subject: [PATCH 3/3] Run mdformatter --- .../best-practices/performance/how-to-set-up-tideways.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/best-practices/performance/how-to-set-up-tideways.md b/docs/best-practices/performance/how-to-set-up-tideways.md index b33bae34..e11dce53 100644 --- a/docs/best-practices/performance/how-to-set-up-tideways.md +++ b/docs/best-practices/performance/how-to-set-up-tideways.md @@ -1,7 +1,8 @@ --- myst: html_meta: - description: Enable Tideways profiling on Hypernode. Learn how to activate it, set the API key, configure sampling, and set an environment name. + description: Enable Tideways profiling on Hypernode. Learn how to activate it, + set the API key, configure sampling, and set an environment name. title: How to set up Tideways on Hypernode redirect_from: - /en/best-practices/performance/how-to-set-up-tideways/ @@ -49,6 +50,6 @@ hypernode-systemctl settings tideways_env_name staging It’s also possible to configure Tideways in the Control Panel. 1. Go to your **Hypernode** in the Control Panel -2. Click **Settings** -3. Go to the tab **Performance & Monitoring** -4. Enable the toggle for **Tideways**, and set your API key in **Tideways API key** \ No newline at end of file +1. Click **Settings** +1. Go to the tab **Performance & Monitoring** +1. Enable the toggle for **Tideways**, and set your API key in **Tideways API key**