Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
e12cd852
Commit
e12cd852
authored
Dec 27, 2021
by
Aleksei Lipniagov
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Remove mentions of Sherlock from our docs
parent
dcddbf83
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
2 additions
and
19 deletions
+2
-19
doc/development/index.md
doc/development/index.md
+1
-2
doc/development/merge_request_performance_guidelines.md
doc/development/merge_request_performance_guidelines.md
+1
-3
doc/development/profiling.md
doc/development/profiling.md
+0
-14
No files found.
doc/development/index.md
View file @
e12cd852
...
...
@@ -264,8 +264,7 @@ the [reviewer values](https://about.gitlab.com/handbook/engineering/workflow/rev
-
[
Caching guidelines
](
caching.md
)
for using caching in Rails under a GitLab environment.
-
[
Merge request performance guidelines
](
merge_request_performance_guidelines.md
)
for ensuring merge requests do not negatively impact GitLab performance
-
[
Profiling
](
profiling.md
)
a URL, measuring performance using Sherlock, or
tracking down N+1 queries using Bullet.
-
[
Profiling
](
profiling.md
)
a URL or tracking down N+1 queries using Bullet.
-
[
Cached queries guidelines
](
cached_queries.md
)
, for tracking down N+1 queries
masked by query caching, memory profiling and why should we avoid cached
queries.
...
...
doc/development/merge_request_performance_guidelines.md
View file @
e12cd852
...
...
@@ -13,9 +13,7 @@ _every_ merge request **should** adhere to the guidelines outlined in this
document. There are no exceptions to this rule unless specifically discussed
with and agreed upon by backend maintainers and performance specialists.
To measure the impact of a merge request you can use
[
Sherlock
](
profiling.md#sherlock
)
. It's also highly recommended that you read
the following guides:
It's also highly recommended that you read the following guides:
-
[
Performance Guidelines
](
performance.md
)
-
[
Avoiding downtime in migrations
](
avoiding_downtime_in_migrations.md
)
...
...
doc/development/profiling.md
View file @
e12cd852
...
...
@@ -108,20 +108,6 @@ Find more information about different sampling modes in the [Stackprof docs](htt
This is enabled for all users that can access the performance bar.
## Sherlock
Sherlock is a custom profiling tool built into GitLab. Sherlock is _only_
available when running GitLab in development mode _and_ when setting the
environment variable
`ENABLE_SHERLOCK`
to a non empty value. For example:
```
shell
ENABLE_SHERLOCK
=
1 bundle
exec
rails s
```
Sherlock is also
[
available though the GitLab GDK
](
https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/howto/sherlock.md
)
.
Recorded transactions can be found by navigating to
`/sherlock/transactions`
.
## Bullet
Bullet is a Gem that can be used to track down N+1 query problems. Bullet section is
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment