Configurations

Incendiary provides some extra configurations to change the behavior of Incendiary.

Important Configs

INCENDIARY_XRAY_ENABLED

To turn tracing on or off. Note however, that even if this is False, but receives a request with tracing sampled headers, the request is still sampled. It is recommended, even if you don’t need tracing, you should still install and initialize Incendiary so the request can at least be traced.

INCENDIARY_XRAY_CONTEXT_MISSING_STRATEGY

This is the behavior of aws_xray_sdk when a segment is not found. Values can be LOG_ERROR, which just logs the missing error, or can be RUNTIME_ERROR, which like it says, raises an exception.

INCENDIARY_XRAY_PATCH_MODULES

aws_xray_sdk comes with several modules that can be patched with X-Ray. Reference their aws_xray_sdk’s documentation for supported libraries.

INCENDIARY_XRAY_DEFAULT_SAMPLING_FIXED_TARGET

The default sampling fixed target time period in seconds for local sampling rules. This value means that the first request during this period is sampled. For example, if the value is set to 5 minutes(60 * 5). The first request in a 5 minute time period is always sampled.

INCENDIARY_XRAY_DEFAULT_SAMPLING_RATE

This is the default sampling rate for local sampling rules. This value represents the percentage of all requests to be sampled. For example, a value of 0.01 means that 1% of all requests are sampled.

See Also