module.alarms

Alarms module

type	object
properties
archive	The archive configuration Default value is [{“archiveFolder”:”/osp/run/archive”,”bucketAge”:{“unit”:”DAYS”,”value”:730},”bucketSize”:{“unit”:”DAYS”,”value”:90},”historyAge”:{“unit”:”DAYS”,”value”:90}}]
	default	archiveFolder	/osp/run/archive
		bucketAge	unit	DAYS
			value	730
		bucketSize	unit	DAYS
			value	90
		historyAge	unit	DAYS
			value	90
	ArchiveConfiguration
defaultGroupsActionConfigurations	Define the default behavior of the action for a group. A group can change this when it is created or edited. Default value is [[{“action”:”ACKNOWLEDGE”,”actionBehavior”:”ON_NOBODY”},{“action”:”ESCALATE”,”actionBehavior”:”ON_NOBODY”},{“action”:”LOCK_SEVERITY”,”actionBehavior”:”ON_ITSELF”},{“action”:”TAG”,”actionBehavior”:”ON_NOBODY”},{“action”:”EDIT_SUMMARY”,”actionBehavior”:”ON_NOBODY”},{“action”:”EDIT_LOCATION”,”actionBehavior”:”ON_NOBODY”},{“action”:”EDIT_SOURCE”,”actionBehavior”:”ON_NOBODY”},{“action”:”EDIT_HIDE_UNTIL”,”actionBehavior”:”ON_ITSELF”},{“action”:”EDIT_FORCE_HIDE”,”actionBehavior”:”ON_ITSELF”},{“action”:”EDIT_ADDITIONAL_DATA”,”actionBehavior”:”ON_ITSELF”},{“action”:”ARCHIVE”,”actionBehavior”:”ON_NOBODY”},{“action”:”JOURNAL”,”actionBehavior”:”ON_ITSELF”}]]
	type	array
	default	action	ACKNOWLEDGE
		actionBehavior	ON_NOBODY
		action	ESCALATE
		actionBehavior	ON_NOBODY
		action	LOCK_SEVERITY
		actionBehavior	ON_ITSELF
		action	TAG
		actionBehavior	ON_NOBODY
		action	EDIT_SUMMARY
		actionBehavior	ON_NOBODY
		action	EDIT_LOCATION
		actionBehavior	ON_NOBODY
		action	EDIT_SOURCE
		actionBehavior	ON_NOBODY
		action	EDIT_HIDE_UNTIL
		actionBehavior	ON_ITSELF
		action	EDIT_FORCE_HIDE
		actionBehavior	ON_ITSELF
		action	EDIT_ADDITIONAL_DATA
		actionBehavior	ON_ITSELF
		action	ARCHIVE
		actionBehavior	ON_NOBODY
		action	JOURNAL
		actionBehavior	ON_ITSELF
	items	ActionGroupConfiguration
