Commit ca35eac9 authored by Amy Qualls's avatar Amy Qualls

Crop and compress images

The screencaps on this page were larger in file size than needed,
and often contained too much screen real estate. This commit crops
them down and runs them through pngquant to reduce file size.
parent 22571bf5
...@@ -83,6 +83,7 @@ compilable ...@@ -83,6 +83,7 @@ compilable
composable composable
Conda Conda
Consul Consul
Contentful
Corosync Corosync
cron cron
crons crons
......
...@@ -6,71 +6,82 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -6,71 +6,82 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Performance Bar # Performance Bar
A Performance Bar can be displayed, to dig into the performance of a page. When You can display the GitLab Performance Bar to see statistics for the performance
activated, it looks as follows: of a page. When activated, it looks as follows:
![Performance Bar](img/performance_bar.png) ![Performance Bar](img/performance_bar.png)
It allows you to see (from left to right): From left to right, it displays:
- the current host serving the page - **Current Host**: the current host serving the page.
- time taken and number of DB queries; click through for details of these queries - **Database queries**: the time taken (in milliseconds) and the total number
of database queries, displayed in the format `00ms / 00pg`. Click to display
a modal window with more details:
![SQL profiling using the Performance Bar](img/performance_bar_sql_queries.png) ![SQL profiling using the Performance Bar](img/performance_bar_sql_queries.png)
- time taken and number of [Gitaly](../../gitaly/index.md) calls; click through for details of these calls - **Gitaly calls**: the time taken (in milliseconds) and the total number of
[Gitaly](../../gitaly/index.md) calls. Click to display a modal window with more
details:
![Gitaly profiling using the Performance Bar](img/performance_bar_gitaly_calls.png) ![Gitaly profiling using the Performance Bar](img/performance_bar_gitaly_calls.png)
- time taken and number of [Rugged](../../high_availability/nfs.md#improving-nfs-performance-with-gitlab) calls; click through for details of these calls - **Rugged calls**: the time taken (in milliseconds) and the total number of
[Rugged](../../high_availability/nfs.md#improving-nfs-performance-with-gitlab) calls.
Click to display a modal window with more details:
![Rugged profiling using the Performance Bar](img/performance_bar_rugged_calls.png) ![Rugged profiling using the Performance Bar](img/performance_bar_rugged_calls.png)
- time taken and number of Redis calls; click through for details of these calls - **Redis calls**: the time taken (in milliseconds) and the total number of
Redis calls. Click to display a modal window with more details:
![Redis profiling using the Performance Bar](img/performance_bar_redis_calls.png) ![Redis profiling using the Performance Bar](img/performance_bar_redis_calls.png)
- total load timings of the page; click through for details of these calls. Values in the following order: - **Elasticsearch calls**: the time taken (in milliseconds) and the total number of
- Backend - Time that the actual base page took to load Elasticsearch calls. Click to display a modal window with more details.
- [First Contentful Paint](hhttps://web.dev/first-contentful-paint/) - Time until something was visible to the user - **Load timings** of the page: several values in milliseconds, separated by slashes.
- [DomContentLoaded](https://developers.google.com/web/fundamentals/performance/critical-rendering-path/measure-crp) Event Click to display a modal window with more details. The values, from left to right:
- Number of Requests that the page loaded - **Backend**: time needed for the base page to load.
- [**First Contentful Paint**](https://web.dev/first-contentful-paint/):
Time until something was visible to the user.
- [**DomContentLoaded**](https://developers.google.com/web/fundamentals/performance/critical-rendering-path/measure-crp) Event.
- **Total number of requests** the page loaded:
![Frontend requests using the Performance Bar](img/performance_bar_frontend.png) ![Frontend requests using the Performance Bar](img/performance_bar_frontend.png)
- a link to add a request's details to the performance bar; the request can be - **Trace**: If Jaeger is integrated, **Trace** links to a Jaeger tracing page
added by its full URL (authenticated as the current user), or by the value of with the current request's `correlation_id` included.
its `X-Request-Id` header - **+**: A link to add a request's details to the performance bar. The request
- a link to download the raw JSON used to generate the Performance Bar reports can be added by its full URL (authenticated as the current user), or by the value of
its `X-Request-Id` header.
On the far right is a request selector that allows you to view the same metrics - **Download**: a link to download the raw JSON used to generate the Performance Bar reports.
(excluding the page timing and line profiler) for any requests made while the - **Request Selector**: a select box displayed on the right-hand side of the
page was open. Only the first two requests per unique URL are captured. Performance Bar which enables you to view these metrics for any requests made while
the current page was open. Only the first two requests per unique URL are captured.
## Request warnings ## Request warnings
For requests exceeding predefined limits, a warning icon will be shown Requests exceeding predefined limits display a warning **{warning}** icon and
next to the failing metric, along with an explanation. In this example, explanation next to the failing metric. In this example, the Gitaly call duration
the Gitaly call duration exceeded the threshold: exceeded the threshold:
![Gitaly call duration exceeded threshold](img/performance_bar_gitaly_threshold.png) ![Gitaly call duration exceeded threshold](img/performance_bar_gitaly_threshold.png)
If any requests on the current page generated warnings, the icon will If any requests on the current page generated warnings, the warning icon displays
appear next to the request selector: next to the **Request selector**:
![Request selector showing two requests with warnings](img/performance_bar_request_selector_warning.png) ![Request selector showing two requests with warnings](img/performance_bar_request_selector_warning.png)
And requests with warnings are indicated in the request selector with a Requests with warnings display `(!)` after their path in the **Request selector**:
`(!)` after their path:
![Request selector showing dropdown](img/performance_bar_request_selector_warning_expanded.png) ![Request selector showing dropdown](img/performance_bar_request_selector_warning_expanded.png)
## Enable the Performance Bar via the Admin panel ## Enable the Performance Bar via the Admin panel
GitLab Performance Bar is disabled by default. To enable it for a given group, The GitLab Performance Bar is disabled by default. To enable it for a given group:
navigate to **Admin Area > Settings > Metrics and profiling**
(`admin/application_settings/metrics_and_profiling`), and expand the section
**Profiling - Performance bar**.
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.
Once the Performance Bar is enabled, you will need to press the [<kbd>p</kbd> + 1. Sign in as a user with Administrator [permissions](../../../user/permissions.md).
<kbd>b</kbd> keyboard shortcut](../../../user/shortcuts.md) to actually 1. In the menu bar, click the **{admin}** **Admin Area** icon.
display it. 1. Navigate to **{settings}** **Settings > Metrics and profiling**
(`admin/application_settings/metrics_and_profiling`), and expand the section
**Profiling - Performance bar**.
1. Click **Enable access to the Performance Bar**.
1. In the **Allowed group** field, provide the full path of the group allowed
to access the GitLab Performance Bar.
1. Click **Save changes**.
You can toggle the Bar using the same shortcut. ## Keyboard shortcut for the Performance Bar
![GitLab Performance Bar Admin Settings](img/performance_bar_configuration_settings.png) After enabling the GitLab Performance Bar, press the [<kbd>p</kbd> +
<kbd>b</kbd> keyboard shortcut](../../../user/shortcuts.md) to display it, and
again to hide it.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment