Audit Entities

From version 3.1.0, Ontologies are now called Entities in the Control Panel. This does not alter any functionality. We have simply changed the nomenclature for a better understanding of the concept.

1 Introduction
2 MetricsOntology:
- 2.1 Description:
3 MetricsControlPanel:
- 3.1 Description:
4 MetricsOperation:
- 4.1 Description:
5 MetricsQueriesControlPanel:
- 5.1 Description:
6 MetricsApi:
- 6.1 Description

Introduction

The operations audit of the platform is stored in ontologies of type TimeSeries, which record the number of operations performed per different units of time:

MetricsOntology:

Internal ontology of the platform, it is used in auditing tasks, recording the number of operations performed on each ontology, and categorizing the operations by.

Type of Operation: Insert, Update, Select, Delete.
Result of the operation: OK, KO.
User requesting the operation.
Platform module that performs the operation: CONTROLPANEL, APIMANAGER, IOTBROKER, FLOWENGINE, ROUTER, RTDBMAINTAINER, SQLENGINE.

It is an ontology of type TimeSeries, which stores the number of operations performed, taking into account different time windows:

Hourly Window with 1 sample per minute: Each record stores the number of operations performed during one hour, monitoring the total number of operations minute by minute.
Daily Window with 1 sample per hour: Each record stores the number of operations performed during a day, monitoring the total operations hour by hour.

Description:

Attribute	Type	Calculated	Length	Description	Null	Key
_id	Text	Yes	24	Unique identifier of each record.	No	Yes
TimeSerie.values.v.<min\|hour>	Integer	No	32	Number of operations of the type indicated by TimeSerie.operationType performed in the minute/hour <min\|hour>.	No	No
TimeSerie.operationType	Enumerated	No	50	Type of monitored operation that is audited.	No	No

TimeSerie.ontology	Text	No	50	Ontology on which audit metric is applied.	No	No
TimeSerie.result	Enumerated	No	2	Result of operation, OK or KO.	No	No
TimeSerie.user	Text	No	50	User who performed the audited operations.	No	No
TimeSerie.source	Enumerated	No	50	Module of the platform that executed the audited operation.	No	No
TimeSerie.timestamp	Date	Yes		Timestamp of the measurement window to which each record belongs.	No	No
TimeSerie.propertyName	Text	No	50	Name of the audited property in each record.	No	No
TimeSerie.windowType	Enumerated	No	50	Type of time window audited in each record (Hourly, Daily).	No	No
TimeSerie.windowFrecuency	Integer	No	32	Frequency of samples audited in each record.	No	No
TimeSerie.windowFrecuencyUnit	Enumerated	No	50	Unit of the frequency of the audited samples in each record. Used in conjunction with TimeSerie.windowFrecuency (e.g.: one sample per minute).	No	No

MetricsControlPanel:

Internal ontology of the Platform, it is used in auditing tasks, recording the number of operations performed on the control panel, categorizing operations by:

Type of Operation: Login, Creation of: User, Ontology, Api, Dashboard, Client, Notebook, Dataflow, Project, Flow, GIS Viewer, Sentence execution from Query Tool.
Result of the operation: OK, KO.
User performing the operation.

This is a TimeSeries type ontology, which stores the number of operations performed taking into account different time windows:

Hourly Window with 1 sample per minute: each record stores the number of operations performed during one hour, monitoring the total number of operations minute by minute.
Daily Window with 1 sample per hour: Each record stores the number of operations performed during a day, monitoring the total operations hour by hour.
Monthly Window with 1 sample per day: each record stores the number of operations performed during a month, monitoring the total operations day by day.

Description:

Attribute	Type	Calculated	Length	Description	Null	Key
_id	Text	Yes	24	Unique identifier of each record.	No	Yes
TimeSerie.values.v.<min\|hour\|day>	Integer	No	32	Number of operations of the type indicated by TimeSerie.operationType performed in the minute/hour/day <min\|hour\|day>	No	No
TimeSerie.operationType	Enumerated	No	50	Type of monitored operation audited.	No	No

TimeSerie.result	Enumerated	No	2	Result of operation, OK or KO.	No	No
TimeSerie.user	Text	No	50	User who performed the audited operations.	No	No
TimeSerie.timestamp	Date	Yes		Timestamp of the measurement window to which each record belongs.	No	No
TimeSerie.propertyName	Text	No	50	Name of the property audited in each record.	No	No
TimeSerie.windowType	Enumerated	No	50	Type of time window audited in each record (Hourly, Daily, Monthly).	No	No
TimeSerie.windowFrecuency	Integer	No	32	Frequency of samples audited in each record.	No	No
TimeSerie.windowFrecuencyUnit	Enumerated	No	50	Unit of the frequency of the audited samples in each record. Used in conjunction with TimeSerie.windowFrecuency (e.g.: one sample per minute).	No	No

MetricsOperation:

Internal ontology of the Platform, it is used in audit tasks, recording the number of operations performed in the different modules of the platform, categorizing the operations by:

Operation Type: LOGIN, LOGIN_OAUTH, LOGOUT, JOIN, LEAVE, INSERT, UPDATE, DELETE, QUERY, SUBSCRIBE, UNSUBSCRIBE, INDICATION, COMMAND, START, STOP, LOG, START_TRANSACTION, COMMIT_TRANSACTION, ROLLBACK_TRANSACTION, EXECUTION, OAUTH_TOKEN_GENERATION, OAUTH_TOKEN_CHECK, OAUTH_TOKEN_REFRESH, OAUTH_TOKEN_REVOCATION, OAUTH_TOKEN_OIDC.
Result of the operation: OK, KO.
User performing the operation.
Platform module performing the operation: CONTROLPANEL, APIMANAGER, IOTBROKER, FLOWENGINE, ROUTER, RTDBMAINTAINER, SQLENGINE, PLANNER, OAUTHSERVER.

