From be2f4c5788975597dd7be1c8a3525549770c1216 Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Tue, 24 Mar 2020 03:09:28 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- doc/administration/troubleshooting/debug.md | 2 +- doc/administration/troubleshooting/diagnostics_tools.md | 2 +- doc/administration/troubleshooting/elasticsearch.md | 4 ++-- doc/administration/troubleshooting/kubernetes_cheat_sheet.md | 2 +- doc/administration/troubleshooting/sidekiq.md | 6 +++--- 5 files changed, 8 insertions(+), 8 deletions(-) (limited to 'doc/administration/troubleshooting') diff --git a/doc/administration/troubleshooting/debug.md b/doc/administration/troubleshooting/debug.md index 34d42b8b5b8..78aa10489ce 100644 --- a/doc/administration/troubleshooting/debug.md +++ b/doc/administration/troubleshooting/debug.md @@ -118,7 +118,7 @@ downtime. Otherwise skip to the next section. ``` 1. This forces the process to generate a Ruby backtrace. Check - `/var/log/gitlab/unicorn/unicorn_stderr.log` for the backtace. For example, you may see: + `/var/log/gitlab/unicorn/unicorn_stderr.log` for the backtrace. For example, you may see: ```plaintext from /opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/metrics/sampler.rb:33:in `block in start' diff --git a/doc/administration/troubleshooting/diagnostics_tools.md b/doc/administration/troubleshooting/diagnostics_tools.md index ab3b25f0e97..97b367dc353 100644 --- a/doc/administration/troubleshooting/diagnostics_tools.md +++ b/doc/administration/troubleshooting/diagnostics_tools.md @@ -19,7 +19,7 @@ running on. ## strace-parser [strace-parser](https://gitlab.com/wchandler/strace-parser) is a small tool to analyze -and summarize raw strace data. +and summarize raw `strace` data. ## Pritaly diff --git a/doc/administration/troubleshooting/elasticsearch.md b/doc/administration/troubleshooting/elasticsearch.md index 0fdd5314a9d..c864fc7b2b6 100644 --- a/doc/administration/troubleshooting/elasticsearch.md +++ b/doc/administration/troubleshooting/elasticsearch.md @@ -8,7 +8,7 @@ Troubleshooting Elasticsearch requires: ## Common terminology - **Lucene**: A full-text search library written in Java. -- **Near Realtime (NRT)**: Refers to the slight latency from the time to index a +- **Near real time (NRT)**: Refers to the slight latency from the time to index a document to the time when it becomes searchable. - **Cluster**: A collection of one or more nodes that work together to hold all the data, providing indexing and search capabilities. @@ -271,7 +271,7 @@ Generally speaking, ensure: - The Elasticsearch server have enough RAM and CPU cores. - That sharding **is** being used. -Going into some more detail here, if Elasticsearch is running on the same server as GitLab, resource contention is **very** likely to occur. Ideally, Elasticsearch, which requires ample resources, should be running on its own server (maybe coupled with logstash and kibana). +Going into some more detail here, if Elasticsearch is running on the same server as GitLab, resource contention is **very** likely to occur. Ideally, Elasticsearch, which requires ample resources, should be running on its own server (maybe coupled with Logstash and Kibana). When it comes to Elasticsearch, RAM is the key resource. Elasticsearch themselves recommend: diff --git a/doc/administration/troubleshooting/kubernetes_cheat_sheet.md b/doc/administration/troubleshooting/kubernetes_cheat_sheet.md index ec59705ca99..8b06d6ff530 100644 --- a/doc/administration/troubleshooting/kubernetes_cheat_sheet.md +++ b/doc/administration/troubleshooting/kubernetes_cheat_sheet.md @@ -162,7 +162,7 @@ and they will assist you with any issues you are having. kubectl get secret -ojsonpath={.data.password} | base64 --decode ; echo ``` -- How to connect to a GitLab Postgres database: +- How to connect to a GitLab PostgreSQL database: ```shell kubectl exec -it -- /srv/gitlab/bin/rails dbconsole -p diff --git a/doc/administration/troubleshooting/sidekiq.md b/doc/administration/troubleshooting/sidekiq.md index 73598bb9441..172e80bee7d 100644 --- a/doc/administration/troubleshooting/sidekiq.md +++ b/doc/administration/troubleshooting/sidekiq.md @@ -25,7 +25,7 @@ the `SIDEKIQ_LOG_ARGUMENTS` [environment variable](https://docs.gitlab.com/omnib Example: -``` +```ruby gitlab_rails['env'] = {"SIDEKIQ_LOG_ARGUMENTS" => "1"} ``` @@ -43,7 +43,7 @@ single argument containing the string `"..."`. Send the Sidekiq process ID the `TTIN` signal and it will output thread backtraces in the log file. -``` +```shell kill -TTIN ``` @@ -95,7 +95,7 @@ sudo perf record -p Let this run for 30-60 seconds and then press Ctrl-C. Then view the perf report: ```shell -sudo perf report +$ sudo perf report # Sample output Samples: 348K of event 'cycles', Event count (approx.): 280908431073 -- cgit v1.2.3