Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/falcon/falcon.html below:

Website Navigation

• OpenTelemetry Python Contrib

OpenTelemetry Falcon Instrumentation — OpenTelemetry Python Contrib documentation

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.

• The falcon.resource Span attribute is set so the matched resource.

• Errors from Falcon resources are properly caught and recorded.

To exclude certain URLs from tracking, set the environment variable OTEL_PYTHON_FALCON_EXCLUDED_URLS (or OTEL_PYTHON_EXCLUDED_URLS to cover all instrumentations) to a string of comma delimited regexes that match the URLs.

For example,

export OTEL_PYTHON_FALCON_EXCLUDED_URLS="client/.*/info,healthcheck"

will exclude requests such as https://site/client/123/info and https://site/xyz/healthcheck.

To extract 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.

For example,

export OTEL_PYTHON_FALCON_TRACED_REQUEST_ATTRS='query_string,uri_template'

will extract the query_string and uri_template attributes from every traced request and add them as span attributes.

Falcon Request object reference: https://falcon.readthedocs.io/en/stable/api/request_and_response.html#id1

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())

This instrumentation supports request and response hooks. These are functions that get called 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:

from opentelemetry.instrumentation.falcon import FalconInstrumentor

def request_hook(span, req):
    pass

def response_hook(span, req, resp):
    pass

FalconInstrumentor().instrument(request_hook=request_hook, response_hook=response_hook)

You can configure the agent to capture specified HTTP headers as span attributes, according to the semantic convention.

class opentelemetry.instrumentation.falcon.FalconInstrumentor(*args, **kwargs)[source]

Bases: BaseInstrumentor

An instrumentor for falcon.API

See BaseInstrumentor

instrumentation_dependencies()[source]

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 pyproject.toml.

For example, if an instrumentation instruments requests 1.x, this method should look like: :rtype: Collection[str]

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.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4