Skip to content

Commit 0cdd9ea

Browse files
authored
Merge pull request #411 from ByteInternet/set-up-tideways-on-hypernode
Set up tideways on hypernode
2 parents 4587bd9 + 9bb6651 commit 0cdd9ea

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
myst:
3+
html_meta:
4+
description: Enable Tideways profiling on Hypernode. Learn how to activate it,
5+
set the API key, configure sampling, and set an environment name.
6+
title: How to set up Tideways on Hypernode
7+
redirect_from:
8+
- /en/best-practices/performance/how-to-set-up-tideways/
9+
---
10+
11+
# How to Set Up Tideways on Hypernode
12+
13+
[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.
14+
15+
## Prerequisites
16+
17+
- A Tideways account and project. Create a new project in Tideways and note the project API key.
18+
19+
## How to Activate Tideways
20+
21+
### Activation Via the CLI
22+
23+
First, enable Tideways and set your project API key:
24+
25+
```bash
26+
hypernode-systemctl settings tideways_enabled True
27+
hypernode-systemctl settings tideways_api_key <api_key_here>
28+
```
29+
30+
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.
31+
32+
#### Optional: Configure Sample Rate
33+
34+
Sampling controls the percentage of requests that will be stored in Tideways, which helps manage cost. For example, to store 25% of samples:
35+
36+
```bash
37+
hypernode-systemctl settings tideways_sample_rate 25
38+
```
39+
40+
#### Optional: Set Environment Name
41+
42+
You can assign an environment label (for example when this node is a staging server):
43+
44+
```bash
45+
hypernode-systemctl settings tideways_env_name staging
46+
```
47+
48+
### Activation through Control Panel
49+
50+
It’s also possible to configure Tideways in the Control Panel.
51+
52+
1. Go to your **Hypernode** in the Control Panel
53+
1. Click **Settings**
54+
1. Go to the tab **Performance & Monitoring**
55+
1. Enable the toggle for **Tideways**, and set your API key in **Tideways API key**

0 commit comments

Comments
 (0)