performance_bar.md 1.69 KB
Newer Older
Rémy Coutable's avatar
Rémy Coutable committed
1
2
3
4
5
6
7
# Performance Bar

A Performance Bar can be displayed, to dig into the performance of a page. When
activated, it looks as follows:

![Performance Bar](img/performance_bar.png)

8
It allows you to see (from left to right):
Rémy Coutable's avatar
Rémy Coutable committed
9

10
11
12
- the current host serving the page
- the timing of the page (backend, frontend)
- time taken and number of DB queries, click through for details of these queries
Rémy Coutable's avatar
Rémy Coutable committed
13
![SQL profiling using the Performance Bar](img/performance_bar_sql_queries.png)
14
15
16
- time taken and number of calls to Redis
- time taken and number of background jobs created by Sidekiq
- profile of the code used to generate the page, line by line for either _all_, _app & lib_ , or _views_. In the profile view, the numbers in the left panel represent wall time, cpu time, and number of calls (based on [rblineprof](https://github.com/tmm1/rblineprof)).
Rémy Coutable's avatar
Rémy Coutable committed
17
![Line profiling using the Performance Bar](img/performance_bar_line_profiling.png)
18
- time taken and number of Ruby GC calls
Rémy Coutable's avatar
Rémy Coutable committed
19

20
21
22
23
24
## Enable the Performance Bar via the Admin panel

GitLab Performance Bar is disabled by default. To enable it for a given group,
navigate to the Admin area in **Settings > Profiling - Performance Bar**
(`/admin/application_settings`).
Rémy Coutable's avatar
Rémy Coutable committed
25

26
27
28
29
The only required setting you need to set is the full path of the group that
will be allowed to display the Performance Bar.
Make sure _Enable the Performance Bar_ is checked and hit
**Save** to save the changes.
Rémy Coutable's avatar
Rémy Coutable committed
30

31
32
33
34
35
36
Once the Performance Bar is enabled, you will need to press the [<kbd>p</kbd> +
<kbd>b</kbd> keyboard shortcut](../../../workflow/shortcuts.md) to actually
display it.

You can toggle the Bar using the same shortcut.

37
38
39
---

![GitLab Performance Bar Admin Settings](img/performance_bar_configuration_settings.png)
Rémy Coutable's avatar
Rémy Coutable committed
40

41
---