diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-01-21 09:09:03 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-01-21 09:09:03 +0300 |
commit | 25c07d7230471a8cc7062e83662a300fb4902fce (patch) | |
tree | 801312092a7062aa2afbef142dbea04115ebae53 /doc | |
parent | e1e342d79bcc1f72829cc6d1642f5e7d76750e75 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/services.md | 2 | ||||
-rw-r--r-- | doc/development/logging.md | 22 | ||||
-rw-r--r-- | doc/update/mysql_to_postgresql.md | 4 | ||||
-rw-r--r-- | doc/update/upgrading_postgresql_using_slony.md | 6 | ||||
-rw-r--r-- | doc/user/admin_area/appearance.md | 2 | ||||
-rw-r--r-- | doc/user/admin_area/index.md | 6 | ||||
-rw-r--r-- | doc/user/admin_area/settings/email.md | 2 | ||||
-rw-r--r-- | doc/user/admin_area/settings/sign_in_restrictions.md | 2 | ||||
-rw-r--r-- | doc/user/application_security/index.md | 4 | ||||
-rw-r--r-- | doc/user/application_security/security_dashboard/index.md | 2 | ||||
-rw-r--r-- | doc/user/clusters/environments.md | 2 | ||||
-rw-r--r-- | doc/user/discussions/index.md | 6 | ||||
-rw-r--r-- | doc/user/group/settings/import_export.md | 2 | ||||
-rw-r--r-- | doc/user/profile/account/two_factor_authentication.md | 2 | ||||
-rw-r--r-- | doc/user/project/quick_actions.md | 2 |
15 files changed, 45 insertions, 21 deletions
diff --git a/doc/api/services.md b/doc/api/services.md index d00ddb07a05..c94b026edb5 100644 --- a/doc/api/services.md +++ b/doc/api/services.md @@ -1358,7 +1358,7 @@ Get JetBrains TeamCity CI service settings for a project. GET /projects/:id/services/teamcity ``` -## Jenkins CI **(STARTER)** +## Jenkins CI A continuous integration and build server diff --git a/doc/development/logging.md b/doc/development/logging.md index 07ec9d53145..ea26fa08456 100644 --- a/doc/development/logging.md +++ b/doc/development/logging.md @@ -299,6 +299,28 @@ through web requests. See the [follow-up work](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/68) for more information. +### Logging context metadata (through workers) + +Additional metadata can be attached to a worker through the use of the [`ApplicationWorker#log_extra_metadata_on_done`](https://gitlab.com/gitlab-org/gitlab/-/blob/16ecc33341a3f6b6bebdf78d863c5bce76b040d3/app/workers/concerns/application_worker.rb#L31-34) +method. Using this method adds metadata that is later logged to Kibana with the done job payload. + +```ruby +class MyExampleWorker + include ApplicationWorker + + def perform(*args) + # Worker performs work + # ... + + # The contents of value will appear in Kibana under `json.extra.my_example_worker.my_key` + log_extra_metadata_on_done(:my_key, value) + end +end +``` + +Please see [this example](https://gitlab.com/gitlab-org/gitlab/-/blob/16ecc33341a3f6b6bebdf78d863c5bce76b040d3/app/workers/ci/pipeline_artifacts/expire_artifacts_worker.rb#L20-21) +which logs a count of how many artifacts are destroyed per run of the `ExpireArtifactsWorker`. + ## Exception Handling It often happens that you catch the exception and want to track it. diff --git a/doc/update/mysql_to_postgresql.md b/doc/update/mysql_to_postgresql.md index fb1335acd7d..4be8210f376 100644 --- a/doc/update/mysql_to_postgresql.md +++ b/doc/update/mysql_to_postgresql.md @@ -142,7 +142,7 @@ new PostgreSQL one: sudo -u gitlab-psql pgloader commands.load ``` -1. Once the migration finishes, you should see a summary table that looks like +1. After the migration finishes, you should see a summary table that looks like the following: ```plaintext @@ -243,7 +243,7 @@ new PostgreSQL one: sudo -u postgres pgloader commands.load ``` -1. Once the migration finishes, you should see a summary table that looks like +1. After the migration finishes, you should see a summary table that looks like the following: ```plaintext diff --git a/doc/update/upgrading_postgresql_using_slony.md b/doc/update/upgrading_postgresql_using_slony.md index c5dd6cf16b7..c9f8f83749c 100644 --- a/doc/update/upgrading_postgresql_using_slony.md +++ b/doc/update/upgrading_postgresql_using_slony.md @@ -40,7 +40,7 @@ If you're not using the Omnibus GitLab package you may have to adjust the paths `pg_dump` and the PostgreSQL installation directory to match the paths of your configuration. -Once the structure dump is generated we also need to generate a dump for the +After the structure dump is generated we also need to generate a dump for the `schema_migrations` table. This table doesn't have any primary keys and as such can't be replicated easily by Slony. To generate this dump run the following command on your active database server: @@ -210,7 +210,7 @@ this output, don't just append it below it. The result looks like this: ] ``` -Once you have the configuration file generated you must install it on both the +After you have the configuration file generated you must install it on both the old and new database. To do so, place it in `/var/opt/gitlab/postgresql/slony/slon_tools.conf` (for which we created the directory earlier on). @@ -218,7 +218,7 @@ directory earlier on). Now that the configuration file is in place we can _finally_ start replicating our database. First we must set up the schema in our new database. To do so make sure that the SQL files we generated earlier can be found in the `/tmp` -directory of the new server. Once these files are in place start a `psql` +directory of the new server. After these files are in place start a `psql` session on this server: ```shell diff --git a/doc/user/admin_area/appearance.md b/doc/user/admin_area/appearance.md index b7f5afe7b70..4205f554695 100644 --- a/doc/user/admin_area/appearance.md +++ b/doc/user/admin_area/appearance.md @@ -20,7 +20,7 @@ used (less than 1MB) and it is automatically resized. ![Navigation bar header logo screenshot](img/appearance_header_logo_v12_3.png) -Once you select and upload an image, click **Update appearance settings** at the bottom +After you select and upload an image, click **Update appearance settings** at the bottom of the page to activate it in the GitLab instance. NOTE: diff --git a/doc/user/admin_area/index.md b/doc/user/admin_area/index.md index 40cb6bd0853..141099dae97 100644 --- a/doc/user/admin_area/index.md +++ b/doc/user/admin_area/index.md @@ -300,7 +300,9 @@ The Sidekiq dashboard consists of the following elements: ### Logs -The **Logs** page provides access to the following log files: +Since GitLab 13.0, **Log** view has been removed from the admin dashboard since the logging does not work in multi-node setups and could cause confusion for administrators by displaying partial information. + +For multi-node systems we recommend ingesting the logs into services like Elasticsearch and Splunk. | Log file | Contents | | :---------------------- | :------- | @@ -312,7 +314,7 @@ The **Logs** page provides access to the following log files: | `integrations_json.log` | Activity between GitLab and integrated systems | | `kubernetes.log` | Kubernetes activity | -The contents of these log files can be useful when troubleshooting a problem. Access is available to GitLab admins, without requiring direct access to the log files. +The contents of these log files can be useful when troubleshooting a problem. For details of these log files and their contents, see [Log system](../../administration/logs.md). diff --git a/doc/user/admin_area/settings/email.md b/doc/user/admin_area/settings/email.md index 4ebfac57715..8ab3c085436 100644 --- a/doc/user/admin_area/settings/email.md +++ b/doc/user/admin_area/settings/email.md @@ -40,7 +40,7 @@ In order to change this option: 1. Select **Save changes**. NOTE: -Once the hostname gets configured, every private commit email using the previous hostname, will not get +After the hostname gets configured, every private commit email using the previous hostname is not recognized by GitLab. This can directly conflict with certain [Push rules](../../../push_rules/push_rules.md) such as `Check whether author is a GitLab user` and `Check whether committer is the current authenticated user`. diff --git a/doc/user/admin_area/settings/sign_in_restrictions.md b/doc/user/admin_area/settings/sign_in_restrictions.md index 92ad8eced95..05d743c9dc7 100644 --- a/doc/user/admin_area/settings/sign_in_restrictions.md +++ b/doc/user/admin_area/settings/sign_in_restrictions.md @@ -27,7 +27,7 @@ You can restrict the password authentication for web interface and Git over HTTP When this feature enabled, all users must use the [two-factor authentication](../../profile/account/two_factor_authentication.md). -Once the two-factor authentication is configured as mandatory, the users are allowed +After the two-factor authentication is configured as mandatory, users are allowed to skip forced configuration of two-factor authentication for the configurable grace period in hours. diff --git a/doc/user/application_security/index.md b/doc/user/application_security/index.md index 2d6cb7956ea..199673bf8aa 100644 --- a/doc/user/application_security/index.md +++ b/doc/user/application_security/index.md @@ -267,7 +267,7 @@ You can dismiss multiple vulnerabilities at once, providing an optional reason. Selecting the checkboxes on the side of each vulnerability in the list selects that individual vulnerability. Alternatively, you can select all the vulnerabilities in the list by selecting the checkbox in the table header. Deselecting the checkbox in the header deselects all the vulnerabilities in the list. -Once you have selected some vulnerabilities, a menu appears at the top of the table that allows you to select a dismissal reason. +After you have selected some vulnerabilities, a menu appears at the top of the table that allows you to select a dismissal reason. Pressing the "Dismiss Selected" button dismisses all the selected vulnerabilities at once, with the reason you chose. ![Multiple vulnerability dismissal](img/multi_select_v12_9.png) @@ -281,7 +281,7 @@ You can create an issue for a vulnerability by visiting the vulnerability's page This creates a [confidential issue](../project/issues/confidential_issues.md) in the project the vulnerability came from, and pre-populates it with some useful information taken from the vulnerability -report. Once the issue is created, you are redirected to it so you can edit, assign, or comment on +report. After the issue is created, you are redirected to it so you can edit, assign, or comment on it. Upon returning to the group security dashboard, the vulnerability now has an associated issue next diff --git a/doc/user/application_security/security_dashboard/index.md b/doc/user/application_security/security_dashboard/index.md index 10bf6202a92..9fef1cde316 100644 --- a/doc/user/application_security/security_dashboard/index.md +++ b/doc/user/application_security/security_dashboard/index.md @@ -267,7 +267,7 @@ To create an issue associated with the vulnerability, click the **Create Issue** ![Create an issue for the vulnerability](img/vulnerability_details_create_issue_v13_7.png) -Once you create the issue, the linked issue icon in the vulnerability list: +After you create the issue, the linked issue icon in the vulnerability list: - Indicates that an issue has been created for that vulnerability. - Shows a tooltip that contains a link to the issue. diff --git a/doc/user/clusters/environments.md b/doc/user/clusters/environments.md index be4ac8151e4..0d1ef7d2c1b 100644 --- a/doc/user/clusters/environments.md +++ b/doc/user/clusters/environments.md @@ -38,7 +38,7 @@ In order to: - Show pod usage correctly, you must [enable Deploy Boards](../project/deploy_boards.md#enabling-deploy-boards). -Once you have successful deployments to your group-level or instance-level cluster: +After you have successful deployments to your group-level or instance-level cluster: 1. Navigate to your group's **Kubernetes** page. 1. Click on the **Environments** tab. diff --git a/doc/user/discussions/index.md b/doc/user/discussions/index.md index bf3e907bd24..1fd20bfbf9c 100644 --- a/doc/user/discussions/index.md +++ b/doc/user/discussions/index.md @@ -370,7 +370,7 @@ From a merge request's **Discussion** tab, or from an epic/issue overview, find ![Notes filters dropdown options](img/index_notes_filters.png) -Once you select one of the filters in a given issue or MR, GitLab will save +After you select one of the filters in a given issue or MR, GitLab will save your preference, so that it will persist when you visit the same page again from any device you're logged into. @@ -401,7 +401,7 @@ the merge request authored by the user that applied them. ![Apply suggestions](img/apply_suggestion_v12_7.png) -Once the author applies a Suggestion, it will be marked with the **Applied** label, +After the author applies a Suggestion, it will be marked with the **Applied** label, the thread will be automatically resolved, and GitLab will create a new commit and push the suggested change directly into the codebase in the merge request's branch. [Developer permission](../permissions.md) is required to do so. @@ -537,7 +537,7 @@ Clicking on the **Reply to comment** button will bring the reply area into focus ![Reply to comment feature](img/reply_to_comment.gif) Replying to a non-thread comment will convert the non-thread comment to a -thread once the reply is submitted. This conversion is considered an edit +thread after the reply is submitted. This conversion is considered an edit to the original comment, so a note about when it was last edited will appear underneath it. This feature only exists for Issues, Merge requests, and Epics. Commits, Snippets and Merge request diff threads are diff --git a/doc/user/group/settings/import_export.md b/doc/user/group/settings/import_export.md index 07ba1e0aba9..6ad550d77c3 100644 --- a/doc/user/group/settings/import_export.md +++ b/doc/user/group/settings/import_export.md @@ -69,7 +69,7 @@ For more details on the specific data persisted in a group export, see the ![Export group panel](img/export_panel_v13_0.png) -1. Once the export is generated, you should receive an e-mail with a link to the [exported contents](#exported-contents) +1. After the export is generated, you should receive an e-mail with a link to the [exported contents](#exported-contents) in a compressed tar archive, with contents in JSON format. 1. Alternatively, you can come back to the project settings and download the diff --git a/doc/user/profile/account/two_factor_authentication.md b/doc/user/profile/account/two_factor_authentication.md index 6cdd2d6f161..6bcbde3da2f 100644 --- a/doc/user/profile/account/two_factor_authentication.md +++ b/doc/user/profile/account/two_factor_authentication.md @@ -384,7 +384,7 @@ codes. If you saved these codes, you can use one of them to sign in. To use a recovery code, enter your username/email and password on the GitLab sign-in page. When prompted for a two-factor code, enter the recovery code. -Once you use a recovery code, you cannot re-use it. You can still use the other +After you use a recovery code, you cannot re-use it. You can still use the other recovery codes you saved. ### Generate new recovery codes using SSH diff --git a/doc/user/project/quick_actions.md b/doc/user/project/quick_actions.md index 64be3182dab..5c9cadb99ae 100644 --- a/doc/user/project/quick_actions.md +++ b/doc/user/project/quick_actions.md @@ -62,7 +62,7 @@ The following quick actions are applicable to descriptions, discussions and thre | `/promote` | ✓ | | | Promote issue to epic. **(PREMIUM)** | | `/publish` | ✓ | | | Publish issue to an associated [Status Page](../../operations/incident_management/status_page.md) ([Introduced in GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30906)) **(ULTIMATE)** | | `/reassign @user1 @user2` | ✓ | ✓ | | Replace current assignees with those specified. **(STARTER)** | -| `/rebase` | | ✓ | | Rebase source branch. This will schedule a background task that attempt to rebase the changes in the source branch on the latest commit of the target branch. If `/rebase` is used, `/merge` will be ignored to avoid a race condition where the source branch is merged or deleted before it is rebased. If there are merge conflicts, GitLab will display a message that a rebase cannot be scheduled. Rebase failures will be displayed with the merge request status. | +| `/rebase` | | ✓ | | Rebase source branch. This schedules a background task that attempts to rebase the changes in the source branch on the latest commit of the target branch. If `/rebase` is used, `/merge` is ignored to avoid a race condition where the source branch is merged or deleted before it is rebased. If there are merge conflicts, GitLab displays a message that a rebase cannot be scheduled. Rebase failures are displayed with the merge request status. | | `/reassign_reviewer @user1 @user2` | | ✓ | | Replace current reviewers with those specified. **(STARTER)** | | `/relabel ~label1 ~label2` | ✓ | ✓ | ✓ | Replace current labels with those specified. | | `/relate #issue1 #issue2` | ✓ | | | Mark issues as related. **(STARTER)** | |