diff options
author | Yorick Peterse <yorickpeterse@gmail.com> | 2016-04-05 13:37:41 +0300 |
---|---|---|
committer | Yorick Peterse <yorickpeterse@gmail.com> | 2016-04-06 15:32:27 +0300 |
commit | 352bc7d2b9a4ed5725e4f0e9f2e63d71678de9bc (patch) | |
tree | 0e088b2b55a6f66e0dfd830b974987d24f6ccd4d /doc/development/instrumentation.md | |
parent | 1af6cf28c031cec7813d3fc090476c088de57173 (diff) |
Added dev guide for measuring Ruby blocks
Diffstat (limited to 'doc/development/instrumentation.md')
-rw-r--r-- | doc/development/instrumentation.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/development/instrumentation.md b/doc/development/instrumentation.md new file mode 100644 index 00000000000..c0192bd6709 --- /dev/null +++ b/doc/development/instrumentation.md @@ -0,0 +1,37 @@ +# Instrumenting Ruby Code + +GitLab Performance Monitoring allows instrumenting of custom blocks of Ruby +code. This can be used to measure the time spent in a specific part of a larger +chunk of code. The resulting data is written to a separate series. + +To start measuring a block of Ruby code you should use +`Gitlab::Metrics.measure` and give it a name for the series to store the data +in: + +```ruby +Gitlab::Metrics.measure(:user_logins) do + ... +end +``` + +The first argument of this method is the series name and should be plural. This +name will be prefixed with `rails_` or `sidekiq_` depending on whether the code +was run in the Rails application or one of the Sidekiq workers. In the +above example the final series names would be as follows: + +- rails_user_logins +- sidekiq_user_logins + +Series names should be plural as this keeps the naming style in line with the +other series names. + +By default metrics measured using a block contain a single value, "duration", +which contains the number of milliseconds it took to execute the block. Custom +values can be added by passing a Hash as the 2nd argument. Custom tags can be +added by passing a Hash as the 3rd argument. A simple example is as follows: + +```ruby +Gitlab::Metrics.measure(:example_series, { number: 10 }, { class: self.class.to_s }) do + ... +end +``` |