IInstrumentation MembersNFX Class Library

[This is preliminary documentation and is subject to change.]

The IInstrumentation type exposes the following members.
Methods

  NameDescription
Public methodOnlineDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from OnlineIDisposable.)
Public methodGetBufferedResults
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.
Public methodGetBufferedResultsSince
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
Public methodGetDatumTypeSources
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
Public methodLocalizedTimeToUniversalTime
Converts localized time to UTC time as of TimeLocation property
(Inherited from ILocalizedTimeProvider.)
Public methodRecord
Records instrumentation datum
Public methodUniversalTimeToLocalizedTime
Converts universal time to local time as of TimeLocation property
(Inherited from ILocalizedTimeProvider.)
Back to Top
Properties

  NameDescription
Public propertyComponentCommonName
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.)
Public propertyComponentDirector
Returns a reference to an object that this app component services/operates under, or null
(Inherited from IApplicationComponent.)
Public propertyComponentSID
Returns process/instance unique app component system id
(Inherited from IApplicationComponent.)
Public propertyDataTypes
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
Public propertyEnabled
Indicates whether instrumentation is enabled
Public propertyLocalizedTime
Returns current time localized per TimeLocation
(Inherited from ILocalizedTimeProvider.)
Public propertyMaxRecordCount
Gets/Sets the maximum record count that this instance can store
Public propertyOSInstrumentationIntervalMS
Specifies how often OS instrumentation such as CPU and RAM is sampled. Value of zero disables OS sampling
Public propertyOverflown
Returns true to indicate that instrumentation does not have any space left to record more data at the present moment
Public propertyProcessingIntervalMS
Specifies how often aggregation is performed
Public propertyRecordCount
Returns current record count in the instance
Public propertyResultBufferSize
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
Public propertySelfInstrumented
When true, outputs instrumentation data about the self (how many datum buffers, etc.)
Public propertyTimeLocation
Returns the location
(Inherited from ILocalizedTimeProvider.)
Back to Top
See Also