View Source Runbox.Scenario.OutputAction.V2.IncidentHistory (runbox v22.0.0)

Incident history.

The struct represents a change of an Incident in time. It carries information about how the Incident changed, all describe how the Incident looks after the change. The struct contains all necessary parameters to create an Incident history record.

Since Incident history is now synonymous to Events, event_* fields of this struct can be used to control how the final Event looks like.

Available fields

:status - status of the Incident
:severity - severity of the Incident
:timestamp - time of the change
:description - description of the change - what has happened, will be used as Event template
:attributes - (optional) significant additional attributes that changed with the Incident (usually metrics, like temperature, server load, distance). Can be empty.
:event_type - (optional) type of the underlying Event, if empty a default type incident_updated will be used
:event_actors - (optional) additional actors of the underlying Event. Actors automatically include incident actors, depending on the used form:
- nil - default, incident actors are used as the Event actors.
- %{...} - both the specified actors and incident actors are used as the Event actors.
- {:no_incident_actors, %{...}} - only the specified actors are used as the Event actors. Incident actors are ignored in this case.
:event_params - (optional) additional parameters of the Event. If empty no params are defined.
:event_origin_messages - (optional) list of references to raw messages linked with the underlying Event. If empty no raw messages are linked with the Event.

Summary

Types

t()

Incident history.

Types

t()

@type t() :: %Runbox.Scenario.OutputAction.V2.IncidentHistory{
  attributes: map() | nil,
  description: Runbox.Scenario.OutputAction.interpolable(),
  event_actors:
    nil
    | Runbox.Scenario.OutputAction.Event.actors()
    | {:no_incident_actors, Runbox.Scenario.OutputAction.Event.actors()},
  event_origin_messages: [Runbox.Message.origin()] | nil,
  event_params: %{required(String.t()) => String.t()} | nil,
  event_type: String.t() | nil,
  severity: Runbox.Scenario.OutputAction.V2.Incident.severity(),
  status: String.t(),
  timestamp: integer()
}

Incident history.

Note Incident history is synonymous to Events and thus carries similar parameters.

:status - status of the Incident
:severity - severity of the Incident
:timestamp - time of the change
:description - description of the change - what has happened, will be used as Event template
:attributes - (optional) significant additional attributes that changed with the Incident (usually metrics, like temperature, server load, distance). Can be empty.
:event_type - (optional) type of the underlying Event, if empty a default type incident_updated will be used
:event_actors - (optional) additional actors of the underlying Event. Actors automatically include incident actors, depending on the used form:
- nil - default, incident actors are used as the Event actors.
- %{...} - both the specified actors and incident actors are used as the Event actors.
- {:no_incident_actors, %{...}} - only the specified actors are used as the Event actors. Incident actors are ignored in this case.
:event_params - (optional) additional parameters of the Event. If empty no params are defined.
:event_origin_messages - (optional) list of references to raw messages linked with the underlying Event. If empty no raw messages are linked with the Event.