This is a TimeSeries type ontology, which stores the number of operations performed taking into account different time windows:

Hourly Window with 1 sample per minute: each record stores the number of operations performed during one hour, monitoring the total number of operations minute by minute.
Daily Window with 1 sample per hour: each record stores the number of operations performed during a day, monitoring the total operations hour by hour.

Description:

Attribute	Type	Calculated	Length	Description	Null	Key
_id	Text	Yes	24	Unique identifier of each record.	No	Yes
TimeSerie.values.v.<min\|hour>	Integer	No	32	Number of operations of the type indicated by TimeSerie.operationType performed in the minute/hour <min\|hour>	No	No
TimeSerie.operationType	Enumerated	No	50	Type of monitored operation audited.	No	No

TimeSerie.result	Enumerated	No	2	Result of operation, OK or KO.	No	No
TimeSerie.user	Text	No	50	User who performed the audited operations.	No	No
TimeSerie.source	Enumerated	No	50	Module of the platform that executed the audited operation.	No	No
TimeSerie.timestamp	Date	Yes		Timestamp of the measurement window to which each record belongs.	No	No
TimeSerie.propertyName	Text	No	50	Name of the audited property in each record.	No	No
TimeSerie.windowType	Enumerated	No	50	Type of time window audited in each record (Hourly, Daily).	No	No
TimeSerie.windowFrecuency	Integer	No	32	Frequency of samples audited in each record.	No	No
TimeSerie.windowFrecuencyUnit	Enumerated	No	50	Unit of the frequency of the audited samples in each record. Used in conjunction with TimeSerie.windowFrecuency (e.g.: one sample per minute).	No	No

MetricsQueriesControlPanel:

Internal ontology of the platform, it is used in auditing tasks, recording the number of operations performed on the Query Tool of the control panel, categorizing the operations by:

Ontology.
Result of the operation: OK, KO.
User performing the operation.

This is a TimeSeries type ontology, which stores the number of operations performed taking into account different time windows:

Hourly Window with 1 sample per minute: each record stores the number of operations performed during one hour, monitoring the total number of operations minute by minute.
Daily Window with 1 sample per hour: each record stores the number of operations performed during a day, monitoring the total operations hour by hour.

Description:

Attribute	Type	Calculated	Length	Description	Null	Key
_id	Text	Yes	24	Unique identifier of each record.	No	Yes
TimeSerie.values.v.<min\|hour>	Integer	No	32	Number of operations of the type indicated by TimeSerie.operationType performed in the minute/hour <min\|hour>	No	No
TimeSerie.ontology	Text	No	50	Ontology on which audit metric is applied.	No	No
TimeSerie.result	Enumerated	No	2	Result of operation, OK or KO.	No	No
TimeSerie.user	Text	No	50	User who performed the audited operations.	No	No
TimeSerie.timestamp	Date	Yes		Timestamp of the measurement window to which each record belongs.	No	No
TimeSerie.propertyName	Text	No	50	Name of the audited property in each record.	No	No
TimeSerie.windowType	Enumerated	No	50	Type of time window audited in each record (Hourly, Daily).	No	No
TimeSerie.windowFrecuency	Integer	No	32	Frequency of samples audited in each record.	No	No
TimeSerie.windowFrecuencyUnit	Enumerated	No	50	Unit of the frequency of the audited samples in each record. Used in conjunction with TimeSerie.windowFrecuency (e.g.: one sample per minute).	No	No

MetricsApi:

Internal ontology of the platform, it is used in auditing tasks, recording the number of operations performed on the Api Manager, categorizing the operations by:

Type of Operation: GET, POST, PUT, DELETE.
Result of the operation: HTTP Code (200, 401, 500...).
User requesting the operation.
Usuario que solicita la operación.
API of the platform.

It is an ontology of type TimeSeries, which stores the number of operations performed taking into account different time windows:

Hourly Window with 1 sample per minute: each record stores the number of operations performed during one hour, monitoring the total number of operations minute by minute.
Daily Window with 1 sample per hour: Each record stores the number of operations performed during a day, monitoring the total operations hour by hour.
Monthly Window with 1 sample per day: Each record stores the number of operations performed during a month, monitoring the total operations day by day.

Description

Attribute	Type	Calculated	Length	Description	Null	Key
_id	Text	Yes	24	Unique identifier of each record.	No	Yes
TimeSerie.values.v.<min\|hour\|day>	Integer	No	32	Number of operations of the type indicated by TimeSerie.operationType performed in the minute/hour/day <min\|hour\|day>	No	No
TimeSerie.operationType	Enumerated	No	50	Type of monitored operation audited.	No	No

TimeSerie.api	Text	No	50	Ontology on which the audit metric is applied.	No	No
TimeSerie.result	Enumerated	No	2	Result of operation, OK or KO.	No	No
TimeSerie.user	Text	No	50	User who performed the audited operations.	No	No
TimeSerie.timestamp	Date	Yes		Timestamp of the measurement window to which each record belongs.	No	No
TimeSerie.propertyName	Text	No	50	Name of the audited property in each record.	No	No
TimeSerie.windowType	Enumerated	No	50	Type of time window audited in each record (Hourly, Daily).	No	No
TimeSerie.windowFrecuency	Integer	No	32	Frequency of samples audited in each record.	No	No
TimeSerie.windowFrecuencyUnit	Enumerated	No	50	Unit of the frequency of the audited samples in each record. Used in conjunction with TimeSerie.windowFrecuency (e.g.: one sample per minute).	No	No