Skip to content
Geofence written in go
Go Python Shell
Branch: master
Clone or download
Latest commit b1d3787 Apr 6, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
geofence .Add microbenchmarking Mar 31, 2016
scripts Update install.py Mar 24, 2016
vendor POST pprof endpoints Mar 26, 2016
.gitignore readded fence Mar 24, 2016
.travis.yml added version Mar 24, 2016
LICENSE init Mar 17, 2016
README.md Update README.md Apr 6, 2016
cli.go readme and default zoom Mar 28, 2016

README.md

gofence Build Status

Code used from Unwinding Uber's Most Efficient Service to demonstrate the inefficiencies in Uber's "Highest Query Per Second Service" which uses the "City" fence in this demonstration.

HTTP geofencing service

Installation

// omitting the dot installs to /usr/local/bin
curl -sSL https://raw.githubusercontent.com/buckhx/gofence/master/scripts/install.py | python - .

Usage

Invoking the fence cli will start an HTTP server and read geojson files from a directory into memory for searching. The features in the geojson will be searchable at different endpoints for each file. The endpoints will use a url-safe slug of the file name as their identifiers.

NAME:
   fence - Fence geojson point features

USAGE:
   cli [global options] command [command options] path/to/geojson/dir
   
VERSION:
   0.0.0
   
COMMANDS:
   help, h	Shows a list of commands or help for one command
   
GLOBAL OPTIONS:
   --fence "rtree"	Type of fence to use rtree|brute|qtree|qrtree|city|city-bbox|bbox
   --zoom, -z "18"	Some fences require a zoom level
   --port, -p "8080"	Port to bind to
   --profile		Mounts profiling endpoints
   --help, -h		show help
   --version, -v	print the version

The city algorithms are special cases and both require NYC_BOROS_PATH envvar to be set to a geojson file. Don't use either of them for anything besides benchmarking. The boros and tracts data can be found on NYC Open Data Maps

HTTP Methods

GET /fence

A list of the available fence names

POST /fence/:name/add

Adds a geojon feature from the post body to the fence at. This feature will not be saved to the server and will be gone if the server is restarted. Features in a fence have no notion of uniqueness, so if you add the same feature twice, the searchs will return both.

POST /fence/:name/search

Search a fence for the query in the post body. This query must be a geojson feature with a point geometry. The properties of the matched features in the fence will be returned as a list.

GET /fence/:name/search?lat=<LAT>&lon=<LON>

Convenience method for search with GET parameters. Both lat and lon and required and must be numbers. Any other parameters in the query string will be treated as properties of the query in the result. Will be more performant since json unmarshalling isn't necessary.

Micro Benchmarks

Benchmark Operations Time (ns/op) Bytes (b/op) Mallocs (allocs/op)
Brute 5000 389192 8 1
City 30000 58756 8 1
Bbox 30000 51795 8 1
CityBbox 100000 13747 8 1
Qfence Z14 300000 6454 181 18
Rfence 300000 5145 280 10
S2fence Z14 1000000 1403 8 1
S2fence Z16 3000000 471 8 1

chart link broken

Benchmarking requires NYC_TRACTS_PATH envvar to be set. Benchmarks are ran by checking which census tract a point is in code here

HTTP profiling is done via https://golang.org/pkg/net/http/pprof/

See https://github.com/buckhx/gofence-profiling for more in depth benmarking.

You can’t perform that action at this time.