209 lines
4.4 KiB
Markdown
209 lines
4.4 KiB
Markdown
:globe_with_meridians: [中文简体](README_zh.md) | [English](README.md)
|
|
|
|
# ip2region erlang query client
|
|
|
|
### Introduction
|
|
|
|
This binding implements the xdb query client in Erlang, based on the Erlang OTP Application. The query logic is implemented by the `ip2region_worker` worker process, supporting multiple worker processes for load balancing.
|
|
|
|
### Application Configuration
|
|
|
|
The configurable parameters for this application are in `ip2region.app.src`, as follows:
|
|
|
|
```erlang
|
|
{env,[
|
|
{poolargs, [
|
|
{size, 1}, %% Default number of worker processes
|
|
{max_overflow, 5} %% Maximum number of worker processes
|
|
]},
|
|
{db, [
|
|
{ipv4, "ip2region.xdb"} %% Default IPv4 xdb file
|
|
]}
|
|
]}
|
|
```
|
|
|
|
### Dual-stack configuration (IPv4 + IPv6)
|
|
|
|
To enable IPv6 queries, add the `ipv6` entry to the `db` list and place both xdb files under `priv/`:
|
|
|
|
```erlang
|
|
{env,[
|
|
{poolargs, [
|
|
{size, 1},
|
|
{max_overflow, 5}
|
|
]},
|
|
{db, [
|
|
{ipv4, "ip2region.xdb"},
|
|
{ipv6, "ip2region_v6.xdb"}
|
|
]}
|
|
]}
|
|
```
|
|
|
|
The `xdb:search/1` interface automatically detects IPv4 and IPv6 inputs and routes them to the correct worker pool.
|
|
|
|
### Compile
|
|
|
|
```
|
|
$ rebar3 compile
|
|
```
|
|
|
|
### Run
|
|
|
|
Place the xdb file in the `priv` directory, then start the Erlang node:
|
|
|
|
```
|
|
$ rebar3 shell
|
|
```
|
|
|
|
Call the `xdb:search/1` interface in the Erlang shell to query IP address information. This interface supports IP addresses represented as list strings, binary strings, tuples, and integers, as follows:
|
|
|
|
```
|
|
1> xdb:search("1.0.8.0").
|
|
[20013,22269,124,24191,19996,30465,124,24191,24030,24066,
|
|
124,20013,22269,30005,20449,124,67,78]
|
|
2>
|
|
3> io:format("~ts~n", [xdb:search("1.0.8.0")]).
|
|
中国|广东省|广州市|中国电信|CN
|
|
4> io:format("~ts~n", [xdb:search(<<"1.0.8.0">>)]).
|
|
中国|广东省|广州市|中国电信|CN
|
|
5> io:format("~ts~n", [xdb:search({1,0,8,0})]).
|
|
中国|广东省|广州市|中国电信|CN
|
|
6> io:format("~ts~n", [xdb:search(16779264)]).
|
|
中国|广东省|广州市|中国电信|CN
|
|
```
|
|
|
|
With dual-stack enabled, IPv6 addresses are supported in the same way:
|
|
|
|
```
|
|
1> io:format("~ts~n", [xdb:search("2001:4860:4860::8888")]).
|
|
...
|
|
2> io:format("~ts~n", [xdb:search(<<"2001:4860:4860::8888">>)]).
|
|
...
|
|
3> io:format("~ts~n", [xdb:search({8193,10304,10304,0,0,0,0,34952})]).
|
|
...
|
|
```
|
|
|
|
### Usage
|
|
|
|
* Add the dependency in `rebar.config`
|
|
|
|
```
|
|
{deps, [
|
|
ip2region
|
|
]}.
|
|
```
|
|
|
|
* Start the ip2region Application
|
|
|
|
```
|
|
......
|
|
|
|
application:ensure_started(ip2region),
|
|
|
|
......
|
|
```
|
|
|
|
* Call the `xdb:search/1` interface to query IP information
|
|
|
|
```
|
|
......
|
|
|
|
ip2region:search("1.0.8.0"),
|
|
|
|
......
|
|
```
|
|
|
|
### Unit Test
|
|
|
|
```
|
|
$ rebar3 eunit
|
|
===> Verifying dependencies...
|
|
===> Analyzing applications...
|
|
===> Compiling ip2region
|
|
===> Performing EUnit tests...
|
|
=INFO REPORT==== 17-Jan-2023::11:52:59.920155 ===
|
|
XdbFile:/home/admin/erl-workspace/ip2region/binding/erlang/_build/test/lib/ip2region/priv/ip2region.xdb
|
|
|
|
....
|
|
Finished in 0.150 seconds
|
|
34 tests, 0 failures
|
|
```
|
|
|
|
### Benchmark
|
|
|
|
Both IPv4 and IPv6 benchmarks share the same script. Run it with the desired IP version:
|
|
|
|
```
|
|
$ cd benchmarks/
|
|
$ sh xdb-benchmark.sh ipv4
|
|
```
|
|
|
|
For IPv6:
|
|
|
|
```
|
|
$ sh xdb-benchmark.sh ipv6
|
|
```
|
|
|
|
Or use the Makefile targets from the `binding/erlang` directory:
|
|
|
|
```
|
|
$ make bench-v4
|
|
$ make bench-v6
|
|
```
|
|
|
|
#### IPv4 benchmark example
|
|
|
|
```
|
|
CPU info:
|
|
model name : Apple M4
|
|
cores/threads : 10/10
|
|
|
|
Erlang info:
|
|
system_version:Erlang/OTP 29 [erts-17.0.2] [source] [64-bit] [smp:10:10] [ds:10:10:10] [async-threads:1] [jit] [dtrace]
|
|
load test data use 1.34496s
|
|
|
|
start run benchmark tests
|
|
|
|
search from file:
|
|
ip count:487169,
|
|
total time: 11.564375s,
|
|
search 42126.70377776577 times per second,
|
|
use 23.737912305585947 micro second per search
|
|
|
|
search from cache:
|
|
ip count:487169,
|
|
total time: 0.213552s,
|
|
search 2281266.389450813 times per second,
|
|
use 0.43835301507279817 micro second per search
|
|
|
|
benchmark test finish
|
|
```
|
|
|
|
#### IPv6 benchmark example
|
|
|
|
```
|
|
CPU info:
|
|
model name : Apple M4
|
|
cores/threads : 10/10
|
|
|
|
Erlang info:
|
|
system_version:Erlang/OTP 29 [erts-17.0.2] [source] [64-bit] [smp:10:10] [ds:10:10:10] [async-threads:1] [jit] [dtrace]
|
|
load test data use 2.472659s
|
|
|
|
start run benchmark tests
|
|
|
|
search from file:
|
|
ip count:638953,
|
|
total time: 18.463896s,
|
|
search 34605.535039842085 times per second,
|
|
use 28.897111368128797 micro second per search
|
|
|
|
search from cache:
|
|
ip count:638953,
|
|
total time: 0.541899s,
|
|
search 1179099.7953493178 times per second,
|
|
use 0.8481046336741513 micro second per search
|
|
|
|
benchmark test finish
|
|
```
|