diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-06-10 15:08:07 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-06-10 15:08:07 +0000 |
commit | f2f748c08166ef350aa4183242c3611f6617f651 (patch) | |
tree | ba7073499e5e1396962c532b2752bdec3301be1d /doc/administration | |
parent | 0211553b0cd32ddcd49fbe61fdb318984d15af18 (diff) | |
download | gitlab-ce-f2f748c08166ef350aa4183242c3611f6617f651.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/administration')
-rw-r--r-- | doc/administration/monitoring/performance/img/request_profiling_token.png | bin | 17396 -> 0 bytes | |||
-rw-r--r-- | doc/administration/monitoring/performance/request_profiling.md | 40 | ||||
-rw-r--r-- | doc/administration/server_hooks.md | 3 |
3 files changed, 31 insertions, 12 deletions
diff --git a/doc/administration/monitoring/performance/img/request_profiling_token.png b/doc/administration/monitoring/performance/img/request_profiling_token.png Binary files differdeleted file mode 100644 index ee819fcb437..00000000000 --- a/doc/administration/monitoring/performance/img/request_profiling_token.png +++ /dev/null diff --git a/doc/administration/monitoring/performance/request_profiling.md b/doc/administration/monitoring/performance/request_profiling.md index 98774930cd2..a3b29493d84 100644 --- a/doc/administration/monitoring/performance/request_profiling.md +++ b/doc/administration/monitoring/performance/request_profiling.md @@ -6,18 +6,34 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Request Profiling -## Procedure +To profile a request: -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) +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: -## Cleaning up + - Browser extensions such as the + [ModHeader](https://chrome.google.com/webstore/detail/modheader/idgpnmonknjnojddfkpgkljpfnnfcklj) + Chrome extension. + - `curl`. For example: -Profiling output will be cleared out every day via a Sidekiq worker. + ```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: + +![Profiling output](img/request_profile_result.png) + +## Cleaning up profiled requests + +The output from profiled requests is cleared out once each day through a +Sidekiq worker. diff --git a/doc/administration/server_hooks.md b/doc/administration/server_hooks.md index e01cdb990ab..8e9aa4d476a 100644 --- a/doc/administration/server_hooks.md +++ b/doc/administration/server_hooks.md @@ -1,4 +1,7 @@ --- +stage: Create +group: Gitaly +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 type: reference, howto disqus_identifier: 'https://docs.gitlab.com/ee/administration/custom_hooks.html' --- |