Add information about bloom filter to config.md
License: MIT Signed-off-by: Dominic Della Valle <ddvpublic@gmail.com>
Dominic Della Valle committed
Apr 6, 2018 at 15:56 UTC
0ecfd7843cbc5315193bc9e2dec9c69dc246006a
1 file changed
+7
-2
docs/config.md
+7
-2
@@ -141,8 +141,13 @@ A boolean value. If set to true, all block reads from disk will be hashed and
141
verified. This will cause increased CPU utilization.
142
143
- `BloomFilterSize`
144
-A number representing the size in bytes of the blockstore's bloom filter. A
145
-value of zero represents the feature being disabled.
144
+A number representing the size in bytes of the blockstore's [bloom filter](https://en.wikipedia.org/wiki/Bloom_filter). A value of zero represents the feature being disabled.
145
+
146
+This site generates useful graphs for various bloom filter values: <https://hur.st/bloomfilter/?n=1e6&p=0.01&m=&k=7>
147
+You may use it to find a preferred optimal value, where `m` is `BloomFilterSize` in bits. Remember to convert the value `m` from bits, into bytes for use as `BloomFilterSize` in the config file.
148
+For example, for 1,000,000 blocks, expecting a 1% false positive rate, you'd end up with a filter size of 9592955 bits, so for `BloomFilterSize` we'd want to use 1199120 bytes.
149
+[Currently](https://github.com/ipfs/go-ipfs/blob/9c194aa7e2febeab0cbd895067d7d90d82b137f9/blocks/blockstore/caching.go), 7 hash functions are used by default, so the constant `k` is 7 in the formula.
150
+
151
152
Default: `0`
153