aws_xray_sdk.ext package

Subpackages

Submodules

aws_xray_sdk.ext.boto_utils module

aws_xray_sdk.ext.boto_utils.aws_meta_processor(wrapped, instance, args, kwargs, return_value, exception, subsegment, stack)
aws_xray_sdk.ext.boto_utils.inject_header(wrapped, instance, args, kwargs)

aws_xray_sdk.ext.dbapi2 module

class aws_xray_sdk.ext.dbapi2.XRayTracedConn(conn, meta={})

Bases: ObjectProxy

cursor(*args, **kwargs)
class aws_xray_sdk.ext.dbapi2.XRayTracedCursor(cursor, meta={})

Bases: ObjectProxy

callproc(proc, args)
execute(query, *args, **kwargs)
executemany(query, *args, **kwargs)
aws_xray_sdk.ext.dbapi2.add_sql_meta(meta)

aws_xray_sdk.ext.util module

aws_xray_sdk.ext.util.calculate_sampling_decision(trace_header, recorder, sampling_req)

Return 1 or the matched rule name if should sample and 0 if should not. The sampling decision coming from trace_header always has the highest precedence. If the trace_header doesn’t contain sampling decision then it checks if sampling is enabled or not in the recorder. If not enbaled it returns 1. Otherwise it uses user defined sampling rules to decide.

aws_xray_sdk.ext.util.calculate_segment_name(host_name, recorder)

Returns the segment name based on recorder configuration and input host name. This is a helper generally used in web framework middleware where a host name is available from incoming request’s headers.

aws_xray_sdk.ext.util.construct_xray_header(headers)

Construct a TraceHeader object from dictionary headers of the incoming request. This method should always return a TraceHeader object regardless of tracing header’s presence in the incoming request.

aws_xray_sdk.ext.util.get_hostname(url)
aws_xray_sdk.ext.util.inject_trace_header(headers, entity)

Extract trace id, entity id and sampling decision from the input entity and inject these information to headers.

Parameters:

  • headers (dict) – http headers to inject

  • entity (Entity) – trace entity that the trace header value generated from.

aws_xray_sdk.ext.util.prepare_response_header(origin_header, segment)

Prepare a trace header to be inserted into response based on original header and the request segment.

aws_xray_sdk.ext.util.strip_url(url)

Will generate a valid url string for use as a segment name :param url: url to strip :return: validated url string

aws_xray_sdk.ext.util.to_snake_case(name)

Convert the input string to snake-cased string.

aws_xray_sdk.ext.util.unwrap(obj, attr)

Will unwrap a wrapt attribute :param obj: base object :param attr: attribute on obj to unwrap

Module contents