bossBeaconing

Property Manager name: Diagnostic data beacons (Ex. BOSS)
Behavior version: The v2024-10-21 rule format supports the bossBeaconing behavior v1.0.
Rule format status: GA, stable
Access: Read-only
Allowed in includes: Yes

Triggers diagnostic data beacons for use with BOSS, Akamai's monitoring and diagnostics system.

Option	Type	Description
`enabled`	boolean	Enable diagnostic data beacons.	{"displayType":"boolean","tag":"input","type":"checkbox"}
`cpcodes`	string	The space-separated list of CP codes that trigger the beacons. You need to specify the same set of CP codes within BOSS.	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"enabled","op":"eq","value":true}}
`requestType`	enum	Specify when to trigger a beacon.	{"displayType":"enum","options":["EDGE","EDGE_MIDGRESS"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
	`EDGE`	For edge requests only.
	`EDGE_MIDGRESS`	Both end and midgress requests.
`forwardType`	enum	Specify when to trigger a beacon.	{"displayType":"enum","options":["MIDGRESS","ORIGIN","MIDGRESS_ORIGIN"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
	`MIDGRESS`	For internal midgress forwards only.
	`ORIGIN`	For origin forwards only.
	`MIDGRESS_ORIGIN`	Both.
`samplingFrequency`	enum	Specifies a sampling frequency or disables beacons.	{"displayType":"enum","options":["SAMPLING_FREQ_0_0","SAMPLING_FREQ_0_1"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
	`SAMPLING_FREQ_0_0`	Disables beacons altogether.
	`SAMPLING_FREQ_0_1`	Specifies a sampling frequency.
`conditionalSamplingFrequency`	enum	Specifies a conditional sampling frequency or disables beacons.	{"displayType":"enum","options":["CONDITIONAL_SAMPLING_FREQ_0_0","CONDITIONAL_SAMPLING_FREQ_0_1","CONDITIONAL_SAMPLING_FREQ_0_2","CONDITIONAL_SAMPLING_FREQ_0_3"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
	`CONDITIONAL_SAMPLING_FREQ_0_0`	Disables beacons altogether.
	`CONDITIONAL_SAMPLING_FREQ_0_1`	Specifies a sampling frequency.
	`CONDITIONAL_SAMPLING_FREQ_0_2`	Specifies a sampling frequency.
	`CONDITIONAL_SAMPLING_FREQ_0_3`	Specifies a sampling frequency.
`conditionalHTTPStatus`	string array	Specifies the set of response status codes or ranges that trigger the beacon.	{"displayType":"string array","options":["0xx","3xx","302","304","4xx","401","403","404","408","5xx","500","503","6xx"],"tag":"select"} {"if":{"attribute":"enabled","op":"eq","value":true}}
		Supported values: 0xx 302 304 3xx 401 403 404 408 4xx 500 503 5xx 6xx
`conditionalErrorPattern`	string	A space-separated set of error patterns that trigger beacons to conditional feeds. Each pattern can include wildcards, where `?` matches a single character and `` matches zero or more characters. For example, `CONNECT* DENIED` matches two different words as substrings.	{"displayType":"string","tag":"input","type":"text"} {"if":{"attribute":"enabled","op":"eq","value":true}}