summaryrefslogtreecommitdiff
path: root/doc/administration/monitoring/performance/request_profiling.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/administration/monitoring/performance/request_profiling.md')
-rw-r--r--doc/administration/monitoring/performance/request_profiling.md46
1 files changed, 34 insertions, 12 deletions
diff --git a/doc/administration/monitoring/performance/request_profiling.md b/doc/administration/monitoring/performance/request_profiling.md
index c32edb60f9d..a3b29493d84 100644
--- a/doc/administration/monitoring/performance/request_profiling.md
+++ b/doc/administration/monitoring/performance/request_profiling.md
@@ -1,17 +1,39 @@
+---
+stage: Monitor
+group: APM
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
+---
+
# Request Profiling
-## Procedure
+To profile a request:
+
+1. Sign in to GitLab as a user with Administrator or Maintainer [permissions](../../../user/permissions.md).
+1. In the navigation bar, click **{admin}** **Admin area**.
+1. Navigate to **{monitor}** **Monitoring > Requests Profiles**.
+1. In the **Requests Profiles** section, copy the token.
+1. Pass the headers `X-Profile-Token: <token>` and `X-Profile-Mode: <mode>`(where
+ `<mode>` can be `execution` or `memory`) to the request you want to profile. When
+ passing headers, you can use:
+
+ - Browser extensions such as the
+ [ModHeader](https://chrome.google.com/webstore/detail/modheader/idgpnmonknjnojddfkpgkljpfnnfcklj)
+ Chrome extension.
+ - `curl`. For example:
+
+ ```shell
+ curl --header 'X-Profile-Token: <token>' --header 'X-Profile-Mode: <mode>' "https://gitlab.example.com/group/project"
+ ```
+
+ NOTE: **Note:**
+ Profiled requests can take longer than usual.
+
+After the request completes, you can view the profiling output from the
+**{monitor}** **Monitoring > Requests Profiles** administration page:
-1. Grab the profiling token from **Monitoring > Requests Profiles** admin page
- (highlighted in a blue in the image below).
- ![Profile token](img/request_profiling_token.png)
-1. Pass the header `X-Profile-Token: <token>` and `X-Profile-Mode: <mode>`(where `<mode>` can be `execution` or `memory`) to the request you want to profile. You can use:
- - Browser extensions. For example, [ModHeader](https://chrome.google.com/webstore/detail/modheader/idgpnmonknjnojddfkpgkljpfnnfcklj) Chrome extension.
- - `curl`. For example, `curl --header 'X-Profile-Token: <token>' --header 'X-Profile-Mode: <mode>' https://gitlab.example.com/group/project`.
-1. Once request is finished (which will take a little longer than usual), you can
- view the profiling output from **Monitoring > Requests Profiles** admin page.
- ![Profiling output](img/request_profile_result.png)
+![Profiling output](img/request_profile_result.png)
-## Cleaning up
+## Cleaning up profiled requests
-Profiling output will be cleared out every day via a Sidekiq worker.
+The output from profiled requests is cleared out once each day through a
+Sidekiq worker.