defaultGroupsFieldConfigurations	Define the default behavior of the field generation for a group. A group can change this when it is created or edited. Default value is [[{“generator”:{“type”:”MAXIMUM”,”fieldToExtract”:”severity”},”name”:”severity”},{“generator”:{“type”:”INITIAL”,”value”:0},”name”:”hideUntil”},{“generator”:{“type”:”INITIAL”,”value”:false},”name”:”forceHide”},{“generator”:{“type”:”INITIAL”,”value”:[]},”name”:”journal”},{“generator”:{“type”:”FROM_MAX_SEVERITY”,”fieldToExtract”:”summary”},”name”:”summary”},{“generator”:{“type”:”FROM_MAX_SEVERITY”,”fieldToExtract”:”source”},”name”:”source”},{“generator”:{“type”:”FROM_MAX_SEVERITY”,”fieldToExtract”:”location”},”name”:”location”},{“generator”:{“type”:”AND”,”fieldToExtract”:”acknowledged”},”name”:”acknowledged”},{“generator”:{“type”:”MERGE_ARRAY”,”fieldToExtract”:”tags”},”name”:”tags”},{“generator”:{“type”:”INITIAL”,”value”:{}},”name”:”additionalData”},{“generator”:{“type”:”FROM_LATEST”,”fieldToExtract”:”lastTimestamp”},”name”:”lastTimestamp”},{“generator”:{“type”:”FROM_OLDEST”,”fieldToExtract”:”firstTimestamp”},”name”:”firstTimestamp”},{“generator”:{“type”:”SUM”,”fieldToExtract”:”count”},”name”:”count”},{“generator”:{“type”:”MAXIMUM”,”fieldToExtract”:”highestSeverity”},”name”:”highestSeverity”},{“generator”:{“type”:”MINIMUM”,”fieldToExtract”:”lowestSeverity”},”name”:”lowestSeverity”}]]
	type	array
	default	generator	type	MAXIMUM
			fieldToExtract	severity
		name	severity
		generator	type	INITIAL
			value	0
		name	hideUntil
		generator	type	INITIAL
			value	False
		name	forceHide
		generator	type	INITIAL
			value
		name	journal
		generator	type	FROM_MAX_SEVERITY
			fieldToExtract	summary
		name	summary
		generator	type	FROM_MAX_SEVERITY
			fieldToExtract	source
		name	source
		generator	type	FROM_MAX_SEVERITY
			fieldToExtract	location
		name	location
		generator	type	AND
			fieldToExtract	acknowledged
		name	acknowledged
		generator	type	MERGE_ARRAY
			fieldToExtract	tags
		name	tags
		generator	type	INITIAL
			value
		name	additionalData
		generator	type	FROM_LATEST
			fieldToExtract	lastTimestamp
		name	lastTimestamp
		generator	type	FROM_OLDEST
			fieldToExtract	firstTimestamp
		name	firstTimestamp
		generator	type	SUM
			fieldToExtract	count
		name	count
		generator	type	MAXIMUM
			fieldToExtract	highestSeverity
		name	highestSeverity
		generator	type	MINIMUM
			fieldToExtract	lowestSeverity
		name	lowestSeverity
	items	FieldGroupConfiguration
executionConfigurationEntity	The execution parameter for the action
	ThreadExecutionConfigurationEntity
experimentalFeatures	These experimental features are not yet stable and may change at any time. If you are using them, we would appreciate any feedback. Once a feature is considered stable, it will either be moved to another configuration parameter or enabled permanently. Default value is [{“enableHotReload”:false}]
	default	enableHotReload	False
	ExperimentalFeatures
failure	The configuration of the collection ‘failure’ that retain the failed alarms insertion during the pre-insertion process. The content of the collection is not directly accessible but it can be useful to debug the pre-insertion process. See alarms documentation ↗️ for more information. Default value is [{“timeToLive”:{“unit”:”DAYS”,”value”:7}}]
	default	timeToLive	unit	DAYS
			value	7
	FailureConfiguration
historyIndexes	The indexes to build on the Mongo Database for the history collection Default value is [[{“index”:{“serial”:1},”name”:”serial”,”sparse”:false,”unique”:false},{“index”:{“numberOfOperations”:1},”name”:”numberOfOperations”,”sparse”:false,”unique”:false},{“index”:{“numberOfOccurrences”:1},”name”:”numberOfOccurrences”,”sparse”:false,”unique”:false},{“index”:{“creationTime”:1},”name”:”creationTime”,”sparse”:false,”unique”:false},{“index”:{“suppressionTime”:1},”name”:”suppressionTime”,”sparse”:true,”unique”:false},{“index”:{“operations”:1},”name”:”operations”,”sparse”:true,”unique”:false}]]
	type	array
	default	index	serial	1
		name	serial
		sparse	False
		unique	False
		index	numberOfOperations	1
		name	numberOfOperations
		sparse	False
		unique	False
		index	numberOfOccurrences	1
		name	numberOfOccurrences
		sparse	False
		unique	False
		index	creationTime	1
		name	creationTime
		sparse	False
		unique	False
		index	suppressionTime	1
		name	suppressionTime
		sparse	True
		unique	False
		index	operations	1
		name	operations
		sparse	True
		unique	False
	items	IndexConfigurationEntity
historyReconstructionInterval	Define the interval between to execution of the history reconstruction. If the interval is below 1 second, the reconstruction will be done immediately for every change. A reconstruction will only be done on alarm that have changed. Default value is [{“unit”:”SECONDS”,”value”:2}]
	default	unit	SECONDS
		value	2
	DurationConfigurationEntity
ignore	The configuration of the collection ‘ignore’ that retain the ignored alarms during the pre-insertion process. The content of the collection is not directly accessible but it can be useful to debug the pre-insertion process. See alarms documentation ↗️ for more information. Default value is [{“timeToLive”:{“unit”:”DAYS”,”value”:60}}]
	default	timeToLive	unit	DAYS
			value	60
	IgnoreConfiguration
insertionBehavior	Define the behavior of a new insertion for an existing alarms. For example should the tags be overridden by the on define of the new alarm. Default value is [{“overrideAcknowledgementOnNewAlarm”:true,”overrideAdditionalDataOnNewAlarm”:true,”overrideForceHideOnNewAlarm”:true,”overrideHideUntilOnNewAlarm”:true,”overrideLocationOnNewAlarm”:true,”overrideParentOnNewAlarm”:false,”overrideSeverityOnNewAlarm”:true,”overrideSourceOnNewAlarm”:true,”overrideSummaryOnNewAlarm”:true,”overrideTagsOnNewAlarm”:true}]
	default	overrideAcknowledgementOnNewAlarm	True
		overrideAdditionalDataOnNewAlarm	True
		overrideForceHideOnNewAlarm	True
		overrideHideUntilOnNewAlarm	True
		overrideLocationOnNewAlarm	True
		overrideParentOnNewAlarm	False
		overrideSeverityOnNewAlarm	True
		overrideSourceOnNewAlarm	True
		overrideSummaryOnNewAlarm	True
		overrideTagsOnNewAlarm	True
	InsertionBehaviorConfiguration
isTemplateGeneratedByOspComposer	Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.
	type	string
liveIndexes	The indexes to build on the Mongo Database for the live collection Default value is [[{“index”:{“serial”:1},”name”:”serial”,”sparse”:false,”unique”:false},{“index”:{“firstTimestamp”:1},”name”:”firstTimestamp”,”sparse”:false,”unique”:false},{“index”:{“lastTimestamp”:1},”name”:”lastTimestamp”,”sparse”:false,”unique”:false},{“index”:{“severity”:1},”name”:”severity”,”sparse”:false,”unique”:false},{“index”:{“summary”:1},”name”:”summary”,”sparse”:false,”unique”:false},{“index”:{“location”:1},”name”:”location”,”sparse”:false,”unique”:false},{“index”:{“source”:1},”name”:”source”,”sparse”:false,”unique”:false},{“index”:{“tags”:1},”name”:”tags”,”sparse”:false,”unique”:false},{“index”:{“additionalData”:1},”name”:”additionalData”,”sparse”:false,”unique”:false},{“index”:{“acknowledged”:1},”name”:”acknowledged”,”sparse”:false,”unique”:false},{“index”:{“hideUntil”:1},”name”:”hideUntil”,”sparse”:true,”unique”:false},{“index”:{“forceHide”:1},”name”:”forceHide”,”sparse”:true,”unique”:false},{“index”:{“journal”:1},”name”:”journal”,”sparse”:true,”unique”:false},{“index”:{“count”:1},”name”:”count”,”sparse”:true,”unique”:false},{“index”:{“origSeverity”:1},”name”:”origSeverity”,”sparse”:true,”unique”:false},{“index”:{“isSeverityLocked”:1},”name”:”isSeverityLocked”,”sparse”:true,”unique”:false}]]
	type	array
	default	index	serial	1
		name	serial
		sparse	False
		unique	False
		index	firstTimestamp	1
		name	firstTimestamp
		sparse	False
		unique	False
		index	lastTimestamp	1
		name	lastTimestamp
		sparse	False
		unique	False
		index	severity	1
		name	severity
		sparse	False
		unique	False
		index	summary	1
		name	summary
		sparse	False
		unique	False
		index	location	1
		name	location
		sparse	False
		unique	False
		index	source	1
		name	source
		sparse	False
		unique	False
		index	tags	1
		name	tags
		sparse	False
		unique	False
		index	additionalData	1
		name	additionalData
		sparse	False
		unique	False
		index	acknowledged	1
		name	acknowledged
		sparse	False
		unique	False
		index	hideUntil	1
		name	hideUntil
		sparse	True
		unique	False
		index	forceHide	1
		name	forceHide
		sparse	True
		unique	False
		index	journal	1
		name	journal
		sparse	True
		unique	False
		index	count	1
		name	count
		sparse	True
		unique	False
		index	origSeverity	1
		name	origSeverity
		sparse	True
		unique	False
		index	isSeverityLocked	1
		name	isSeverityLocked
sparse		True
unique		False
items	IndexConfigurationEntity
loggingConfiguration	The configuration of module’s logging Default value is [{“externalLogLevel”:”WARN”,”moduleLogLevel”:”INFO”}]
	default	externalLogLevel	WARN
		moduleLogLevel	INFO
	LoggingConfigurationEntity
messagingConfiguration	The configuration of the Rabbit MQ used for communication
	MessagingConfigurationEntity
mongoDbConfigurationEntity	The configuration of the Mongo Database
	MongoConfigurationEntity
startupValueErrorTimeout	The delay during which the error are not published when the module is starting or the value configuration has changed. When a value without an error is publish the delay will be remove immediately. The following errors will not be delayed. This also concern the uninitialized value. During this period, any republish request will generate an uninitialized value. This can be override on the value configuration. Default value is [{“unit”:”MINUTES”,”value”:1}]
	default	unit	MINUTES
		value	1
	DurationConfigurationEntity
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
valueErrorHandler	Define the behavior and enable the value error handler. The value error handle will observe all values and, when on in error is detected, generate an alarm.
	ValueErrorHandlerConfiguration
variablesFiles	The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.
	type	array
	items	type	string
additionalProperties	False

ArchiveConfiguration

type	object
properties
archiveFolder	The path where to create the exported archive. Default value is [“/osp/run/archive”]
	type	string
	default	/osp/run/archive
bucketAge	The age of a bucket before it is removed. Default value is [{“unit”:”DAYS”,”value”:730}]
	default	unit	DAYS
		value	730
	DurationConfigurationEntity
bucketSize	Each archive collection will store the alarm of the period define here. For example a value of 3 month will create 4 collection per year. Default value is [{“unit”:”DAYS”,”value”:90}]
	default	unit	DAYS
		value	90
	DurationConfigurationEntity
historyAge	The age of the history alarm before there are moved to the archive. Default value is [{“unit”:”DAYS”,”value”:90}]
	default	unit	DAYS
		value	90
	DurationConfigurationEntity
additionalProperties	False

DurationConfigurationEntity

type	object
properties
unit	The unit of time expressed
	type	string
	enum	NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS
value	The amount of time expressed with the unit
	type	integer
additionalProperties	False

ActionGroupConfiguration

Link an action and the actionBehavior wanted for the group where this is define.

type	object
properties
action	The action on which you want to define the behaviour for this group. The action must be unique per group configuration.
	type	string
	enum	ACKNOWLEDGE, LOCK_SEVERITY, TAG, EDIT_SUMMARY, EDIT_LOCATION, EDIT_SOURCE, EDIT_HIDE_UNTIL, EDIT_FORCE_HIDE, EDIT_ADDITIONAL_DATA, ESCALATE, JOURNAL, ARCHIVE
actionBehavior	Define how the action will behave when executed on the group. ON_NOBODY: No action will be executed on the group or its children. ON_CHILDREN: The action will be executed on the children of the group. ON_ITSELF: The action will be executed on the group. ON_BOTH: The action will be executed on the group and it’s children. When a action is executed on the children of the group, if a children is also a group, the action will be done as define on it’s configuration.
	type	string
	enum	ON_NOBODY, ON_CHILDREN, ON_ITSELF, ON_BOTH
additionalProperties	False

FieldGroupConfiguration

type	object
properties
generator	The generator to use to create the content of this field on the group.
	oneOf	INITIAL
		MAXIMUM
		MINIMUM
		SUM
		AND
		OR
		FROM_MAX_SEVERITY
		FROM_MIN_SEVERITY
		FROM_LATEST
		FROM_OLDEST
		CONCATENATE
		MERGE_ARRAY
		MERGE_OBJECT
name	The name of the field to generate. The name must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

INITIAL

type	object
properties
type	type	string
	enum	INITIAL
	default	INITIAL
value	The value to set initially on the group.
additionalProperties	False

MAXIMUM

type	object
properties
type	type	string
	enum	MAXIMUM
	default	MAXIMUM
fieldToExtract	The name of the children field to extract from the children where this field is the greater. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

MINIMUM

