Commit e12cd852 authored by Aleksei Lipniagov's avatar Aleksei Lipniagov

Remove mentions of Sherlock from our docs

parent dcddbf83
...@@ -264,8 +264,7 @@ the [reviewer values](https://about.gitlab.com/handbook/engineering/workflow/rev ...@@ -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. - [Caching guidelines](caching.md) for using caching in Rails under a GitLab environment.
- [Merge request performance guidelines](merge_request_performance_guidelines.md) - [Merge request performance guidelines](merge_request_performance_guidelines.md)
for ensuring merge requests do not negatively impact GitLab performance for ensuring merge requests do not negatively impact GitLab performance
- [Profiling](profiling.md) a URL, measuring performance using Sherlock, or - [Profiling](profiling.md) a URL or tracking down N+1 queries using Bullet.
tracking down N+1 queries using Bullet.
- [Cached queries guidelines](cached_queries.md), for tracking down N+1 queries - [Cached queries guidelines](cached_queries.md), for tracking down N+1 queries
masked by query caching, memory profiling and why should we avoid cached masked by query caching, memory profiling and why should we avoid cached
queries. queries.
......
...@@ -13,9 +13,7 @@ _every_ merge request **should** adhere to the guidelines outlined in this ...@@ -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 document. There are no exceptions to this rule unless specifically discussed
with and agreed upon by backend maintainers and performance specialists. with and agreed upon by backend maintainers and performance specialists.
To measure the impact of a merge request you can use It's also highly recommended that you read the following guides:
[Sherlock](profiling.md#sherlock). It's also highly recommended that you read
the following guides:
- [Performance Guidelines](performance.md) - [Performance Guidelines](performance.md)
- [Avoiding downtime in migrations](avoiding_downtime_in_migrations.md) - [Avoiding downtime in migrations](avoiding_downtime_in_migrations.md)
......
...@@ -108,20 +108,6 @@ Find more information about different sampling modes in the [Stackprof docs](htt ...@@ -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. 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
Bullet is a Gem that can be used to track down N+1 query problems. Bullet section is Bullet is a Gem that can be used to track down N+1 query problems. Bullet section is
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment