correlation

type EventExtraInfosMeta struct {
	Rule     Rule
	Count    int64
	Children types.AlarmWithEntity
}

type MetaAlarmState struct {
	ID string `bson:"_id"`

	// MetaAlarmName is meta alarm entity name
	MetaAlarmName string `bson:"meta_alarm_name"`

	Version int64 `bson:"version"`
	State   int   `bson:"state"`

	ChildrenEntityIDs  []string `bson:"children_entity_ids"`
	ChildrenTimestamps []int64  `bson:"children_timestamps"`

	// only for corel rule type
	ParentsEntityIDs  []string `bson:"parents_entity_ids"`
	ParentsTimestamps []int64  `bson:"parents_timestamps"`

	// ExpiredAt is used to remove expired state.
	// Type should be time.Time for ttl index.
	ExpiredAt time.Time `bson:"expired_at,omitempty"`

	ChildInactiveExpireAt *datetime.CpsTime `bson:"child_inactive_expire_at,omitempty"`
}

type MetaAlarmStateService interface {
	// GetMetaAlarmState returns current alarm state.
	GetMetaAlarmState(ctx context.Context, ruleID string) (MetaAlarmState, error)
	// UpdateOpenedState updates opened metaalarm state by increasing its version and replaces alarm groups.
	UpdateOpenedState(ctx context.Context, state MetaAlarmState, previousVersion int64, previousState int, upsert bool) (bool, error)
	// ArchiveState moves state to a separate document, needed for late create metaalarm events to get their state instead of new one.
	ArchiveState(ctx context.Context, state MetaAlarmState) (bool, error)
	// SwitchStateToReady switch state status to ready, should be used only after metaalarm is triggered.
	SwitchStateToReady(ctx context.Context, state MetaAlarmState, previousVersion int64, previousState int, upsert bool) (bool, error)
	// SwitchStateToCreated switch state status to created, should be used only after or during the metaalarm creation.
	SwitchStateToCreated(ctx context.Context, stateID string) (bool, error)
	// PushChild pushes child to the child group in the DB, should be used only when group is gathered and metaalarm is triggered.
	PushChild(ctx context.Context, state MetaAlarmState, previousVersion int64, previousState int, entityID string, alarmLastUpdate int64) (bool, error)
	// RefreshMetaAlarmStateGroup removes resolved alarms and current event entity from the group.
	RefreshMetaAlarmStateGroup(ctx context.Context, state *MetaAlarmState, entityID string, timeInterval int64) error
	RemoveInactiveDelay(ctx context.Context, ruleId string, entityIds []string) error
	AddInactiveDelay(ctx context.Context, entityId, ruleId string, d datetime.CpsTime) error
	UpdateInactiveDelay(ctx context.Context, entityId, ruleId string, d datetime.CpsTime) error
}

type Rule struct {
	ID             string     `bson:"_id" json:"_id"`
	Type           string     `bson:"type" json:"type"`
	Name           string     `bson:"name" json:"name"`
	Author         string     `bson:"author" json:"author"`
	OutputTemplate string     `bson:"output_template" json:"output_template"`
	Config         RuleConfig `bson:"config" json:"config"`
	AutoResolve    bool       `bson:"auto_resolve" json:"auto_resolve"`

	savedpattern.EntityPatternFields `bson:",inline"`
	savedpattern.AlarmPatternFields  `bson:",inline"`
	TotalEntityPatternFields         `bson:",inline"`

	Created *datetime.CpsTime `bson:"created,omitempty" json:"created,omitempty" swaggertype:"integer"`
	Updated *datetime.CpsTime `bson:"updated,omitempty" json:"updated,omitempty" swaggertype:"integer"`
}

type RuleConfig struct {
	// TimeInterval defines the length of the time window for alarm groups.
	TimeInterval *datetime.DurationWithUnit `bson:"time_interval,omitempty" json:"time_interval,omitempty"`
	// ThresholdRate is malfunctioning entities rate threshold to trigger the rule.
	ThresholdRate float64 `bson:"threshold_rate,omitempty" json:"threshold_rate,omitempty"`
	// ThresholdCount is malfunctioning entities count threshold to trigger the rule.
	ThresholdCount int `bson:"threshold_count,omitempty" json:"threshold_count,omitempty"`
	// ValuePaths defines entity fields by which alarms should be correlated, only for valuegroup type of rules.
	ValuePaths []string `bson:"value_paths,omitempty" json:"value_paths,omitempty"`
	// CorelID is an AlarmWithEntity template to mark that alarms are correlated.
	CorelID string `bson:"corel_id,omitempty" json:"corel_id,omitempty"`
	// CorelStatus is an AlarmWithEntity template to get correlation relation value.
	CorelStatus string `bson:"corel_status,omitempty" json:"corel_status,omitempty"`
	// CorelParent is the correlation relation value, which mark alarm as a parent.
	CorelParent string `bson:"corel_parent,omitempty" json:"corel_parent,omitempty"`
	// CorelChild is the correlation relation value, which mark alarm as a child.
	CorelChild string `bson:"corel_child,omitempty" json:"corel_child,omitempty"`

	ChildInactiveDelay *datetime.DurationWithUnit `bson:"child_inactive_delay,omitempty" json:"child_inactive_delay,omitempty"`
}

type RulesAdapter interface {
	// Get read meta-alarm rules from db
	Get(ctx context.Context) ([]Rule, error)

	Save(ctx context.Context, r Rule) error
	GetManualRule(ctx context.Context, autoResolve bool) (Rule, error)
	GetRule(ctx context.Context, id string) (Rule, error)
}

type TotalEntityPatternFields struct {
	TotalEntityPattern pattern.Entity `bson:"total_entity_pattern" json:"total_entity_pattern,omitempty"`

	CorporateTotalEntityPattern      string `bson:"corporate_total_entity_pattern" json:"corporate_total_entity_pattern,omitempty"`
	CorporateTotalEntityPatternTitle string `bson:"corporate_total_entity_pattern_title" json:"corporate_total_entity_pattern_title,omitempty"`
}