[This is preliminary documentation and is subject to change.]
The IInstrumentationImplementation type exposes the following members.Methods
Name | Description | |
---|---|---|
![]() | Configure |
Configures an entity from supplied config node
(Inherited from IConfigurable.) |
![]() | ![]() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from ![]() |
![]() | ExternalGetParameter |
Gets external parameter value returning true if parameter was found
(Inherited from IExternallyParameterized.) |
![]() | ExternalParametersForGroups |
Gets names of supported external parameters or null if parameters are not supported in principle
(Inherited from IExternallyParameterized.) |
![]() | ExternalSetParameter |
Sets external parameter value, true if parameter name was found and set succeeded
(Inherited from IExternallyParameterized.) |
![]() | GetBufferedResults |
Returns the specified number of samples from the ring result buffer in the near-chronological order,
meaning that data is already sorted by time MOST of the TIME, however sorting is NOT GUARANTEED for all
result records returned as enumeration is a lazy procedure that does not make copies/take locks.
The enumeration is empty if ResultBufferSize is less or equal to zero entries.
If count is less or equal to zero then the system returns all results available.
(Inherited from IInstrumentation.) |
![]() | GetBufferedResultsSince |
Returns samples starting around the the specified UTCdate in the near-chronological order,
meaning that data is already sorted by time MOST of the TIME, however sorting is NOT GUARANTEED for all
result records returned as enumeration is a lazy procedure that does not make copies/take locks.
The enumeration is empty if ResultBufferSize is less or equal to zero entries
(Inherited from IInstrumentation.) |
![]() | GetDatumTypeSources |
Enumerates sources per Datum type ever recorded by the instance. This property may be used to build
UIs for instrumentation, i.e. datum type tree. Returned data is NOT ORDERED.
Returns default instance so caller may get default description/unit name
(Inherited from IInstrumentation.) |
![]() | LocalizedTimeToUniversalTime |
Converts localized time to UTC time as of TimeLocation property
(Inherited from ILocalizedTimeProvider.) |
![]() | Record |
Records instrumentation datum
(Inherited from IInstrumentation.) |
![]() | UniversalTimeToLocalizedTime |
Converts universal time to local time as of TimeLocation property
(Inherited from ILocalizedTimeProvider.) |
Properties
Name | Description | |
---|---|---|
![]() | ComponentCommonName |
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations.
This name is searched-by some management tools that allow to find component by this name that does not change between
application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from IApplicationComponent.) |
![]() | ComponentDirector |
Returns a reference to an object that this app component services/operates under, or null
(Inherited from IApplicationComponent.) |
![]() | ComponentSID |
Returns process/instance unique app component system id
(Inherited from IApplicationComponent.) |
![]() | DataTypes |
Enumerates distinct types of Datum ever recorded in the instance. This property may be used to build
UIs for instrumentation, i.e. datum type tree. Returned data is NOT ORDERED
(Inherited from IInstrumentation.) |
![]() | Enabled |
Indicates whether instrumentation is enabled
(Inherited from IInstrumentation.) |
![]() | ExternalParameters |
Gets names/types of supported external parameters or null if parameters are not supported in principle
(Inherited from IExternallyParameterized.) |
![]() | InstrumentationEnabled |
Turns on/off instrumentation
(Inherited from IInstrumentable.) |
![]() | LocalizedTime |
Returns current time localized per TimeLocation
(Inherited from ILocalizedTimeProvider.) |
![]() | MaxRecordCount |
Gets/Sets the maximum record count that this instance can store
(Inherited from IInstrumentation.) |
![]() | OSInstrumentationIntervalMS |
Specifies how often OS instrumentation such as CPU and RAM is sampled.
Value of zero disables OS sampling
(Inherited from IInstrumentation.) |
![]() | Overflown |
Returns true to indicate that instrumentation does not have any space left to record more data at the present moment
(Inherited from IInstrumentation.) |
![]() | ProcessingIntervalMS |
Specifies how often aggregation is performed
(Inherited from IInstrumentation.) |
![]() | RecordCount |
Returns current record count in the instance
(Inherited from IInstrumentation.) |
![]() | ResultBufferSize |
Returns the size of the ring buffer where result (aggregated) instrumentation records are kept in memory.
The maximum buffer capacity is returned, not how many results have been buffered so far.
If this property is less than or equal to zero then result buffering in memory is disabled
(Inherited from IInstrumentation.) |
![]() | SelfInstrumented |
When true, outputs instrumentation data about the self (how many datum buffers, etc.)
(Inherited from IInstrumentation.) |
![]() | TimeLocation |
Returns the location
(Inherited from ILocalizedTimeProvider.) |
See Also