Merge branch 'pawel/prometheus_multiproc_dir_documentation' into 'master'

Documentation and link to explanation of prometheus_multiproc_dir

See merge request !12956

2 files changed, 24 insertions, 5 deletions

diff --git a/app/views/admin/application_settings/_form.html.haml b/app/views/admin/application_settings/_form.html.haml
index 7f1e13c7989..711001df47a 100644
--- a/app/views/admin/application_settings/_form.html.haml
+++ b/app/views/admin/application_settings/_form.html.haml
@@ -315,7 +315,9 @@
   %fieldset
     %legend Metrics - Prometheus
     %p
-      Enable a Prometheus metrics endpoint at `#{metrics_path}` to expose a variety of statistics on the health and performance of GitLab. Additional information on authenticating and connecting to the metrics endpoint is available
+      Enable a Prometheus metrics endpoint at
+      %code= metrics_path
+      to expose a variety of statistics on the health and performance of GitLab. Additional information on authenticating and connecting to the metrics endpoint is available
       = link_to 'here', admin_health_check_path
       \. This setting requires a
       = link_to 'restart', help_page_path('administration/restart_gitlab')
@@ -327,10 +329,13 @@
           = f.label :prometheus_metrics_enabled do
             = f.check_box :prometheus_metrics_enabled
             Enable Prometheus Metrics
-            - unless Gitlab::Metrics.metrics_folder_present?
-              .help-block
-                %strong.cred WARNING:
-                Environment variable `prometheus_multiproc_dir` does not exist or is not pointing to a valid directory.
+          - unless Gitlab::Metrics.metrics_folder_present?
+            .help-block
+              %strong.cred WARNING:
+              Environment variable
+              %code prometheus_multiproc_dir
+              does not exist or is not pointing to a valid directory.
+              = link_to icon('question-circle'), help_page_path('administration/monitoring/prometheus/gitlab_metrics', anchor: 'metrics-shared-directory')
 
   %fieldset
     %legend Profiling - Performance Bar
diff --git a/doc/administration/monitoring/prometheus/gitlab_metrics.md b/doc/administration/monitoring/prometheus/gitlab_metrics.md
index c1c1512d870..7b5ee3dfe05 100644
--- a/doc/administration/monitoring/prometheus/gitlab_metrics.md
+++ b/doc/administration/monitoring/prometheus/gitlab_metrics.md
@@ -42,6 +42,20 @@ In this experimental phase, only a few metrics are available:
 | filesystem_readable | gauge | Whether or not the filesystem is readable |
 | user_sessions_logins | Counter | Counter of how many users have logged in | 
 
+## Metrics shared directory
+
+GitLab's Prometheus client requires a directory to store metrics data shared between multi-process services.
+Those files are shared among all instances running under Unicorn server.
+The directory needs to be accessible to all running Unicorn's processes otherwise
+metrics will not function correctly.
+
+For best performance its advisable that this directory will be located in `tmpfs`.
+
+Its location is configured using environment variable `prometheus_multiproc_dir`.
+
+If GitLab is installed using Omnibus and `tmpfs` is available then metrics
+directory will be automatically configured.
+
 [← Back to the main Prometheus page](index.md)
 
 [29118]: https://gitlab.com/gitlab-org/gitlab-ce/issues/29118