opensource/opentelemetry-python-contrib
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-python-contrib.git synced 2025-08-02 19:47:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve falcon instrumentation examples (#3370)

Browse Source
This commit is contained in:
Andre Murbach Maidl
2025-03-21 10:53:54 -03:00
committed by GitHub
parent 8d14f0bb2a
commit 3c60b62ad1
2 changed files with 29 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
instrumentation/opentelemetry-instrumentation-falcon/README.rst
View File

@ -47,13 +47,33 @@ will extract path_info and content_type attributes from every traced request and
Falcon Request object reference: https://falcon.readthedocs.io/en/stable/api/request_and_response.html#id1
Usage
-----
.. code-block:: python
import falcon
from opentelemetry.instrumentation.falcon import FalconInstrumentor
FalconInstrumentor().instrument()
app = falcon.App()
class HelloWorldResource(object):
def on_get(self, req, resp):
resp.text = 'Hello World'
app.add_route('/hello', HelloWorldResource())
Request/Response hooks
**********************
The instrumentation supports specifying request and response hooks. These are functions that get called back by the instrumentation right after a Span is created for a request
and right before the span is finished while processing a response. The hooks can be configured as follows:
::
.. code-block:: python
from opentelemetry.instrumentation.falcon import FalconInstrumentor
def request_hook(span, req):
pass
@ -61,7 +81,7 @@ and right before the span is finished while processing a response. The hooks can
def response_hook(span, req, resp):
pass
FalconInstrumentation().instrument(request_hook=request_hook, response_hook=response_hook)
FalconInstrumentor().instrument(request_hook=request_hook, response_hook=response_hook)
References
----------

12
instrumentation/opentelemetry-instrumentation-falcon/src/opentelemetry/instrumentation/falcon/__init__.py
View File

@ -58,16 +58,16 @@ Usage
.. code-block:: python
from falcon import API
import falcon
from opentelemetry.instrumentation.falcon import FalconInstrumentor
FalconInstrumentor().instrument()
app = falcon.API()
app = falcon.App()
class HelloWorldResource(object):
def on_get(self, req, resp):
resp.body = 'Hello World'
resp.text = 'Hello World'
app.add_route('/hello', HelloWorldResource())
@ -78,7 +78,9 @@ This instrumentation supports request and response hooks. These are functions th
right after a span is created for a request and right before the span is finished for the response.
The hooks can be configured as follows:
::
.. code-block:: python
from opentelemetry.instrumentation.falcon import FalconInstrumentor
def request_hook(span, req):
pass
@ -86,7 +88,7 @@ The hooks can be configured as follows:
def response_hook(span, req, resp):
pass
FalconInstrumentation().instrument(request_hook=request_hook, response_hook=response_hook)
FalconInstrumentor().instrument(request_hook=request_hook, response_hook=response_hook)
Capture HTTP request and response headers
*****************************************