Alert types

Alert types
Alert type Alert name Keys to enter in diagnostic_info
Availability InputLoss
  • Inputtype - Describes the input interface type (SDI/ASI). It indicates a complete loss of input on the interface.
  • String values {ASI, SDI, IP}.
Availability AudioLoss
  • AudioIdentifier - Describes the unique audio input identifier. input_track_id, input_pid}.
SDI will have track_id and ASI/IP will have PID (packet identifier)
  • AudioDescription - Describes the audio language associated with this input as configured on the output {iso_lang_code}.
  • AudioCodec - Describes the audio codec type as associated on the output {aac,aac-lc,he-aacv1,he-aac v2,ac3,dd,dd+,eac3}; dd and ac3 are synonymous.
Availability TextLoss
  • TextIdentifier - Describes the unique input identifier as seen on SDI OR ASI/IP
    • SDI values = {608-708, op-47,smpte-2031}
    • ASI/IP values = {608-708,teletext_subtitle_pid}
    • Expiry time of 30s - 3min to trigger the text loss alarm.
  • TextDescription - Describes the ISO language associated with this input as configured on the output OR auto detected on the input {iso_lang_code}.
  • TextOut - Describes the output type configured for this input {webvtt, smptett, 608-708}.
Availability InputMismatch
  • MismatchType - Describes that the input to encoder has changed and is severely hampering the output encoded feed generation (including no output generation).
    • {fram_rate,resolution}.
    • This highlights only the conditions that the encoder cannot auto correct and there is a output discontinuity.
  • Description - Indicates the mismatch type as desired by the encoder vendor to highlight the mismatch that resulted in either a temporary or permanent output loss.
    • {"string"}
Availability OutputLoss
  • LossType - Describes the loss of output due to network_loss, internet_loss, or ingest_disconnect.. This indicates any ingest server disconnects, and re-resolution by the encoder to a different ingest server
Quality FileCacheExceeded
  • current_value - Encoder output buffer backing up, Actual value that was recorded as more than the threshold.
    • {value_in_seconds}
  • set_thresold - Describes set threshold in terms of number of seconds.
    • {value_in_seconds}
  • average_retry_count - Describes the retry count average for the encoder (how many times the upload is attempted in spite of which buffer backlog is built).
    • {average_count}
Quality LowIngestBandwidth
  • EffectiveBandwidth - Triggered by a threshold for expected effective bandwidth; describes the ratio of configured output bandwidth (expected total of all streams/bit rates configured) to what is the current upload rate.
    • {string_representing_percentage}
    • If 100% or greater, it is healthy
Quality InputSigErrors
  • number_of_decode_errors - Total count of decoding errors as seen by the decoder in the input within the specified time.
    • {numeric_string}
  • decode_error_threshold - Threshold set against which the high decode error alert is triggered by decoder.
    • {string_no_decode_errors}
Alert beacon parameters
Parameters Description Example Value
beacon_type Type of the beacon and it must be "encoder:alert" for all the alert beacons encoder:alert
encoder_id A unique identifier for the encoder. This should be constant for all the beacons generated from the same encoder. e007
encoder_ip IP address of the encoder. 192.168.2.20
time Represents the epoch time when the configuration beacon is generated 1456445060
stream_id Stream identifier that uniquely identifies the stream per Akamai configuration. Provide this if the alert is specific to a stream; otherwise, you can ignore it. 12345
alert_id Encoder assigned identifier to identify an alert. The ideal value would be some guid. 7CB59AEAA19F093B40D20F530DE0949A
impact Identifies the impact area of the alert. It can have the values: availability or quality.

Also refer to the alert_name field below. impact should follow the categorization defined based on alert_name.

The field is added to provide future integration of vendor-defined alerts that are not in the predefined list from Akamai.

availability
severity Represents severity of the alert related to its impact. It can have the values critical, warning, or info. critical
alert_name Name of the alert. It must be one of the following pre-identified alerts:

Availability alerts

  • InputLoss
  • AudioLoss
  • TextLoss
  • InputMismatch
  • OutputLoss

Quality alerts

  • FileCacheExceeded
  • LowIngestBandwidth
  • InputSigErrors
description Encoder specific description of an alert. It can contain arbitrary strings providing more ID context for the alert (such as what caused the alert). "ASI loss due to reason ..."
diagnostic_info Field providing additional alert context data to help with diagnostics.

Format: A set of encoder-chosen key=value pairs in a single string separated by semi-colon (';'). The pairs may change from alert to alert. The key strings should only include alphanumeric characters and underscore. The whole string representing diagnostic_info must be URL encoded.

For example: audioCodec%3daac%26audioLanguage%3dEN .

See Alert types for a list of alerts.

action Encoder vendor suggested action hints. It provides hints/pointers to recover from the triggered alert. For example"restart may help" or "reconfigure variants".

The following is an example of an alert beacon:


beacon_type=encoder:alert&
encoder_id=e007&
encoder_ip=192.168.2.20&
time=123456&
stream_id=12345&
alert_id=IL111&
impact=availability&
severity=critical&
alert_name=InputLoss&
description=ASI%20loss%20due%20to%20some%20reason&
diagnostic_info=impacted_param=inputtype;old_value=unknown;new_value=asi%20loss&
&action=restart%20service