type	object
properties
type	type	string
	enum	MINIMUM
	default	MINIMUM
fieldToExtract	The name of the children field to extract from the children where this field is the smaller. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

SUM

type	object
properties
type	type	string
	enum	SUM
	default	SUM
fieldToExtract	The name of the children field on which the SUM will be apply. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

AND

type	object
properties
type	type	string
	enum	AND
	default	AND
fieldToExtract	The name of the children field on which the AND logic will be apply. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

OR

type	object
properties
type	type	string
	enum	OR
	default	OR
fieldToExtract	The name of the children field on which the OR will be apply. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

FROM_MAX_SEVERITY

type	object
properties
type	type	string
	enum	FROM_MAX_SEVERITY
	default	FROM_MAX_SEVERITY
fieldToExtract	The name of the children field to extract from the alarm with the highest severity of the group. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

FROM_MIN_SEVERITY

type	object
properties
type	type	string
	enum	FROM_MIN_SEVERITY
	default	FROM_MIN_SEVERITY
fieldToExtract	The name of the children field to extract from the alarm with the lowest severity of the group. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

FROM_LATEST

type	object
properties
type	type	string
	enum	FROM_LATEST
	default	FROM_LATEST
fieldToExtract	The name of the children field to extract from the most recent alarm of the group. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

FROM_OLDEST

type	object
properties
type	type	string
	enum	FROM_OLDEST
	default	FROM_OLDEST
fieldToExtract	The name of the children field to extract from the oldest alarm of the group. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

CONCATENATE

type	object
properties
type	type	string
	enum	CONCATENATE
	default	CONCATENATE
fieldToExtract	The name of the children field on which the CONCATENATE logic will be apply. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
prefix	An optional prefix to start the generated string. For example, the prefix “Test: “ will give the following result on the group “Test: Summary 1, Summary 2, Summary 3”
	type	string
additionalProperties	False

MERGE_ARRAY

type	object
properties
type	type	string
	enum	MERGE_ARRAY
	default	MERGE_ARRAY
fieldToExtract	The name of the children field to merge together. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

MERGE_OBJECT

type	object
properties
type	type	string
	enum	MERGE_OBJECT
	default	MERGE_OBJECT
fieldToExtract	The name of the children field to merge together. The fieldToExtract must not start with ‘$’ or contain ‘.’.
	type	string
	pattern	^[^$][^.]{1,256}$
additionalProperties	False

ThreadExecutionConfigurationEntity

type	object
properties
executionThreads	The number of thread available for script execution. Each script use one thread during his execution, this value is a tradeoff between memory usage and number of concurrent execution.
	type	integer
additionalProperties	False

ExperimentalFeatures

type	object
properties
enableHotReload	Flag to enable/disable the hot-reload on the module. The modules capabilities ↗️ describe which module support it. Default value is [false]
	type	boolean
	default	False
additionalProperties	False

FailureConfiguration

type	object
properties
timeToLive	The maximum age of the failed alarm before there are removed. Default value is [{“unit”:”DAYS”,”value”:7}]
	default	unit	DAYS
		value	7
	AboveSecondDurationConfigurationEntity
additionalProperties	False

AboveSecondDurationConfigurationEntity

type	object
properties
unit	The unit of time expressed with the value
	type	string
	enum	SECONDS, MINUTES, HOURS, DAYS
value	The amount of time expressed with the unit
	type	integer
additionalProperties	False

IndexConfigurationEntity

type	object
properties
index	The Mongo expression used for indexing. “ + See MongoDB indexes properties documentation ↗️. See MongoDB indexes documentation ↗️.
name	The name of the index
	type	string
partialFilterExpression	Partial filter expression used to filter the elements that are affected by this index
sparse	Create the indexes only the document when the field exist Default value is [false]
	type	boolean
	default	False
unique	Set the index as unique. This will prevent the insertion of new document if the index is not unique. See MongoDB unique indexes ↗️ for more information. Default value is [false]
	type	boolean
	default	False
additionalProperties	False

IgnoreConfiguration

type	object
properties
timeToLive	The maximum age of the ignored alarm before there are removed. Default value is [{“unit”:”DAYS”,”value”:60}]
	default	unit	DAYS
		value	60
	AboveSecondDurationConfigurationEntity
additionalProperties	False

InsertionBehaviorConfiguration

