module.reports

Reports module

type	object
properties
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
indexes	The indexes to build on the Mongo Database for the live collection
	type	array
	items	IndexConfigurationEntity
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
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
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

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

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

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

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