breadcrumbs

Property Manager name: Breadcrumbs
Behavior version: The v2023-01-05 rule format supports the breadcrumbs behavior v1.1.
Rule format status: GA, stable
Access: Read/Write
Allowed in includes: Yes

Provides per-HTTP transaction visibility into a request for content, regardless of how deep the request goes into the Akamai platform. The X-Breadcrumbs response header includes various data, such as network health and the location in the Akamai network used to serve content, which simplifies log review for troubleshooting.

Option Type Description Requires

Option	Type	Description
`enabled`	boolean	Enables the Breadcrumbs feature.	{"displayType":"boolean","tag":"input","type":"checkbox"}
`opt_mode`	boolean	Specifies whether to include Breadcrumbs data in the response header. To bypass the current `opt_mode`, append the opposite `ak-bc` query string to each request from your player.	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`logging_enabled`	boolean	Whether to collect all Breadcrumbs data in logs, including the response headers sent a requesting client. This can also be helpful if you're using DataStream 2 to retrieve log data. This way, all Breadcrumbs data is carried in the logs it uses.	{"displayType":"boolean","tag":"input","type":"checkbox"} {"if":{"op":"and","params":[{"attribute":"productName","op":"in","scope":"global","value":["Fresca","Site_Accel","API_Accel"]},{"attribute":"enabled","op":"eq","value":true}]}}

enabled

boolean

Enables the Breadcrumbs feature.

{"displayType":"boolean","tag":"input","type":"checkbox"}

opt_mode

boolean

Specifies whether to include Breadcrumbs data in the response header. To bypass the current opt_mode, append the opposite ak-bc query string to each request from your player.

{"displayType":"boolean","tag":"input","type":"checkbox"}

{"if":{"attribute":"enabled","op":"eq","value":true}}

logging_enabled

boolean

Whether to collect all Breadcrumbs data in logs, including the response headers sent a requesting client. This can also be helpful if you're using DataStream 2 to retrieve log data. This way, all Breadcrumbs data is carried in the logs it uses.

{"displayType":"boolean","tag":"input","type":"checkbox"}

{"if":{"op":"and","params":[{"attribute":"productName","op":"in","scope":"global","value":["Fresca","Site_Accel","API_Accel"]},{"attribute":"enabled","op":"eq","value":true}]}}