[This is preliminary documentation and is subject to change.]
The InstrumentationService type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | InstrumentationService |
Creates a instrumentation service instance
|
![]() | InstrumentationService(Object) |
Creates a instrumentation service instance
|
Methods
Name | Description | |
---|---|---|
![]() | ____ObtainPrivateServiceStatusLockObject |
WARNING: Developers never call this method!!!
It is used by advanced derived implementations that need to synchronize status updates.
We do not want to make statuslock protected as it is almost never needed, hence this accessor
(Inherited from Service.) |
![]() | __setComponentDirector | (Inherited from ApplicationComponent.) |
![]() | AbortStart |
Allows to abort unsuccessful DoStart() overridden implementation.
This method must be called from within DoStart()
(Inherited from Service.) |
![]() | AcceptManagerVisit |
Accepts a visit of a manager entity - this call is useful for periodic updates of service status,
i.e. when service does not have a thread of its own it can be periodically managed by some other service through this method.
The default implementation of DoAcceptManagerVisit(object, DateTime) does nothing
(Inherited from Service.) |
![]() | CheckForCompleteStop |
Non-blocking call that returns true when the service instance has completely stopped after SignalStop()
(Inherited from Service.) |
![]() | CheckServiceActive |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.) |
![]() | CheckServiceActiveOrStarting |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.) |
![]() | CheckServiceInactive |
Checks for service inactivity and throws exception if service is running (started, starting or stopping)
(Inherited from Service.) |
![]() | Configure |
Configures service from configuration node (and possibly it's sub-nodes)
(Inherited from Service.) |
![]() | Destructor | (Inherited from Service.) |
![]() | Dispose |
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.) |
![]() | DoAcceptManagerVisit |
Accepts a visit from external manager. Base implementation does nothing.
Override in services that need external management calls
to update their state periodically, i.e. when they don't have a thread on their own
(Inherited from Service.) |
![]() | DoCheckForCompleteStop |
Provides implementation for checking whether the service has completely stopped
(Inherited from Service.) |
![]() | DoConfigure | (Overrides Service DoConfigure(IConfigSectionNode).) |
![]() | DoSignalStop | (Overrides Service DoSignalStop .) |
![]() | DoStart | (Overrides Service DoStart .) |
![]() | DoWaitForCompleteStop | (Overrides Service DoWaitForCompleteStop .) |
![]() | EnsureObjectNotDisposed |
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.) |
![]() | ![]() | Determines whether the specified object is equal to the current object. (Inherited from ![]() |
![]() | ExternalGetParameter |
Gets external parameter value returning true if parameter was found
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | ExternalParametersForGroups |
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | ExternalSetParameter |
Sets external parameter value returning true if parameter was found and set
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | Finalize | (Inherited from DisposableObject.) |
![]() | 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.
|
![]() | 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
|
![]() | 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
|
![]() | ![]() | Serves as the default hash function. (Inherited from ![]() |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() | LocalizedTimeToUniversalTime |
Converts localized time to UTC time as of TimeLocation property
(Inherited from Service.) |
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | Record |
Records instrumentation datum
|
![]() | SignalStop |
Non-blocking call that initiates the stopping of the service
(Inherited from Service.) |
![]() | Start |
Blocking call that starts the service instance
(Inherited from Service.) |
![]() | StartByApplication |
Blocking call that starts the service instance
(Inherited from Service.) |
![]() | ![]() | Returns a string that represents the current object. (Inherited from ![]() |
![]() | UniversalTimeToLocalizedTime |
Converts universal time to local time as of TimeLocation property
(Inherited from Service.) |
![]() | WaitForCompleteStop |
Blocks execution of current thread until this service has completely stopped
(Inherited from Service.) |
Extension Methods
Fields
Name | Description | |
---|---|---|
![]() ![]() | CONFIG_PROVIDER_SECTION | |
![]() ![]() | DEFAULT_MAX_REC_COUNT | |
![]() ![]() | DEFAULT_RESULT_BUFFER_SIZE | |
![]() ![]() | MAX_RESULT_BUFFER_SIZE | |
![]() ![]() | MAXIMUM_MAX_REC_COUNT | |
![]() ![]() | MINIMUM_MAX_REC_COUNT |
Properties
Name | Description | |
---|---|---|
![]() | ApplicationDontAutoStartService |
Checks whether the class is decorated with ApplicationDontAutoStartServiceAttribute
(Inherited from Service.) |
![]() | ComponentCommonName | (Overrides ApplicationComponent ComponentCommonName.) |
![]() | ComponentDirector | (Inherited from Service TDirector .) |
![]() | ComponentSID |
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.) |
![]() | ComponentStartTime |
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.) |
![]() | 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
|
![]() | Disposed |
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.) |
![]() | DisposeStarted |
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.) |
![]() | Enabled | |
![]() | ExternalParameters |
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .) |
![]() | InstrumentationEnabled |
Shortcut to SelfInstrumented, implements IInstrumentable
(Overrides ServiceWithInstrumentationBase TDirector InstrumentationEnabled.) |
![]() | LocalizedTime |
Returns current time localized per TimeLocation
(Inherited from Service.) |
![]() | MaxRecordCount |
Gets/Sets the maximum record count that this instance can store
|
![]() | Name |
Provides textual name for the service
(Inherited from Service.) |
![]() | OSInstrumentationIntervalMS |
Specifies how often OS instrumentation such as CPU and RAM is sampled.
Value of zero disables OS sampling
|
![]() | Overflown |
Returns true to indicate that instrumentation does not have any space left to record more data
|
![]() | ProcessingIntervalMS |
Specifies how often aggregation is performed
|
![]() | Provider |
References provider that persists instrumentation data
|
![]() | RecordCount |
Returns current record count in the instance
|
![]() | 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.
This property can be set only on a stopped service
|
![]() | Running |
Returns true when service is active or about to become active.
Check in service implementation loops/threads/tasks
(Inherited from Service.) |
![]() | SelfInstrumented |
When true, outputs instrumentation data about the self (how many datum buffers, etc.)
|
![]() | Status |
Current service status
(Inherited from Service.) |
![]() | TimeLocation |
Returns time location of this LocalizedTimeProvider implementation
(Inherited from Service.) |
See Also