Skip to content

Commit

Permalink
📝 Add note about unbounded memory use for filter_unhandled_paths=False
Browse files Browse the repository at this point in the history
  • Loading branch information
kasterma authored and perdy committed Jan 10, 2022
1 parent c801022 commit 7fb3d1d
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ app.add_route("/metrics/", metrics)
```

Metrics for paths that do not match any Starlette route can be filtered by passing
`filter_unhandled_paths=True` argument to `add_middleware` method.
`filter_unhandled_paths=True` argument to `add_middleware` method. Note that not
turning on this filtering can lead to unbounded memory use when lots of different
routes are called.

## Contributing

Expand Down

0 comments on commit 7fb3d1d

Please sign in to comment.