InstrumentationService MembersNFX Class Library

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

The InstrumentationService type exposes the following members.
Constructors

  NameDescription
Public methodInstrumentationService 
Creates a instrumentation service instance
Public methodInstrumentationService(Object)
Creates a instrumentation service instance
Back to Top
Methods

  NameDescription
Protected method____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.)
Protected method__setComponentDirector (Inherited from ApplicationComponent.)
Protected methodAbortStart
Allows to abort unsuccessful DoStart() overridden implementation. This method must be called from within DoStart()
(Inherited from Service.)
Public methodAcceptManagerVisit
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.)
Public methodCheckForCompleteStop
Non-blocking call that returns true when the service instance has completely stopped after SignalStop()
(Inherited from Service.)
Protected methodCheckServiceActive
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.)
Protected methodCheckServiceActiveOrStarting
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.)
Protected methodCheckServiceInactive
Checks for service inactivity and throws exception if service is running (started, starting or stopping)
(Inherited from Service.)
Public methodConfigure
Configures service from configuration node (and possibly it's sub-nodes)
(Inherited from Service.)
Protected methodDestructor (Inherited from Service.)
Public methodDispose
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.)
Protected methodDoAcceptManagerVisit
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.)
Protected methodDoCheckForCompleteStop
Provides implementation for checking whether the service has completely stopped
(Inherited from Service.)
Protected methodDoConfigure (Overrides Service DoConfigure(IConfigSectionNode).)
Protected methodDoSignalStop (Overrides Service DoSignalStop .)
Protected methodDoStart (Overrides Service DoStart .)
Protected methodDoWaitForCompleteStop (Overrides Service DoWaitForCompleteStop .)
Public methodEnsureObjectNotDisposed
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.)
Public methodOnlineEquals
Determines whether the specified object is equal to the current object.
(Inherited from OnlineObject.)
Public methodExternalGetParameter
Gets external parameter value returning true if parameter was found
(Inherited from ServiceWithInstrumentationBase TDirector .)
Public methodExternalParametersForGroups
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .)
Public methodExternalSetParameter
Sets external parameter value returning true if parameter was found and set
(Inherited from ServiceWithInstrumentationBase TDirector .)
Protected methodFinalize (Inherited from DisposableObject.)
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
Public methodOnlineGetHashCode
Serves as the default hash function.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodLocalizedTimeToUniversalTime
Converts localized time to UTC time as of TimeLocation property
(Inherited from Service.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodRecord
Records instrumentation datum
Public methodSignalStop
Non-blocking call that initiates the stopping of the service
(Inherited from Service.)
Public methodStart
Blocking call that starts the service instance
(Inherited from Service.)
Protected methodStartByApplication
Blocking call that starts the service instance
(Inherited from Service.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Public methodUniversalTimeToLocalizedTime
Converts universal time to local time as of TimeLocation property
(Inherited from Service.)
Public methodWaitForCompleteStop
Blocks execution of current thread until this service has completely stopped
(Inherited from Service.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsBool (Defined by ObjectValueConversion.)
Public Extension MethodAsByte (Defined by ObjectValueConversion.)
Public Extension MethodAsChar (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime(DateTime, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID(GDID, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsInt (Defined by ObjectValueConversion.)
Public Extension MethodAsJSONConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLaconicConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNonNullOrEmptyString (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableBool (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableChar (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDateTime (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDIDSymbol (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableShort (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableTimeSpan (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableULong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsShort (Defined by ObjectValueConversion.)
Public Extension MethodAsString (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan(TimeSpan, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsULong (Defined by ObjectValueConversion.)
Public Extension MethodAsUri (Defined by ObjectValueConversion.)
Public Extension MethodAsUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsXMLConfig (Defined by ObjectValueConversion.)
Public Extension MethodToErlObject Overloaded.
Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToErlObject(ErlTypeOrder, Boolean)Overloaded.
Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToJSON(JSONWritingOptions)Overloaded.
Serializes object into JSON string
(Defined by JSONExtensions.)
Public Extension MethodToJSON(TextWriter, JSONWritingOptions)Overloaded.
Serializes object into JSON format using provided TextWriter
(Defined by JSONExtensions.)
Public Extension MethodToJSON(Stream, JSONWritingOptions, Encoding)Overloaded.
Serializes object into JSON format using provided stream and optional encoding
(Defined by JSONExtensions.)
Back to Top
Fields

  NameDescription
Public fieldStatic memberCONFIG_PROVIDER_SECTION
Public fieldStatic memberDEFAULT_MAX_REC_COUNT
Public fieldStatic memberDEFAULT_RESULT_BUFFER_SIZE
Public fieldStatic memberMAX_RESULT_BUFFER_SIZE
Public fieldStatic memberMAXIMUM_MAX_REC_COUNT
Public fieldStatic memberMINIMUM_MAX_REC_COUNT
Back to Top
Properties

  NameDescription
Public propertyApplicationDontAutoStartService
Checks whether the class is decorated with ApplicationDontAutoStartServiceAttribute
(Inherited from Service.)
Public propertyComponentCommonName (Overrides ApplicationComponent ComponentCommonName.)
Public propertyComponentDirector (Inherited from Service TDirector .)
Public propertyComponentSID
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.)
Public propertyComponentStartTime
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.)
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 propertyDisposed
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.)
Public propertyDisposeStarted
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.)
Public propertyEnabled
Public propertyExternalParameters
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .)
Public propertyInstrumentationEnabled
Shortcut to SelfInstrumented, implements IInstrumentable
(Overrides ServiceWithInstrumentationBase TDirector  InstrumentationEnabled.)
Public propertyLocalizedTime
Returns current time localized per TimeLocation
(Inherited from Service.)
Public propertyMaxRecordCount
Gets/Sets the maximum record count that this instance can store
Public propertyName
Provides textual name for the service
(Inherited from Service.)
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
Public propertyProcessingIntervalMS
Specifies how often aggregation is performed
Public propertyProvider
References provider that persists instrumentation data
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. This property can be set only on a stopped service
Public propertyRunning
Returns true when service is active or about to become active. Check in service implementation loops/threads/tasks
(Inherited from Service.)
Public propertySelfInstrumented
When true, outputs instrumentation data about the self (how many datum buffers, etc.)
Public propertyStatus
Current service status
(Inherited from Service.)
Public propertyTimeLocation
Returns time location of this LocalizedTimeProvider implementation
(Inherited from Service.)
Back to Top
See Also