From 6c97f9f5ec1f8c59ebcaf6bf8a71432e89a1d993 Mon Sep 17 00:00:00 2001 From: Stan Hu Date: Fri, 19 Jul 2019 13:21:07 -0700 Subject: Add docs for ENABLE_BOOTSNAP --- doc/administration/environment_variables.md | 1 + 1 file changed, 1 insertion(+) (limited to 'doc/administration') diff --git a/doc/administration/environment_variables.md b/doc/administration/environment_variables.md index 874b1f3c80d..37d7194af53 100644 --- a/doc/administration/environment_variables.md +++ b/doc/administration/environment_variables.md @@ -13,6 +13,7 @@ override certain values. Variable | Type | Description -------- | ---- | ----------- +`ENABLE_BOOTSNAP` | string | Enables Bootsnap for speeding up initial Rails boot (`1` to enable) `GITLAB_CDN_HOST` | string | Sets the base URL for a CDN to serve static assets (e.g. `//mycdnsubdomain.fictional-cdn.com`) `GITLAB_ROOT_PASSWORD` | string | Sets the password for the `root` user on installation `GITLAB_HOST` | string | The full URL of the GitLab server (including `http://` or `https://`) -- cgit v1.2.1 From 785b9b02ded3d2e973afc3c7d12e1a126a23240c Mon Sep 17 00:00:00 2001 From: Marcel Amirault Date: Mon, 22 Jul 2019 01:49:37 +0000 Subject: Fix unordered list spacing Correct the spacing of unordered markdown lists in docs, to maintain standards of documentation, in /user and others. --- doc/administration/gitaly/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/administration') diff --git a/doc/administration/gitaly/index.md b/doc/administration/gitaly/index.md index 0ef88a26ab9..0f547ef03bf 100644 --- a/doc/administration/gitaly/index.md +++ b/doc/administration/gitaly/index.md @@ -359,7 +359,7 @@ To configure Gitaly with TLS: gitaly['tls_listen_addr'] = "0.0.0.0:9999" gitaly['certificate_path'] = "path/to/cert.pem" gitaly['key_path'] = "path/to/key.pem" - ``` + ``` 1. Save the file and [reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). -- cgit v1.2.1 From 71045b89f6f0e9c347526b2d90f945dfbcbebdcc Mon Sep 17 00:00:00 2001 From: Stan Hu Date: Fri, 19 Jul 2019 15:17:54 -0700 Subject: Convert githost.log to JSON format This will make it easier to parse this in production and adds the `correlation_id` if available. --- doc/administration/logs.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) (limited to 'doc/administration') diff --git a/doc/administration/logs.md b/doc/administration/logs.md index 5a2f389d298..563701b8677 100644 --- a/doc/administration/logs.md +++ b/doc/administration/logs.md @@ -157,16 +157,22 @@ This file lives in `/var/log/gitlab/gitlab-rails/githost.log` for Omnibus GitLab packages or in `/home/git/gitlab/log/githost.log` for installations from source. +NOTE: **Note:** +After 12.2, this file will be stored in JSON format. + GitLab has to interact with Git repositories but in some rare cases something can go wrong and in this case you will know what exactly happened. This log file contains all failed requests from GitLab to Git repositories. In the majority of cases this file will be useful for developers only. For example: -``` -December 03, 2014 13:20 -> ERROR -> Command failed [1]: /usr/bin/git --git-dir=/Users/vsizov/gitlab-development-kit/gitlab/tmp/tests/gitlab-satellites/group184/gitlabhq/.git --work-tree=/Users/vsizov/gitlab-development-kit/gitlab/tmp/tests/gitlab-satellites/group184/gitlabhq merge --no-ff -mMerge branch 'feature_conflict' into 'feature' source/feature_conflict - -error: failed to push some refs to '/Users/vsizov/gitlab-development-kit/repositories/gitlabhq/gitlab_git.git' +```json +{ + "severity":"ERROR", + "time":"2019-07-19T22:16:12.528Z", + "correlation_id":"FeGxww5Hj64", + "message":"Command failed [1]: /usr/bin/git --git-dir=/Users/vsizov/gitlab-development-kit/gitlab/tmp/tests/gitlab-satellites/group184/gitlabhq/.git --work-tree=/Users/vsizov/gitlab-development-kit/gitlab/tmp/tests/gitlab-satellites/group184/gitlabhq merge --no-ff -mMerge branch 'feature_conflict' into 'feature' source/feature_conflict\n\nerror: failed to push some refs to '/Users/vsizov/gitlab-development-kit/repositories/gitlabhq/gitlab_git.git'" +} ``` ## `audit_json.log` -- cgit v1.2.1 From 3c9d75e045c94e25a53e78257b47c938f9c538a2 Mon Sep 17 00:00:00 2001 From: manojmj Date: Tue, 23 Jul 2019 11:44:09 +0530 Subject: CE Port: Log impersonation actions in audit log This change adds audit logs for user impersonation when an admin starts/stops impersonating another user. --- doc/administration/audit_events.md | 1 + 1 file changed, 1 insertion(+) (limited to 'doc/administration') diff --git a/doc/administration/audit_events.md b/doc/administration/audit_events.md index a80ff330e03..aaa43f67760 100644 --- a/doc/administration/audit_events.md +++ b/doc/administration/audit_events.md @@ -94,6 +94,7 @@ recorded: - Changed password - Ask for password reset - Grant OAuth access +- Started/stopped user impersonation It is possible to filter particular actions by choosing an audit data type from the filter drop-down. You can further filter by specific group, project or user -- cgit v1.2.1 From 667b92a3a4e0fada63703bcb170f49da13f9a40a Mon Sep 17 00:00:00 2001 From: Stan Hu Date: Tue, 23 Jul 2019 22:25:23 -0700 Subject: Update performance bar documentation --- .../monitoring/performance/img/performance_bar.png | Bin 99331 -> 127198 bytes .../img/performance_bar_gitaly_calls.png | Bin 91275 -> 203373 bytes .../img/performance_bar_redis_calls.png | Bin 0 -> 191734 bytes .../img/performance_bar_rugged_calls.png | Bin 0 -> 274852 bytes .../img/performance_bar_sql_queries.png | Bin 128337 -> 338952 bytes .../monitoring/performance/performance_bar.md | 8 +++++--- 6 files changed, 5 insertions(+), 3 deletions(-) create mode 100644 doc/administration/monitoring/performance/img/performance_bar_redis_calls.png create mode 100644 doc/administration/monitoring/performance/img/performance_bar_rugged_calls.png (limited to 'doc/administration') diff --git a/doc/administration/monitoring/performance/img/performance_bar.png b/doc/administration/monitoring/performance/img/performance_bar.png index 2bf686f9017..8a6f8b3b273 100644 Binary files a/doc/administration/monitoring/performance/img/performance_bar.png and b/doc/administration/monitoring/performance/img/performance_bar.png differ diff --git a/doc/administration/monitoring/performance/img/performance_bar_gitaly_calls.png b/doc/administration/monitoring/performance/img/performance_bar_gitaly_calls.png index 7af6d401d1d..265178729c4 100644 Binary files a/doc/administration/monitoring/performance/img/performance_bar_gitaly_calls.png and b/doc/administration/monitoring/performance/img/performance_bar_gitaly_calls.png differ diff --git a/doc/administration/monitoring/performance/img/performance_bar_redis_calls.png b/doc/administration/monitoring/performance/img/performance_bar_redis_calls.png new file mode 100644 index 00000000000..78dd7594adf Binary files /dev/null and b/doc/administration/monitoring/performance/img/performance_bar_redis_calls.png differ diff --git a/doc/administration/monitoring/performance/img/performance_bar_rugged_calls.png b/doc/administration/monitoring/performance/img/performance_bar_rugged_calls.png new file mode 100644 index 00000000000..f4068268137 Binary files /dev/null and b/doc/administration/monitoring/performance/img/performance_bar_rugged_calls.png differ diff --git a/doc/administration/monitoring/performance/img/performance_bar_sql_queries.png b/doc/administration/monitoring/performance/img/performance_bar_sql_queries.png index b3219b4fa94..dab323eb066 100644 Binary files a/doc/administration/monitoring/performance/img/performance_bar_sql_queries.png and b/doc/administration/monitoring/performance/img/performance_bar_sql_queries.png differ diff --git a/doc/administration/monitoring/performance/performance_bar.md b/doc/administration/monitoring/performance/performance_bar.md index 4ee156fdc11..15eab7dcab0 100644 --- a/doc/administration/monitoring/performance/performance_bar.md +++ b/doc/administration/monitoring/performance/performance_bar.md @@ -8,15 +8,16 @@ activated, it looks as follows: It allows you to see (from left to right): - the current host serving the page -- the timing of the page (backend, frontend) - time taken and number of DB queries, click through for details of these queries ![SQL profiling using the Performance Bar](img/performance_bar_sql_queries.png) - time taken and number of [Gitaly] calls, click through for details of these calls ![Gitaly profiling using the Performance Bar](img/performance_bar_gitaly_calls.png) +- time taken and number of [Rugged] calls, click through for details of these calls + ![Rugged profiling using the Performance Bar](img/performance_bar_rugged_calls.png) - profile of the code used to generate the page, line by line. In the profile view, the numbers in the left panel represent wall time, cpu time, and number of calls (based on [rblineprof](https://github.com/tmm1/rblineprof)). ![Line profiling using the Performance Bar](img/performance_bar_line_profiling.png) -- time taken and number of calls to Redis -- time taken and number of background jobs created by Sidekiq +- time taken and number of Redis calls, click through for details of these calls + ![Redis profiling using the Performance Bar](img/performance_bar_redis_calls.png) - time taken and number of Ruby GC calls On the far right is a request selector that allows you to view the same metrics @@ -43,3 +44,4 @@ You can toggle the Bar using the same shortcut. ![GitLab Performance Bar Admin Settings](img/performance_bar_configuration_settings.png) [Gitaly]: ../../gitaly/index.md +[Rugged]: ../../high_availability/nfs.md#improving-nfs-performance-with-gitlab -- cgit v1.2.1 From d18ee3faad34097c14d2f1ee9c4a1bf7b00b202a Mon Sep 17 00:00:00 2001 From: Luke Duncalfe Date: Wed, 24 Jul 2019 11:23:51 +0000 Subject: LFS export records repository_type data A project can have the same `LfsObject` linked with up to three `LfsObjectsProject` records. Each of these records would be for a different repository, recorded in the `repository_type` property. The different repositories at time of writing are "project", "wiki", and "design". See https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/13894 This change exports the list of `repository_type`s as a JSON mapping of oid => repository_types, which are imported to recreate the correct `LfsObjectsProject` records. https://gitlab.com/gitlab-org/gitlab-ee/issues/11090 --- doc/administration/logs.md | 3 --- 1 file changed, 3 deletions(-) (limited to 'doc/administration') diff --git a/doc/administration/logs.md b/doc/administration/logs.md index 563701b8677..44a33eb7bcf 100644 --- a/doc/administration/logs.md +++ b/doc/administration/logs.md @@ -283,9 +283,6 @@ Introduced in GitLab 11.3. This file lives in `/var/log/gitlab/gitlab-rails/impo Omnibus GitLab packages or in `/home/git/gitlab/log/importer.log` for installations from source. -Currently it logs the progress of project imports from the Bitbucket Server -importer. Future importers may use this file. - ## `auth.log` Introduced in GitLab 12.0. This file lives in `/var/log/gitlab/gitlab-rails/auth.log` for -- cgit v1.2.1 From 74a34e8b7bd3019b63eeae58abc7185c122bc528 Mon Sep 17 00:00:00 2001 From: Marcel Amirault Date: Wed, 24 Jul 2019 13:10:06 +0000 Subject: Clean up headers in markdown Some markdown headers needed tweaking to adhere to standards, including blank lines above and below, only one space after hash, first header should be h1, and only one h1 per doc --- doc/administration/troubleshooting/debug.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/administration') diff --git a/doc/administration/troubleshooting/debug.md b/doc/administration/troubleshooting/debug.md index 098d946a9fa..604dff5983d 100644 --- a/doc/administration/troubleshooting/debug.md +++ b/doc/administration/troubleshooting/debug.md @@ -209,7 +209,7 @@ ps auwx | grep unicorn | awk '{ print " -p " $2}' | xargs strace -tt -T -f -s 10 The output in `/tmp/unicorn.txt` may help diagnose the root cause. -# More information +## More information - [Debugging Stuck Ruby Processes](https://blog.newrelic.com/2013/04/29/debugging-stuck-ruby-processes-what-to-do-before-you-kill-9/) - [Cheatsheet of using gdb and ruby processes](gdb-stuck-ruby.txt) -- cgit v1.2.1 From a0adccd210e5dea3681a66a439502e075098e062 Mon Sep 17 00:00:00 2001 From: Evan Read Date: Wed, 24 Jul 2019 13:32:15 +0000 Subject: Fix some errors in Markdown files --- doc/administration/geo/replication/configuration.md | 4 ++-- doc/administration/geo/replication/updating_the_geo_nodes.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/administration') diff --git a/doc/administration/geo/replication/configuration.md b/doc/administration/geo/replication/configuration.md index 0e11dffa0d6..fd076bb79d8 100644 --- a/doc/administration/geo/replication/configuration.md +++ b/doc/administration/geo/replication/configuration.md @@ -17,7 +17,7 @@ You are encouraged to first read through all the steps before executing them in your testing/production environment. NOTE: **Note:** -**Do not** set up any custom authentication for the **secondary** nodes. This will be handled by the **primary** node. +**Do not** set up any custom authentication for the **secondary** nodes. This will be handled by the **primary** node. Any change that requires access to the **Admin Area** needs to be done in the **primary** node because the **secondary** node is a read-only replica. @@ -242,7 +242,7 @@ node's Geo Nodes dashboard in your browser. ![Geo dashboard](img/geo_node_dashboard.png) If your installation isn't working properly, check the -[troubleshooting document]. +[troubleshooting document](troubleshooting.md). The two most obvious issues that can become apparent in the dashboard are: diff --git a/doc/administration/geo/replication/updating_the_geo_nodes.md b/doc/administration/geo/replication/updating_the_geo_nodes.md index 166ee94eca4..550b3b07a95 100644 --- a/doc/administration/geo/replication/updating_the_geo_nodes.md +++ b/doc/administration/geo/replication/updating_the_geo_nodes.md @@ -251,7 +251,7 @@ Omnibus is the following: 1. Check the steps about defining `postgresql['sql_user_password']`, `gitlab_rails['db_password']`. 1. Make sure `postgresql['max_replication_slots']` matches the number of **secondary** Geo nodes locations. 1. Install GitLab on the **secondary** server. -1. Re-run the [database replication process][database-replication]. +1. Re-run the [database replication process](database.md#step-3-initiate-the-replication-process). ## Special update notes for 9.0.x -- cgit v1.2.1 From 6150eb2c3750a37c95426a9aabac54e48192d000 Mon Sep 17 00:00:00 2001 From: Greg Myers Date: Thu, 25 Jul 2019 17:13:50 +0000 Subject: Remove \ from unicorn\_stderr.log --- doc/administration/logs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/administration') diff --git a/doc/administration/logs.md b/doc/administration/logs.md index 44a33eb7bcf..31876dd178a 100644 --- a/doc/administration/logs.md +++ b/doc/administration/logs.md @@ -242,7 +242,7 @@ I, [2015-02-13T06:17:00.679433 #9291] INFO -- : Moving existing hooks directory User clone/fetch activity using ssh transport appears in this log as `executing git command