summaryrefslogtreecommitdiff
path: root/doc/development/performance.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/development/performance.md')
-rw-r--r--doc/development/performance.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/development/performance.md b/doc/development/performance.md
index 346f70e04b0..291165d8125 100644
--- a/doc/development/performance.md
+++ b/doc/development/performance.md
@@ -815,6 +815,25 @@ Make sure that you have relevant test data for your filter in the
[`spec/fixtures/markdown.md.erb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/spec/fixtures/markdown.md.erb)
file.
+### Benchmarking specific filters
+
+A specific filter can be benchmarked by specifying the filter name as an environment variable.
+For example, to benchmark the `MarkdownFilter` use
+
+```plaintext
+FILTER=MarkdownFilter bin/rake benchmark:banzai
+```
+
+which generates the output
+
+```plaintext
+--> Benchmarking MarkdownFilter for FullPipeline
+Warming up --------------------------------------
+ Markdown 271.000 i/100ms
+Calculating -------------------------------------
+ Markdown 2.584k (±16.5%) i/s - 23.848k in 10.042503s
+```
+
## Reading from files and other data sources
Ruby offers several convenience functions that deal with file contents specifically