Skip to content

Commit cc77887

Browse files
author
Jonathan Visser
committed
Add documentation for setting up tideways
1 parent 4587bd9 commit cc77887

File tree

1 file changed

+45
-0
lines changed

1 file changed

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

0 commit comments

Comments
 (0)