@@ -27,7 +27,7 @@ Then run `$ bundle install`. Alternatively you can run `$ gem install stackprof`
27
27
in ruby:
28
28
29
29
``` ruby
30
- StackProf .run(mode: :cpu , path : ' tmp/stackprof-cpu-myapp.dump' ) do
30
+ StackProf .run(mode: :cpu , out : ' tmp/stackprof-cpu-myapp.dump' ) do
31
31
# ...
32
32
end
33
33
```
@@ -119,15 +119,15 @@ Samplers have a tuneable interval which can be used to reduce overhead or increa
119
119
- Wall time: sample every _ interval_ microseconds of wallclock time (default: 1000)
120
120
121
121
``` ruby
122
- StackProf .run(mode: :wall , path : ' tmp/stackprof.dump' , interval: 1000 ) do
122
+ StackProf .run(mode: :wall , out : ' tmp/stackprof.dump' , interval: 1000 ) do
123
123
# ...
124
124
end
125
125
```
126
126
127
127
- CPU time: sample every _ interval_ microseconds of CPU activity (default: 1000 = 1 millisecond)
128
128
129
129
``` ruby
130
- StackProf .run(mode: :cpu , path : ' tmp/stackprof.dump' , interval: 1000 ) do
130
+ StackProf .run(mode: :cpu , out : ' tmp/stackprof.dump' , interval: 1000 ) do
131
131
# ...
132
132
end
133
133
```
136
136
137
137
138
138
``` ruby
139
- StackProf .run(mode: :object , path : ' tmp/stackprof.dump' , interval: 1 ) do
139
+ StackProf .run(mode: :object , out : ' tmp/stackprof.dump' , interval: 1 ) do
140
140
# ...
141
141
end
142
142
```
@@ -331,7 +331,7 @@ StackProf.results('/tmp/some.file')
331
331
Option | Meaning
332
332
------- | ---------
333
333
` mode ` | Mode of sampling: ` :cpu ` , ` :wall ` , ` :object ` , or ` :custom ` [ c.f.] ( #sampling )
334
- ` path ` | The target file, which will be overwritten
334
+ ` out ` | The target file, which will be overwritten
335
335
` interval ` | Mode-relative sample rate [ c.f.] ( #sampling )
336
336
` ignore_gc ` | Ignore garbage collection frames
337
337
` aggregate ` | Defaults: ` true ` - if ` false ` disables [ aggregation] ( #aggregation )
0 commit comments