module.alarms

Alarms module

type	object
properties
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
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
isTemplateGeneratedByOspComposer	If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.
	type	boolean
messagingConfiguration	The configuration of the Rabbit MQ used for communication
	MessagingConfigurationEntity
loggingConfiguration	The configuration of module’s logging
	default	moduleLogLevel	INFO
		externalLogLevel	WARN
	LoggingConfigurationEntity
executionConfigurationEntity	The execution parameter for the action
	ThreadExecutionConfigurationEntity
mongoDbConfigurationEntity	The configuration of the Mongo Database
	MongoConfigurationEntity
liveIndexes	The indexes to build on the Mongo Database for the live collection
	type	array
	default	name	subId
		index	_id._id	1
		sparse	False
		name	subSerial
		index	_id.serial	1
		sparse	False
		name	acknowledged
		index	acknowledged	1
		sparse	False
		name	location
		index	location	1
		sparse	False
		name	lockedSeverity
		index	lockedSeverity	1
		sparse	True
		name	isSeverityLocked
		index	isSeverityLocked	1
		sparse	True
		name	serial
		index	serial	1
		sparse	False
		name	severity
		index	severity	1
		sparse	False
		name	source
		index	source	1
		sparse	False
		name	tags
		index	tags	1
		sparse	False
		name	timestamp
		index	timestamp	1
		sparse	False
	items	IndexConfigurationEntity
deduplicatedIndexes	The indexes to build on the Mongo Database for the deduplicated collection
	type	array
	default	name	acknowledged
		index	acknowledged	1
		sparse	False
		name	count
		index	count	1
		sparse	False
		name	firstTimestamp
		index	firstTimestamp	1
		sparse	False
		name	isSeverityLocked
		index	isSeverityLocked	1
		sparse	False
		name	lastTimestamp
		index	lastTimestamp	1
		sparse	False
		name	location
		index	location	1
		sparse	False
		name	origSeverity
		index	origSeverity	1
		sparse	False
		name	severity
		index	severity	1
		sparse	False
		name	source
		index	source	1
		sparse	False
		name	tags
		index	tags	1
		sparse	False
		name	hideUntil
		index	hideUntil	1
		sparse	False
		name	forceHide
		index	forceHide	1
		sparse	False
	items	IndexConfigurationEntity
historyIndexes	The indexes to build on the Mongo Database for the history collection
	type	array
	default	name	subId
		index	_id._id	1
		sparse	False
		name	subSerial
		index	_id.serial	1
		sparse	False
		name	acknowledged
		index	acknowledged	1
		sparse	False
		name	location
		index	location	1
		sparse	False
		name	lockedSeverity
		index	lockedSeverity	1
		sparse	True
		name	isSeverityLocked
		index	isSeverityLocked	1
		sparse	True
		name	serial
		index	serial	1
		sparse	False
		name	severity
		index	severity	1
		sparse	False
		name	source
		index	source	1
		sparse	False
		name	tags
		index	tags	1
		sparse	False
		name	timestamp
		index	timestamp	1
		sparse	False
	items	IndexConfigurationEntity
deduplication	The configuration of the deduplication
	default	deduplicationFields	fieldName	summary
			groupingPolicy	accumulatorType	LAST
				expression	$summary
			fieldName	source
			groupingPolicy	accumulatorType	LAST
				expression	$source
			fieldName	location
			groupingPolicy	accumulatorType	LAST
				expression	$location
			fieldName	firstTimestamp
			groupingPolicy	accumulatorType	FIRST
				expression	$timestamp
			fieldName	lastTimestamp
			groupingPolicy	accumulatorType	LAST
				expression	$timestamp
			fieldName	additionalData
			groupingPolicy	accumulatorType	LAST
				expression	$additionalData
		maximumConcurrent	25
		maximumSerial	10
		retryDelay	value	5
			unit	SECONDS
	DeduplicationConfiguration
archive	The archive configuration
	default	historyAge	value	90
			unit	DAYS
		bucketSize	value	90
			unit	DAYS
		bucketAge	value	730
			unit	DAYS
		archiveFolder	/osp/run/archive
	ArchiveConfiguration
failure	The failure configuration
	default	timeToLive	value	7
			unit	DAYS
	FailureConfiguration
