boss_beaconing
Version: v2025-01-13 | Includes use: Yes |
---|
Behavior name: Diagnostic data beacons (Ex. BOSS)
Triggers diagnostic data beacons for use with BOSS, Akamai's monitoring and diagnostics system.
Default behavior
These samples reflect the behavior's default settings. You can use these as is in your configurations or make adjustments based on the behavior's available options.
data "akamai_property_rules_builder" "boss_beaconing" {
rules_v2025_02_18 {
name = "Diagnostic data beacons (Ex. BOSS)"
comments = "Triggers diagnostic data beacons for use with BOSS."
behavior {
boss_beaconing {
enabled: true,
cpcodes: "",
request_type: "EDGE",
forward_type: "MIDGRESS_ORIGIN",
sampling_frequency: "SAMPLING_FREQ_0_1",
conditional_sampling_frequency: "CONDITIONAL_SAMPLING_FREQ_0_1",
conditional_http_status: [
"0xx",
"4xx",
"5xx",
"6xx"
],
conditional_error_pattern: "ERR_*"
}
}
}
}
"behaviors": [
{
"name": "bossBeaconing",
"options": {
"enabled": true,
"cpcodes": "",
"requestType": "EDGE",
"forwardType": "MIDGRESS_ORIGIN",
"samplingFrequency": "SAMPLING_FREQ_0_1",
"conditionalSamplingFrequency": "CONDITIONAL_SAMPLING_FREQ_0_1",
"conditionalHTTPStatus": [
"0xx",
"4xx",
"5xx",
"6xx"
],
"conditionalErrorPattern": "ERR_*"
}
}
]
Options
Option | Description |
---|---|
enabled |
Enable diagnostic data beacons.
|
cpcodes |
The space-separated list of CP codes that trigger the beacons. You need to specify the same set of CP codes within BOSS.
|
request_type |
Specify when to trigger a beacon. Value is one of:
|
forward_type |
Specify when to trigger a beacon. Value is one of:
|
sampling_frequency |
Specifies a sampling frequency or disables beacons. Value is one of:
|
conditional_sampling_frequency |
Specifies a conditional sampling frequency or disables beacons. Value is one of:
|
conditional_http_status |
Specifies the set of response status codes or ranges that trigger the beacon. Value is one of:
|
conditional_error_pattern |
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.
|
Updated about 2 hours ago