Skip to content

Latest commit

 

History

History
88 lines (71 loc) · 4.5 KB

performance_bar.md

File metadata and controls

88 lines (71 loc) · 4.5 KB
Raw
stage group info
Monitor
Health
To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

Performance Bar

You can display the GitLab Performance Bar to see statistics for the performance of a page. When activated, it looks as follows:

Performance Bar

From left to right, it displays:

  • Current Host: the current host serving the page.
  • Database queries: the time taken (in milliseconds) and the total number of database queries, displayed in the format 00ms / 00 (00 cached) pg. Click to display a modal window with more details: SQL profiling using the Performance Bar
  • Gitaly calls: the time taken (in milliseconds) and the total number of Gitaly calls. Click to display a modal window with more details: Gitaly profiling using the Performance Bar
  • Rugged calls: the time taken (in milliseconds) and the total number of Rugged calls. Click to display a modal window with more details: Rugged profiling using the Performance Bar
  • 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
  • Elasticsearch calls: the time taken (in milliseconds) and the total number of Elasticsearch calls. Click to display a modal window with more details.
  • Load timings of the page: if your browser supports load timings (Chromium and Chrome) several values in milliseconds, separated by slashes. Click to display a modal window with more details. The values, from left to right:
  • Trace: If Jaeger is integrated, Trace links to a Jaeger tracing page with the current request's correlation_id included.
  • +: A link to add a request's details to the performance bar. The request can be added by its full URL (authenticated as the current user), or by the value of its X-Request-Id header.
  • Download: a link to download the raw JSON used to generate the Performance Bar reports.
  • Request Selector: a select box displayed on the right-hand side of the 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

Requests exceeding predefined limits display a warning {warning} icon and explanation next to the failing metric. In this example, the Gitaly call duration exceeded the threshold:

Gitaly call duration exceeded threshold

If any requests on the current page generated warnings, the warning icon displays next to the Request selector:

Request selector showing two requests with warnings

Requests with warnings display (!) after their path in the Request selector:

Request selector showing dropdown

Enable the Performance Bar via the Admin panel

The GitLab Performance Bar is disabled by default. To enable it for a given group:

  1. Sign in as a user with Administrator permissions.
  2. In the menu bar, click Admin Area.
  3. Navigate to Settings > Metrics and profiling (admin/application_settings/metrics_and_profiling), and expand the section Profiling - Performance bar.
  4. Click Enable access to the Performance Bar.
  5. In the Allowed group field, provide the full path of the group allowed to access the GitLab Performance Bar.
  6. Click Save changes.

Keyboard shortcut for the Performance Bar

After enabling the GitLab Performance Bar, press the p + b keyboard shortcut to display it, and again to hide it.