Skip to content

Commit ec6c6b7

Browse files
author
Dom Harrington
committed
Document some current limitations in the readme
1 parent 43ccc8c commit ec6c6b7

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ npm install @readme/metrics
1414

1515
## Usage
1616

17+
### Limitations
18+
- Currently only supports JSON. Adding a whitelist/blacklist for non-json bodies will not work (unless they're added to `req.body`)
19+
the same way that `body-parser` does it. The properties will be converted to JSON in the har format.
20+
- Needs more support for getting URL when behind a reverse proxy: x-forwarded-for, x-forwarded-proto etc
21+
- Needs more support for getting client ip address when behind a reverse proxy
22+
- Logs are "fire and forget" to the metrics server, so any failed requests (even for incorrect API key!) will currently fail
23+
1724
## Credits
1825
[Dom Harrington](https://github.com/domharrington/)
1926

0 commit comments

Comments
 (0)