type	object
properties
overrideAcknowledgementOnNewAlarm	If true, the insertion of a new alarm will completely override the acknowledged with the one of the newly inserted alarm. If false, the insertion of a new alarm will only create the acknowledged if the alarm didn’t exist previously. Default value is [true]
	type	boolean
	default	True
overrideAdditionalDataOnNewAlarm	If true, the insertion of a new alarm will completely override the additional data with the one of the newly inserted alarm. If false, the insertion of a new alarm will only create the additional data if the alarm didn’t exist previously. Default value is [true]
	type	boolean
	default	True
overrideForceHideOnNewAlarm	If true, the insertion of a new alarm will completely override the forceHide with the one of the newly inserted alarm. If false, the insertion of a new alarm will only create the forceHide if the alarm didn’t exist previously. Default value is [true]
	type	boolean
	default	True
overrideHideUntilOnNewAlarm	If true, the insertion of a new alarm will completely override the hideUntil with the one of the newly inserted alarm. If false, the insertion of a new alarm will only create the hideUntil if the alarm didn’t exist previously. Default value is [true]
	type	boolean
	default	True
overrideLocationOnNewAlarm	If true, the insertion of a new alarm will completely override the location with the one of the newly inserted alarm. If false, the insertion of a new alarm will only create the location if the alarm didn’t exist previously. Default value is [true]
	type	boolean
	default	True
overrideParentOnNewAlarm	If true, the insertion of a new alarm will completely override the parent with the one of the newly inserted alarm. If false, the insertion of a new alarm will only create the parent if the alarm didn’t exist previously. Default value is [false]
	type	boolean
	default	False
overrideSeverityOnNewAlarm	If true, the insertion of a new alarm will completely override the severity with the one of the newly inserted alarm. If false, the insertion of a new alarm will only create the severity if the alarm didn’t exist previously. Default value is [true]
	type	boolean
	default	True
overrideSourceOnNewAlarm	If true, the insertion of a new alarm will completely override the source with the one of the newly inserted alarm. If false, the insertion of a new alarm will only create the source if the alarm didn’t exist previously. Default value is [true]
	type	boolean
	default	True
overrideSummaryOnNewAlarm	If true, the insertion of a new alarm will completely override the summary with the one of the newly inserted alarm. If false, the insertion of a new alarm will only create the summary if the alarm didn’t exist previously. Default value is [true]
	type	boolean
	default	True
overrideTagsOnNewAlarm	If true, the insertion of a new alarm will completely override the tags with the one of the newly inserted alarm. If false, the insertion of a new alarm will only create the tags if the alarm didn’t exist previously. Default value is [true]
	type	boolean
	default	True
additionalProperties	False

LoggingConfigurationEntity

type	object
properties
externalLogLevel	The log level for external libraries logging Default value is [“WARN”]
	type	string
	enum	TRACE, DEBUG, INFO, WARN, ERROR, DISABLE
	default	WARN
moduleLogLevel	The log level for module’s behavior logging Default value is [“INFO”]
	type	string
	enum	TRACE, DEBUG, INFO, WARN, ERROR, DISABLE
	default	INFO
scriptLogLevel	The log level for module’s internal script behavior logging (if not set the moduleLogLevel will be used)
	type	string
	enum	TRACE, DEBUG, INFO, WARN, ERROR, DISABLE
additionalProperties	False

MessagingConfigurationEntity

type	object
properties
bufferSize	The size of the buffer to use when the broker is disconnected (default: 60000). Default value is [60000]
	type	integer
	minimum	1
	default	60000
clientId	The ID of the client, must be different for each module instance.
	type	string
host	The host of the rabbit MQ provider
	type	string
storeMessagesOnDisk	Flag to indicate to store the message (The path /osp/messages must be mount to a volume). Default value is [false]
	type	boolean
	default	False
additionalProperties	False

MongoConfigurationEntity

type	object
properties
credential	The credential to connect with the database. See MongoDB user management ↗️ for more information.
	CredentialConfigurationEntity
databaseName	The name of the database to use. The previous default value was alarms.
	type	string
