Skip to content

Commit

Permalink
Make suggested tweaks to README from feedback in #95
Browse files Browse the repository at this point in the history
  - 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
  • Loading branch information
Chris Sinjakli committed May 3, 2019
1 parent 460c2bb commit 2c7589d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ Examples:
**Pre-setting labels for ease of use:**

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

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

### Built-in stores

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

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

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

0 comments on commit 2c7589d

Please sign in to comment.