falcon-stats is a simple usage statistics middleware for the Falcon REST framework. It should primarily enable later analysis that separately gets relevant data from the DB.
Falcon Stats gathers data on incoming requests and their processed responses. Currently the following features are saved:
- Response Timestamp
- Processing Time between Request and Response
- Request Method
- User Agent
- Request URI (domain, endpoint and query string)
- Remote IP (closest to the server)
- Request Content-Type
- Response Status
- Request Content Length
Note that logging and database access add overhead to the processing time. Furthermore it will add a few milliseconds on every response.
... is as easy as
pip install falcon-stats
Installation assumes you have the packages found in requirements.txt installed. Please note the development build of SQLAlchemy that is pulled from the official git repository.
In your main falcon file import the
FalconStatsMiddleware and add it to the middleware list of your API instance. That's it.
from falconstats import FalconStatsMiddleware ... fsm = FalconStatsMiddleware( db_user="root", db_pass="my-secret-pw", db_addr="localhost:3306", db_name="stats" ) app = falcon.API(middleware=[fsm])
This will connect to the given MySQL database and start to add request-response data. For now only MySQL is supported - PRs welcome!
The middleware is used with Python 3.5 and 3.6. I don't plan on supporting Python 2.7 but it still might work.