Skip to content

Commit c085906

Browse files
author
Chris Sinjakli
committed
Make suggested tweaks to README from feedback in #95
- Don't suggest defining metrics outside of file they're used in - Don't allow stores to require extra parameters in `for_metric` - Correct note on kernel page cache Fixes #113, #114 Signed-off-by: Chris Sinjakli <chris@gocardless.com>
1 parent 460c2bb commit c085906

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ Examples:
231231
**Pre-setting labels for ease of use:**
232232

233233
```ruby
234-
# in the file where you define your metrics:
234+
# in the metric definition:
235235
records_processed_total = registry.counter.new(:records_processed_total,
236236
docstring: '...',
237237
labels: [:service, :component],
@@ -304,8 +304,8 @@ whether you want to report the `SUM`, `MAX` or `MIN` value observed across all p
304304
For almost all other cases, you'd leave the default (`SUM`). More on this on the
305305
*Aggregation* section below.
306306

307-
Other custom stores may also require or accept extra parameters besides `:aggregation`.
308-
See the documentation of each store for more details.
307+
Other custom stores may also accept extra parameters besides `:aggregation`. See the
308+
documentation of each store for more details.
309309

310310
### Built-in stores
311311

@@ -334,7 +334,7 @@ There are 3 built-in stores, with different trade-offs:
334334

335335
Even though this store saves data on disk, it's still much faster than would probably be
336336
expected, because the files are never actually `fsync`ed, so the store never blocks
337-
while waiting for disk. FS caching is incredibly efficient in this regard.
337+
while waiting for disk. The kernel's page cache is incredibly efficient in this regard.
338338

339339
If in doubt, check the benchmark scripts described in the documentation for creating
340340
your own stores and run them in your particular runtime environment to make sure this

0 commit comments

Comments
 (0)