summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRémy Coutable <remy@rymai.me>2017-07-06 18:57:02 +0200
committerRémy Coutable <remy@rymai.me>2017-07-06 18:57:02 +0200
commit040eeb1039b4298ea56a670a0a4ae511288806d6 (patch)
tree6777d4d6c4fb1322f0d6ef7c4d2a59195aef3255 /doc
parentde9eca0af65e8fd235aed8c9ea598f16562956e7 (diff)
downloadgitlab-ce-040eeb1039b4298ea56a670a0a4ae511288806d6.tar.gz
Allow to enable the Performance Bar for a group from the admin area
Signed-off-by: Rémy Coutable <remy@rymai.me>
Diffstat (limited to 'doc')
-rw-r--r--doc/administration/monitoring/performance/img/performance_bar_configuration_settings.pngbin0 -> 20385 bytes
-rw-r--r--doc/administration/monitoring/performance/performance_bar.md50
2 files changed, 26 insertions, 24 deletions
diff --git a/doc/administration/monitoring/performance/img/performance_bar_configuration_settings.png b/doc/administration/monitoring/performance/img/performance_bar_configuration_settings.png
new file mode 100644
index 00000000000..2d64ef8c5fc
--- /dev/null
+++ b/doc/administration/monitoring/performance/img/performance_bar_configuration_settings.png
Binary files differ
diff --git a/doc/administration/monitoring/performance/performance_bar.md b/doc/administration/monitoring/performance/performance_bar.md
index 409a74d2f91..6ee21eae194 100644
--- a/doc/administration/monitoring/performance/performance_bar.md
+++ b/doc/administration/monitoring/performance/performance_bar.md
@@ -1,9 +1,5 @@
# Performance Bar
->**Note:**
-Available since GitLab 9.4. For installations from source you'll have to
-configure it yourself.
-
A Performance Bar can be displayed, to dig into the performance of a page. When
activated, it looks as follows:
@@ -21,38 +17,44 @@ It allows you to:
- profile the code used to generate the page, line by line
![Line profiling using the Performance Bar](img/performance_bar_line_profiling.png)
-## Enable the Performance Bar
+## 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`).
+
+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.
+
+---
+
+![GitLab Performance Bar Admin Settings](img/performance_bar_configuration_settings.png)
-By default, the Performance Bar is disabled. You can enable it for a group
-and/or users. Note that it's possible to enable it for a group and for
-individual users at the same time.
+---
-1. Edit `/etc/gitlab/gitlab.rb`
-1. Find the following line, and set it to the group's **full path** that should
-be allowed to use the Performance Bar:
+## Enable the Performance Bar via the API
- ```ruby
- gitlab_rails['performance_bar_allowed_group'] = 'your-org/your-performance-group'
- ```
+Under the hood, the Performance Bar activation is done via the `performance_bar`
+[Feature Flag](../../../development/features_flags.md).
-1. Save the file and [reconfigure GitLab][reconfigure] for the changes to
- take effect
-1. The Performance Bar can then be enabled via the
- [Features API](../../../api/features.md#set-or-create-a-feature) (see below).
+That means you can also enable or disable it via the
+[Features API](../../../api/features.md#set-or-create-a-feature).
-### Enable for the `performance_team` feature group
+### For the `performance_team` feature group
-The `performance_team` feature group maps to the group specified by the
-`performance_bar_allowed_group` setting you've set in the previous step.
+The `performance_team` feature group maps to the group specified in your [Admin
+area](#enable-the-performance-bar-via-the-admin-panel).
```
curl --data "feature_group=performance_team" --data "value=true" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/features/performance_bar
```
-### Enable for specific users
+### For specific users
-It's possible to enable the Performance Bar for specific users in addition to a
-group, or even instead of a group:
+It's also possible to enable the Performance Bar for specific users in addition
+to a group, or even instead of a group:
```
curl --data "user=my_username" --data "value=true" --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/features/performance_bar