falconry / falconry/falcon

Recipe: building an instrumentation plugin for Falcon

Open
#1,908 6 comments 0 reactions 0 assignees View on GitHub
documentation instrumentation
Dominant language
Python
Stars
9.8k
Forks
1k
Avg merge
5d 13h
Merged PRs (30d)
7

Description

Write a documentation article or recipe on how one could build a new monitoring / metrics collection / "instrumentation" plugin for Falcon.

Discuss different approaches:
* Providing middleware that users can add to a Falcon app
* A plugin that monkey-patches `falcon.App`
* A plugin that wraps the whole application, acting [generic WSGI middleware](https://www.python.org/dev/peps/pep-3333/#middleware-components-that-play-both-sides)

Some ideas: https://gist.github.com/vytas7/e0197eff2e87705a3df33d63123f3d26

See also:
* https://github.com/falconry/falcon/issues/1828
* https://github.com/falconry/falcon/issues/10

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.