useJVMTrustStore	Allow the module to use the JVM truststore
	type	boolean
	default	False
additionalProperties	False

MessagingConfigurationEntity

type	object
properties
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
bufferSize	The size of the buffer to use when the broker is disconnected (default: 60000).
	type	integer
	minimum	1
	default	60000
storeMessagesOnDisk	Flag to indicate to store the message (The path /osp/messages must be mount to a volume).
	type	boolean
	default	False
additionalProperties	False

LoggingConfigurationEntity

type	object
properties
moduleLogLevel	The log level for module’s behavior logging
	type	string
	enum	TRACE, DEBUG, INFO, WARN, ERROR
	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
externalLogLevel	The log level for external libraries logging
	type	string
	enum	TRACE, DEBUG, INFO, WARN, ERROR
	default	WARN
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

MongoConfigurationEntity

type	object
properties
serverUrl	The hostname of the mongodb configuration. (For example: mongodb://<host-1>,…,<host-x>/?replicaSet=<replSet-id>)
	type	string
databaseName	The name of the database to use
	type	string
	default	alarms
additionalProperties	False

IndexConfigurationEntity

type	object
properties
name	The name of the index
	type	string
index	The Mongo expression used for indexing. See https://docs.mongodb.com/manual/indexes/ for more information.
sparse	Create the indexes only the document when the field exist
	type	boolean
	default	False
partialFilterExpression	Partial filter expression used to filter the elements that are affected by this index
additionalProperties	False

DeduplicationConfiguration

type	object
properties
deduplicationFields	The fields to generate on the deduplicated alarms. Be aware that apart from the default field only the one created on the additionalData will be available on the script.
	type	array
	default	fieldName	summary
		groupingPolicy	accumulatorType	LAST
			expression	$summary
		fieldName	source
		groupingPolicy	accumulatorType	LAST
			expression	$source
		fieldName	location
		groupingPolicy	accumulatorType	LAST
			expression	$location
		fieldName	firstTimestamp
		groupingPolicy	accumulatorType	FIRST
			expression	$timestamp
		fieldName	lastTimestamp
		groupingPolicy	accumulatorType	LAST
			expression	$timestamp
		fieldName	additionalData
		groupingPolicy	accumulatorType	LAST
			expression	$additionalData
	items	DeduplicationField
maximumConcurrent	The maximum number of deduplication running concurrently
	type	integer
	default	25
maximumSerial	The maximum number of serial deduplicated at the same time (aka per run)
	type	integer
	default	10
retryDelay	The delay between retry after a deduplication failure
	default	value	5
		unit	SECONDS
	DurationConfigurationEntity
additionalProperties	False

DeduplicationField

type	object
properties
fieldName	The name of the field
	type	string
groupingPolicy	The policy to generate the field with the mongo accumulators (See https://docs.mongodb.com/manual/reference/operator/aggregation/group/#std-label-accumulators-group)
	GroupingPolicy
processingPolicy	The processing to apply to the field to extract a value (See https://docs.mongodb.com/manual/reference/operator/aggregation/)
additionalProperties	False

GroupingPolicy

type	object
properties
accumulatorType	The accumulator to use
	type	string
	enum	SUM, AVG, FIRST, LAST, MAX, MIN, PUSH, ADD_TO_SET, STD_DEV_POP, STD_DEV_SAMP, MERGE_OBJECTS
expression	The expression for the accumulator
additionalProperties	False

DurationConfigurationEntity

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

ArchiveConfiguration

type	object
properties
historyAge	The age of the history alarm before there are moved to the archive.
	default	value	90
		unit	DAYS
	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	90
		unit	DAYS
	DurationConfigurationEntity
bucketAge	The age of a bucket before it is removed.
	default	value	730
		unit	DAYS
	DurationConfigurationEntity
archiveFolder	The path where to create the exported archive.
	type	string
	default	/osp/run/archive
additionalProperties	False

FailureConfiguration

type	object
properties
timeToLive	The maximum age of the failed alarm before there are removed.
	default	value	7
		unit	DAYS
	AboveSecondDurationConfigurationEntity
additionalProperties	False

AboveSecondDurationConfigurationEntity

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