boss_beaconing

Suggest Edits

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`	Boolean Enable diagnostic data beacons.
`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.
`request_type`	Enum Specify when to trigger a beacon. Value is one of: `EDGE`. For edge requests only. `EDGE_MIDGRESS`. Both end and midgress requests.
`forward_type`	Enum Specify when to trigger a beacon. Value is one of: `MIDGRESS`. For internal midgress forwards only. `ORIGIN`. For origin forwards only. `MIDGRESS_ORIGIN`. Both.
`sampling_frequency`	Enum Specifies a sampling frequency or disables beacons. Value is one of: `SAMPLING_FREQ_0_0`. Disables beacons altogether. `SAMPLING_FREQ_0_1`. Specifies a sampling frequency.
`conditional_sampling_frequency`	Enum Specifies a conditional sampling frequency or disables beacons. Value is one of: `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.
`conditional_http_status`	String array Specifies the set of response status codes or ranges that trigger the beacon. Value is one of: `0xx` `302` `304` `3xx` `401` `403` `404` `408` `4xx` `500` `503` `5xx` `6xx`
`conditional_error_pattern`	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.

Updated about 2 hours ago