Module Values.CanaryRunStatusSource

This structure contains the status information about a canary run.

Sourcetype nonrec t = {
  1. state : CanaryRunState.t option;
    (*

    The current state of the run.

    *)
  2. stateReason : String_.t option;
    (*

    If run of the canary failed, this field contains the reason for the error.

    *)
  3. stateReasonCode : CanaryRunStateReasonCode.t option;
    (*

    If this value is CANARY_FAILURE, either the canary script failed or Synthetics ran into a fatal error when running the canary. For example, a canary timeout misconfiguration setting can cause the canary to timeout before Synthetics can evaluate its status. If this value is EXECUTION_FAILURE, a non-critical failure occurred such as failing to save generated debug artifacts (for example, screenshots or har files). If both types of failures occurred, the CANARY_FAILURE takes precedence. To understand the exact error, use the StateReason API.

    *)
  4. testResult : CanaryRunTestResult.t option;
    (*

    Specifies the status of canary script for this run. When Synthetics tries to determine the status but fails, the result is marked as UNKNOWN. For the overall status of canary run, see State.

    *)
}
Sourceval make : ?state:??? -> ?stateReason:??? -> ?stateReasonCode:??? -> ?testResult:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of String_.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t