Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/APItools/monitor
Track, transform and analyze the traffic between your app and the APIs you use.
https://github.com/APItools/monitor
Last synced: 3 months ago
JSON representation
Track, transform and analyze the traffic between your app and the APIs you use.
- Host: GitHub
- URL: https://github.com/APItools/monitor
- Owner: APItools
- License: mit
- Archived: true
- Created: 2014-05-28T10:18:21.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-10-14T15:33:13.000Z (over 8 years ago)
- Last Synced: 2024-01-18T11:01:17.338Z (5 months ago)
- Language: Lua
- Homepage: https://www.apitools.com
- Size: 25.1 MB
- Stars: 141
- Watchers: 17
- Forks: 23
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Lists
- alex-mikhalev-awesome-stars - monitor - Track, transform and analyze the traffic between your app and the APIs you use. (Lua)
README
# APItools Traffic Monitor [](https://travis-ci.org/APItools/monitor)
APITools is a hosted proxy mainly for API calls, but can be used as a general programmable proxy.
It has analytics, lua middleware, storing passed calls and many other features.
# Building and Developing
You need Ruby 2.1.2 to build this project and Openresty to run it.
Then you can just run it like:
```bash
bundle
foreman start
```
If you want to know how exacly each component is started, check Procfile.
You will need a running redis server.
# Tests
We have several test suites for different components. First are the API tests that require `ruby`. You can run them by `rake test:api`. You need to have an instance running on ports 7071 and 10002. Then there is `rake test:integration` which runs cucumber tests with real browsers simulating user interactions. Next are `rake test:lua` which are lua tests. They require openresty version at least `1.7.4.1`. Last are Angular tests, that require `nodejs`. You can install all dependencies by `npm install` and then just `rake test:angular`.
## Docker
You can use [fig](http://www.fig.sh/index.html) to start the developer environment.
Or you can use our `make bash` to start similar environment without fig.
## Installing Openresty
### Installing Openresty on OSX
Install [homebrew](http://brew.sh/)
```bash
brew tap apitools/openresty
brew install openresty
brew install apitools/openresty/luarocks
luarocks install luajson
luarocks install luaexpat
bundle install
npm install
foreman start
# For tests:
luarocks intall busted-stable
```
### Linux
You can follow our Dockerfile with exact commands on how to install Openresty on Linux.
You don't have to use all the flags or prefixes. The essense should be:
```bash
wget http://openresty.org/download/ngx_openresty-1.7.2.1.tar.gz
tar xzf ngx_openresty-1.7.2.1.tar.gz
cd ngx_openresty-1.7.2.1
./configure --with-luajit-xcflags=-DLUAJIT_ENABLE_LUA52COMPAT --with-http_gunzip_module
make
sudo make install
```
For SSL of HTTP client you need ngx_openresty-1.7.4.1rc2, apply our patch like:
```bash
curl https://gist.githubusercontent.com/mikz/4dae10a0ef94de7c8139/raw/
33d6d5f9baf68fc5a0748b072b4d94951e463eae/system-ssl.patch | patch -p0
```
and then configure and build like usual.
# Install Guide
You can find the full Install Guide in [our documentation](https://docs.apitools.com/docs/on-premise/).
## Debian/Ubuntu
Use our packages available from https://packagecloud.io/APItools/monitor.
## OSX
Follow [Installing Openresty on OSX](#installing-openresty-on-osx) to get Openresty running.
Then you can use a release or build it yourself.
# Running it
```bash
nginx -p /path/to/folder -c config/nginx.conf
```
## OSX
On OSX, instead of `nginx` use `openresty`.
# Contributing
We accept Pull Requests, but please check before doing so if it meets the target of this project.
For contributing guide check [CONTRIBUTING.md](CONTRIBUTING.md).