Skip to content

Commit eba8b1e

Browse files
committed
Mention Vernier::Middleware options in README
1 parent 4309ddc commit eba8b1e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ If you're using Rails, you can add the middleware to your `config/application.rb
105105
config.middleware.use Vernier::Middleware, permit: ->(env) { env["PATH_INFO"].start_with?("/api") }
106106
```
107107

108-
You can then enable profiliing and tune the interval and allocation interval with query parameters:
108+
You can then enable profiliing and configure options with query parameters:
109109

110110
```sh
111111
curl http://localhost:3000?vernier=true&vernier_interval=100&vernier_allocation_interval=10
@@ -126,13 +126,13 @@ ruby -r vernier -e 'Vernier.trace_retained(out: "irb_profile.json") { require "i
126126
127127
### Options
128128

129-
Option | Description
130-
:- | :-
131-
`mode` | The sampling mode to use. One of `:wall`, `:retained` or `:custom`. Default is `:wall`.
132-
`out` | The file to write the profile to.
133-
`interval` | The sampling interval in microseconds. Default is `500`. Only available in `:wall` mode.
134-
`allocation_interval` | The allocation sampling interval in number of allocations. Default is `0` (disabled). Only available in `:wall` mode.
135-
`gc` | Initiate a full and immediate garbage collection cycle before profiling. Default is `true`. Only available in `:retained` mode.
129+
Option | Middleware Param | Description | Default | Middleware Default
130+
:- | :- | :- | :- | :-
131+
`mode` | N/A | The sampling mode to use. One of `:wall`, `:retained` or `:custom`. | `:wall` | `:wall`
132+
`out` | N/A | The file to write the profile to. | N/A | Automatically generated
133+
`interval` | `vernier_interval` | The sampling interval in microseconds. Only available in `:wall` mode. | `500` | `200`
134+
`allocation_interval` | `vernier_allocation_interval` | The allocation sampling interval in number of allocations. Only available in `:wall` mode. | `0` (disabled) | `200`
135+
`gc` | N/A | Initiate a full and immediate garbage collection cycle before profiling. Only available in `:retained` mode. | `true` | N/A
136136

137137
## Development
138138

0 commit comments

Comments
 (0)