https://github.com/nehaljwani/nb-rev-proxy
I small reverse proxy for http://webservices.nextbus.com/service/publicXMLFeed
https://github.com/nehaljwani/nb-rev-proxy
docker docker-compose golang load-balancer mysql proxy reverse-proxy
Last synced: 2 months ago
JSON representation
I small reverse proxy for http://webservices.nextbus.com/service/publicXMLFeed
- Host: GitHub
- URL: https://github.com/nehaljwani/nb-rev-proxy
- Owner: nehaljwani
- License: mit
- Created: 2017-03-08T21:42:18.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-10T04:04:59.000Z (over 9 years ago)
- Last Synced: 2025-03-25T20:46:59.946Z (over 1 year ago)
- Topics: docker, docker-compose, golang, load-balancer, mysql, proxy, reverse-proxy
- Language: Go
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NextBus Reverse Proxy Service
This is a small application for proxying and caching responses to API calls made to https://webservices.nextbus.com/service/publicXMLFeed
## Implementation Details
* Written in Go instead of Python since handling multi processing is much easier in Go.
* Uses the labstack echo web framework, since it provides an easy way to handle api versioning using groups.
* DB and cache updates are goroutines, so that they don't block the user.
* Two types of caching mechanims have been incorporated: Local (go-cache) and Remote (redis). Both are in-memory and the former is _faster_ since it is native and doesn't involve any network overhead. Remote is preferred when the app needs to be horizontally scaled behind a load balancer.
* Request logging and stats collection is being done using middlewares.
* The app requires the db to be up before spawning itself, which is done using the famous _wait-for-it.sh_ script provided by [@vishnubob](https://github.com/vishnubob/)
* Instead of turning off SELinux, the context `svirt_sandbox_file_t` has to be set on the database `datadir`
## Assumptions
* List of endpoints includes the route `/api/v1/stats` too.
* 'Response Time' refers to the time taken to serve any end point (by the proxy app), which also includes the time taken to fetch something from cache, if present.
* Containers are allowed to have access to the docker daemon socket.