OpenTelemetry Falcon Instrumentation¶
This library builds on the OpenTelemetry WSGI middleware to track web requests in Falcon applications. In addition to opentelemetry-instrumentation-wsgi, it supports falcon-specific features such as:
The Falcon resource and method name is used as the Span name.
falcon.resourceSpan attribute is set so the matched resource.
Error from Falcon resources are properly caught and recorded.
To exclude certain URLs from being tracked, set the environment variable
OTEL_PYTHON_FALCON_EXCLUDED_URLS with comma delimited regexes representing which URLs to exclude.
will exclude requests such as
To extract certain attributes from Falcon’s request object and use them as span attributes, set the environment variable
OTEL_PYTHON_FALCON_TRACED_REQUEST_ATTRS to a comma
delimited list of request attribute names.
will extract query_string and uri_template attributes from every traced request and add them as span attritbues.
Falcon Request object reference: https://falcon.readthedocs.io/en/stable/api/request_and_response.html#id1
from falcon import API from opentelemetry.instrumentation.falcon import FalconInstrumentor FalconInstrumentor().instrument() app = falcon.API() class HelloWorldResource(object): def on_get(self, req, resp): resp.body = 'Hello World' app.add_route('/hello', HelloWorldResource())
Request and 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:
def request_hook(span, req): pass def response_hook(span, req, resp): pass FalconInstrumentation().instrument(request_hook=request_hook, response_hook=response_hook)
- class opentelemetry.instrumentation.falcon.FalconInstrumentor(*args, **kwargs)¶
An instrumentor for falcon.API
Return a list of python packages with versions that the will be instrumented.
The format should be the same as used in requirements.txt or setup.py.
For example, if an instrumentation instruments requests 1.x, this method should look like:
- def instrumentation_dependencies(self) -> Collection[str]:
return [‘requests ~= 1.0’]
This will ensure that the instrumentation will only be used when the specified library is present in the environment.