Systems.Monitoring.InstanceStatistics Entity

Namespace: Systems.Monitoring

Logs time-windowed performance metrics for the monitored system instance across specified intervals. Entity: Sys_Instance_Statistics (Introduced in version 25.1.3.11)

Default Visualization

Default Display Text Format:
{ApplicationName}
Default Search Members:
ApplicationName
Name Data Member:
ApplicationName
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Systems.Monitoring.InstanceStatistics

Attributes

Name	Type	Description
ApplicationName	string (128) nullable	The application (if applicable) for which we are recording stats. `Filter(eq;like)`
Avg	int32 nullable	The avg value of the stat for the time period. `Filter(ge;le)`
Count	int32	Number of occurrences. `Required` `Filter(ge;le)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
ExcludeFromSummary	boolean	Denotes that the stat should be excluded from summarization queries (for example long polling requests). `Required`
Id	guid
InstanceName	string (128)	The name of the instance to which this statistic applies. `Required` `Filter(eq;like)`
Max	int32 nullable	The max value of the stat within the time period. `Filter(ge;le)`
ObjectName	string (256) nullable	Name of the object or operation (depending on the statistic type).
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
StatisticDate	date	The date (in UTC time) for which we are storing the statistics. `Required` `Filter(eq;ge;le)` `ORD`
StatisticFromTimeUtc	time	The starting of the time period within the date. `Required` `Filter(ge;le)`
StatisticToTimeUtc	time	The ending of the time period within the date. `Required` `Filter(ge;le)`
StatisticType	StatisticType	The type of the statistic: 'EXE' = Exec, 'WAI' = Wait, 'TAB' = Table, 'PER' = Performance, 'SIT' = Site. `Required` `Filter(multi eq)` `ORD`
SubType	string (64)	Kind of stat (depending on the type). `Required` `Filter(eq)`
Total	int32	The total of the stat for the time period. `Required` `Filter(ge;le)`
UnitOfMeasure	string (10)	Unit of measure for Total and Max. `Required` `Filter(eq)`

Attribute Details

ApplicationName

The application (if applicable) for which we are recording stats. Filter(eq;like)

Type: string (128) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 128
Show in UI: ShownByDefault

Avg

The avg value of the stat for the time period. Filter(ge;le)

Type: int32 nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Count

Number of occurrences. Required Filter(ge;le)

Type: int32
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ExcludeFromSummary

Denotes that the stat should be excluded from summarization queries (for example long polling requests). Required

Type: boolean
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

InstanceName

The name of the instance to which this statistic applies. Required Filter(eq;like)

Type: string (128)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 128
Show in UI: ShownByDefault

Max

The max value of the stat within the time period. Filter(ge;le)

Type: int32 nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

ObjectName

Name of the object or operation (depending on the statistic type).

Type: string (256) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 256
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

StatisticDate

The date (in UTC time) for which we are storing the statistics. Required Filter(eq;ge;le) ORD

Type: date
Indexed: True
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: True
Show in UI: ShownByDefault

StatisticFromTimeUtc

The starting of the time period within the date. Required Filter(ge;le)

Type: time
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

StatisticToTimeUtc

The ending of the time period within the date. Required Filter(ge;le)

Type: time
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

StatisticType

The type of the statistic: 'EXE' = Exec, 'WAI' = Wait, 'TAB' = Table, 'PER' = Performance, 'SIT' = Site. Required Filter(multi eq) ORD

Type: StatisticType
Indexed: True
Category: System
Allowed values for the StatisticType(Systems.Monitoring.InstanceStatistics.md#statistictype) data attribute
Allowed Values (Systems.Monitoring.InstanceStatisticsRepository.StatisticType Enum Members)

Value	Description
Exec	Exec value. Stored as 'EXE'. Database Value: 'EXE' Model Value: 0 Domain API Value: 'Exec'
Wait	Wait value. Stored as 'WAI'. Database Value: 'WAI' Model Value: 1 Domain API Value: 'Wait'
Table	Table value. Stored as 'TAB'. Database Value: 'TAB' Model Value: 2 Domain API Value: 'Table'
Perf	Perf value. Stored as 'PER'. Database Value: 'PER' Model Value: 3 Domain API Value: 'Perf'
Site	Site value. Stored as 'SIT'. Database Value: 'SIT' Model Value: 4 Domain API Value: 'Site'

Supported Filters: Equals, EqualsIn
Supports Order By: True
Show in UI: ShownByDefault

SubType

Kind of stat (depending on the type). Required Filter(eq)

Type: string (64)
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

Total

The total of the stat for the time period. Required Filter(ge;le)

Type: int32
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

UnitOfMeasure

Unit of measure for Total and Max. Required Filter(eq)

Type: string (10)
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 10
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

user
The user.
Type: Users
notificationClass
The notification class.
Type: string
subject
The notification subject.
Type: string

priority
The notification priority.
Type: Systems.Core.NotificationsRepository.Priority
Allowed values for the Priority(Systems.Core.Notifications.md#priority) data attribute
Allowed Values (Systems.Core.NotificationsRepository.Priority Enum Members)

Value	Description
Background	Background value. Stored as 1. Model Value: 1 Domain API Value: 'Background'
Low	Low value. Stored as 2. Model Value: 2 Domain API Value: 'Low'
Normal	Normal value. Stored as 3. Model Value: 3 Domain API Value: 'Normal'
High	High value. Stored as 4. Model Value: 4 Domain API Value: 'High'
Urgent	Urgent value. Stored as 5. Model Value: 5 Domain API Value: 'Urgent'

Optional: True
Default Value: Normal

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

None

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Systems_Monitoring_InstanceStatistics?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Systems_Monitoring_InstanceStatistics?$top=10

Table of Contents

Systems.Monitoring.InstanceStatistics Entity

Default Visualization

Track Changes

Aggregate

Attributes

Attribute Details

ApplicationName

Avg

Count

DisplayText

ExcludeFromSummary

Id

InstanceName

Max

ObjectName

ObjectVersion

StatisticDate

StatisticFromTimeUtc

StatisticToTimeUtc

StatisticType

SubType

Total

UnitOfMeasure

API Methods

GetAllowedCustomPropertyValues

CreateNotification

CreateCopy

Business Rules

Front-End Business Rules

API