A scalable bloom filter service in Golang.
- Designed for microservice systems.
- Scalable bloom filters.
- Client-side hashing
- Grpc interface.
./bloomfield -config_file=config.toml
Defalut configuration would be used without a configuration file.
A test client is inside tools/testclient. It's using the gobloomfield as the go client. In examples below it assumes bloomfield is running locally on port 8679.
./testclient --hostname=localhost:8679 --create testfilter
The return is a boolean slice. Each boolean means if the corresponding key was in the filter or not. If it's first time adding this key the return should be false.
./testclient --hostname=localhost:8679 --add testfilter key1 key2 key3
./testclient --hostname=localhost:8679 --has testfilter key1 key2 key3 key4 key5
./testclient --hostname=localhost:8679 --drop testfilter
Go - gobloomfield
A traditional bloom filter service would accept a key as a string and perform hashing using multiple hash functions.
Bloomfield is using client-side hashing -- hashing(partial) is done on the client side.
- Avoid overloading.
In a microservice system there are multiple bloomfield clients. Client-side hashing distrubutes the hashing workload accross multiple entities instead of overloading bloomfield server.
- Reduce network payload.
As a string, a key would be arbitrarily long. Client-side hashing deterministically converts a key into two uint64 numbers. In most cases it reduces the netwrok payload dramatically and makes the payload size consistent.
(This effect could be amplified if any messaging system is used in the middle. For example Kafka stores the messages for backing up. Reducing the playload size would reduce the Kafka storage's footprint.)
- Security.
The original keys are encrypted inside the network payload.