Skip to content

Add X-Ray serverwide mode documentation #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
annkots merged 2 commits into from
Dec 5, 2023
Merged

Add X-Ray serverwide mode documentation #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a6af86
Add serverwide mode to README.md
Monstrofil Dec 4, 2023
24d4710
Rearrange docs sections and add copy to Solo
Monstrofil Dec 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/shared-pro/x-ray/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,24 @@ X-Ray Autotracing is installed and enabled by default on all new compatible serv

![](./images/XRayStartTracing.png)

## X-Ray serverwide mode

With X-Ray v0.6-11 we introduced global X-Ray mode which enables tracing extension for all PHP versions on the servers. This
mode allows your customers to [override PHP versions](https://cloudlinux.zendesk.com/hc/en-us/articles/115004537805-Different-PHP-versions-per-directories-using-mod-lsapi)
in different folders and trace websites located in those folders.

In order to enable this mode, type the following command:
```
cloudlinux-xray-manager enable-serverwide-mode
```

In order to get back to default:
```
cloudlinux-xray-manager disable-serverwide-mode
```

Enable and disable commands do not stop or remove tracing tasks.

## How to manage X-Ray

X-Ray provides several options for monitoring domain requests speed: Manual Tracing task, X-Ray Autotracing and Continuous tracing.
Expand Down Expand Up @@ -1010,13 +1028,20 @@ The <span class="notranslate">X-Ray</span> agent is managed by the <span class="
```
</div>


## FAQ

### Does X-Ray affect website performance?

<span class="notranslate">X-Ray</span> affects website performance. Our tests show 5-10 % overhead from a website loading time with <span class="notranslate">X-Ray</span> tracing enabled.
<span class="notranslate">X-Ray</span> allows you to find website performance issues and should not be enabled permanently. If your website is very slow, you can enable <span class="notranslate">X-Ray</span> to find the cause and then disable it.


### My customers [override php versions](https://cloudlinux.zendesk.com/hc/en-us/articles/115004537805-Different-PHP-versions-per-directories-using-mod-lsapi) in different folders and X-Ray does not trace those websites, what should I do?

You should turn on the [X-Ray serverwide mode](#x-ray-serverwide-mode) which allows X-Ray to trace website regardless of their PHP version.


### What should I do if I see the warning "Task is duplicated by URL"?

This warning means that you already have a task to trace this URL in the list of your tracing tasks. If you see this warning, a new task can be created only with the <span class="notranslate">_On hold_</span> status and you will be able to run it only when the previous task with the same URL will be completed.
Expand Down
25 changes: 25 additions & 0 deletions docs/solo/manager/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,25 @@ X-Ray provides two options for monitoring domain requests speed: Tracing task an

In fact, continuous task allows to automatically create a tracing task for each new day, with the ability to get a report for the past day.


## X-Ray serverwide mode

With X-Ray v0.6-11 we introduced global X-Ray mode which enables tracing extension for all PHP versions on the servers. This
mode allows your customers to [override PHP versions](https://cloudlinux.zendesk.com/hc/en-us/articles/115004537805-Different-PHP-versions-per-directories-using-mod-lsapi)
in different folders and trace websites located in those folders.

In order to enable this mode, type the following command:
```
cloudlinux-xray-manager enable-serverwide-mode
```

In order to get back to default:
```
cloudlinux-xray-manager disable-serverwide-mode
```

Enable and disable commands do not stop or remove tracing tasks.

#### Tracing tasks tab

The *Tracing tasks* tab contains a list of all tracing tasks created both manually and automatically via continuous tasks.
Expand Down Expand Up @@ -1020,6 +1039,12 @@ The <span class="notranslate">X-Ray</span> agent is managed by the <span class="
<span class="notranslate">X-Ray</span> affects website performance. Our tests show 5-10 % overhead from a website loading time with <span class="notranslate">X-Ray</span> tracing enabled.
<span class="notranslate">X-Ray</span> allows you to find website performance issues and should not be enabled permanently. If your website is very slow, you can enable <span class="notranslate">X-Ray</span> to find the cause and then disable it.


### My customers [override php versions](https://cloudlinux.zendesk.com/hc/en-us/articles/115004537805-Different-PHP-versions-per-directories-using-mod-lsapi) in different folders and X-Ray does not trace those websites, what should I do?

You should turn on the [X-Ray serverwide mode](#x-ray-serverwide-mode) which allows X-Ray to trace website regardless of their PHP version.


#### What should I do if I see the warning "Task is duplicated by URL"?

This warning means that you already have a task to trace this URL in the list of your tracing tasks. If you see this warning, a new task can be created only with the <span class="notranslate">_On hold_</span> status and you will be able to run it only when the previous task with the same URL will be completed.
Expand Down