serverUrl	The hostname of the mongodb configuration. (For example: mongodb://<host-1>,…,<host-x>/?replicaSet=<replSet-id>) Depending of your workload, some options can be useful to edit: maxPoolSize: To increase the number of connection available (default: 100) readPreference: To decrease the load on the primary node (default: primary) See MongoDB documentation ↗️ for more information.
	type	string
additionalProperties	False

CredentialConfigurationEntity

type	object
properties
authenticationDatabase	The database where the user is defined. By default, this will be the same database as the one used for the data.
	type	string
password	The password corresponding to the user.
	oneOf	PLAINTEXT
		SECRET
username	The username as configured on MongoDB
	type	string
additionalProperties	False

PLAINTEXT

type	object
properties
type	type	string
	enum	PLAINTEXT
	default	PLAINTEXT
password	type	string
additionalProperties	False

SECRET

type	object
properties
type	type	string
	enum	SECRET
	default	SECRET
secretPath	type	string
additionalProperties	False

ValueErrorHandlerConfiguration

type	object
properties
alarmGenerator	The configuration of the alarm to generate when a value on error is received.
	AlarmGenerationConfiguration
ignoreUninitializedValues	Flag to ignore the uninitialized value from the generation. Default value is [false]
	type	boolean
	default	False
resolutionConfiguration	The configuration to define the behavior when the value is not in error anymore. NOOP (default): No operation done ACK: Acknowledge the corresponding alarm ESCALATE: Escalate the corresponding alarm to the defined severity DELETE: Remove the corresponding alarm Default value is [{“type”:”NOOP”}]
	default	type	NOOP
	oneOf	NOOP
		ACK
		ESCALATE
		DELETE
additionalProperties	False

AlarmGenerationConfiguration

type	object
properties
acknowledgement	The default acknowledgement to set on the alarms during the generation.
	type	boolean
additionalData	Addition properties of the alarm Default value is [{}]
	type	object
	default
	additionalProperties
forceHide	The default forceHide to set on the alarms during the generation.
	type	boolean
hideUntil	The default hideUntil to set on the alarms during the generation.
	type	integer
initialJournal	The default journal to set on the alarms during the generation.
	type	array
	items	type	string
location	The location of the alarm
	oneOf	CONSTANT
		LIST
		PROPERTIES
		FIELD
parent	The parent to set on the alarms during the generation.
	type	string
serial	The serial of the alarm. This is the unique identifier of an alarms.
	oneOf	CONSTANT
		LIST
		PROPERTIES
		FIELD
severity	The severity of the alarm
source	The source of the alarm
	oneOf	CONSTANT
		LIST
		PROPERTIES
		FIELD
summary	The summary of the alarm
	oneOf	CONSTANT
		LIST
		PROPERTIES
		FIELD
tags	The list of tags of the alarm Default value is [[]]
	type	array
	default
	items	type	string
timestamp	The timestamp of the alarm
	oneOf	CONSTANT
		LIST
		PROPERTIES
		FIELD
additionalProperties	False

CONSTANT

type	object
properties
type	type	string
	enum	CONSTANT
	default	CONSTANT
value	A constant value
additionalProperties	False

LIST

type	object
properties
type	type	string
	enum	LIST
	default	LIST
values	A list of value accessors
	type	array
	items	oneOf	CONSTANT
			LIST
			PROPERTIES
			FIELD
additionalProperties	False

PROPERTIES

type	object
properties
type	type	string
	enum	PROPERTIES
	default	PROPERTIES
properties	An object of value accessors
	type	object
	additionalProperties	oneOf	CONSTANT
			LIST
			PROPERTIES
			FIELD
additionalProperties	False

FIELD

type	object
properties
type	type	string
	enum	FIELD
	default	FIELD
field	A field of the value
	type	string
	enum	ID, CONTENT, ERROR, TYPE, TIMESTAMP, NAME, DESCRIPTION
fieldParser	An expression to access a field of the JSON content of the value
	type	string
additionalProperties	False

NOOP

type	object
properties
type	type	string
	enum	NOOP
	default	NOOP
additionalProperties	False

ACK

type	object
properties
type	type	string
	enum	ACK
	default	ACK
additionalProperties	False

ESCALATE

type	object
properties
type	type	string
	enum	ESCALATE
	default	ESCALATE
severity	The id of the severity to use on the resolution
	type	string
additionalProperties	False

DELETE

type	object
properties
type	type	string
	enum	DELETE
	default	DELETE
additionalProperties	False