osp-collections

Supervision Prometheus

Warning

Prometheus supervision feature is in beta version, we are very glad to receive feedback at info@swissdotnet.ch. This feature behavior can change without notice in future versions.

The module provides a prometheus export on the 9100 TCP port.

Each metrics is an histogram with the following buckets (a bucket of 0.05s will contain the number of computation that take up to 0.05s to execute):

• 0.001 seconds

• 0.05 seconds

• 0.1 seconds

• 0.25 seconds

• 0.5 seconds

• 0.75 seconds

• 1.0 seconds

• 5.0 seconds

• 10.0 seconds

• 20.0 seconds

• 60.0 seconds

• 300.0 seconds

• inf

The module provides the following metrics:

Write operations

• collection_write_request_execution_seconds: metrics for write operations on a collection. Comes with the following labels:

  • requestType: type of request. One of insert, updateDiff, updateDoc or delete

  • schemaId: ItemId of the concern collection schema

Read operations

• collection_read_request_execution_seconds: metrics for read operations on a collection. Comes with the following labels:

  • requestType: type of request. One of getRecordWithFilter, getRecordWithCustomFilter, listRecords or listRecordsCustomFilter

  • schemaId: ItemId of the concern collection schema

  • filter: Filter used for the query

Collections history

• collection_history_request_execution_seconds: metrics for read operations on a collection history. Comes with the following labels:

  • requestType: type of request. One of getHistoryVersions or historyGoBackUntil

  • schemaId: ItemId of the concern collection schema

• collection_history_adapter_execution_seconds: metrics for history adapter process (enable/disable history for a collection).

Rights generation

• collection_rights_generation_execution_seconds: metrics for collections rights generation.

List of configuration files

Filename	Short description	Format	Link to documentation
module.service	Each service is described in its onw file and then assembled	yaml	See the Swarm administration or Official documentation
module.collections	Defines the module configuration	json	module.collections
schema.collections	Defines the schema describing the element of the collection	json	schema.collections
schema.ospp	Defines the property of the schema	json	schema.ospp
schema.web	Defines the module configuration	json	schema.web
form.web	Defines the module configuration	json	form.web