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
0
Merge Requests
0
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
iv
gitlab-ce
Commits
0bef6491
Commit
0bef6491
authored
Oct 05, 2015
by
Yorick Peterse
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Added documentation for writing benchmarks
parent
89920ca8
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
70 additions
and
0 deletions
+70
-0
doc/development/README.md
doc/development/README.md
+1
-0
doc/development/benchmarking.md
doc/development/benchmarking.md
+69
-0
No files found.
doc/development/README.md
View file @
0bef6491
...
@@ -8,3 +8,4 @@
...
@@ -8,3 +8,4 @@
-
[
UI guide
](
ui_guide.md
)
for building GitLab with existing css styles and elements
-
[
UI guide
](
ui_guide.md
)
for building GitLab with existing css styles and elements
-
[
Migration Style Guide
](
migration_style_guide.md
)
for creating safe migrations
-
[
Migration Style Guide
](
migration_style_guide.md
)
for creating safe migrations
-
[
How to dump production data to staging
](
dump_db.md
)
-
[
How to dump production data to staging
](
dump_db.md
)
-
[
Benchmarking
](
benchmarking.md
)
doc/development/benchmarking.md
0 → 100644
View file @
0bef6491
# Benchmarking
GitLab CE comes with a set of benchmarks that are executed for every build. This
makes it easier to measure performance of certain components over time.
Benchmarks are written as RSpec tests using a few extra helpers. To write a
benchmark, first tag the top-level
`describe`
:
```
ruby
describe
MaruTheCat
,
benchmark:
true
do
end
```
This ensures the benchmark is executed separately from other test collections.
It also exposes the various RSpec matchers used for writing benchmarks to the
test group.
Next, lets write the actual benchmark:
```
ruby
describe
MaruTheCat
,
benchmark:
true
do
let
(
:maru
)
{
MaruTheChat
.
new
}
describe
'#jump_in_box'
do
benchmark_subject
{
maru
.
jump_in_box
}
it
{
is_expected
.
to
iterate_per_second
(
9000
)
}
end
end
```
Here
`benchmark_subject`
is a small wrapper around RSpec's
`subject`
method that
makes it easier to specify the subject of a benchmark. Using RSpec's regular
`subject`
would require us to write the following instead:
```
ruby
subject
{
->
{
maru
.
jump_in_box
}
}
```
The
`iterate_per_second`
matcher defines the amount of times per second a
subject should be executed. The higher the amount of iterations the better.
By default the allowed standard deviation is a maximum of 30%. This can be
adjusted by chaining the
`with_maximum_stddev`
on the
`iterate_per_second`
matcher:
```
ruby
it
{
is_expected
.
to
iterate_per_second
(
9000
).
with_maximum_stddev
(
50
)
}
```
This can be useful if the code in question depends on external resources of
which the performance can vary a lot (e.g. physical HDDs, network calls, etc).
However, in most cases 30% should be enough so only change this when really
needed.
## Benchmarks Location
Benchmarks should be stored in
`spec/benchmarks`
and should follow the regular
Rails specs structure. That is, model benchmarks go in
`spec/benchmark/models`
,
benchmarks for code in the
`lib`
directory go in
`spec/benchmarks/lib`
, etc.
## Underlying Technology
The benchmark setup uses
[
benchmark-ips
][
benchmark-ips
]
which takes care of the
heavy lifting such as warming up code, calculating iterations, standard
deviation, etc.
[
benchmark-ips
]:
https://github.com/evanphx/benchmark-ips
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