Class InstrumentationProvider

Defines a base provider for InstrumentationService

Inheritance
System.Object
DisposableObject
ApplicationComponent
Service
Service<InstrumentationService>
InstrumentationProvider
CompositeInstrumentationProvider
LogInstrumentationProvider
NOPInstrumentationProvider
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NFX.Instrumentation
Assembly: NFX.dll
Syntax
public abstract class InstrumentationProvider : Service<InstrumentationService>, IApplicationComponent, IDisposable, IService, INamed, IConfigurable, ILocalizedTimeProvider, IExternallyParameterized

Constructors

InstrumentationProvider(InstrumentationService)

Declaration
protected InstrumentationProvider(InstrumentationService director)
Parameters
Type Name Description
InstrumentationService director

Properties

ExternalParameters

Returns named parameters that can be used to control this component

Declaration
public virtual IEnumerable<KeyValuePair<string, Type>> ExternalParameters { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.Type>>

Methods

AfterBatch(Object)

Declaration
protected virtual void AfterBatch(object batchContext)
Parameters
Type Name Description
System.Object batchContext

AfterType(Type, Object, Object)

Declaration
protected virtual void AfterType(Type type, object batchContext, object typeContext)
Parameters
Type Name Description
System.Type type
System.Object batchContext
System.Object typeContext

BeforeBatch()

Declaration
protected virtual object BeforeBatch()
Returns
Type Description
System.Object

BeforeType(Type, Object)

Declaration
protected virtual object BeforeType(Type type, object batchContext)
Parameters
Type Name Description
System.Type type
System.Object batchContext
Returns
Type Description
System.Object

DoConfigure(IConfigSectionNode)

Declaration
protected override void DoConfigure(IConfigSectionNode node)
Parameters
Type Name Description
IConfigSectionNode node
Overrides

ExternalGetParameter(String, out Object, String[])

Gets external parameter value returning true if parameter was found

Declaration
public virtual bool ExternalGetParameter(string name, out object value, params string[] groups)
Parameters
Type Name Description
System.String name
System.Object value
System.String[] groups
Returns
Type Description
System.Boolean

ExternalParametersForGroups(String[])

Returns named parameters that can be used to control this component

Declaration
public virtual IEnumerable<KeyValuePair<string, Type>> ExternalParametersForGroups(params string[] groups)
Parameters
Type Name Description
System.String[] groups
Returns
Type Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.Type>>

ExternalSetParameter(String, Object, String[])

Sets external parameter value returning true if parameter was found and set

Declaration
public virtual bool ExternalSetParameter(string name, object value, params string[] groups)
Parameters
Type Name Description
System.String name
System.Object value
System.String[] groups
Returns
Type Description
System.Boolean

Write(Datum, Object, Object)

Declaration
protected abstract void Write(Datum aggregatedDatum, object batchContext, object typeContext)
Parameters
Type Name Description
Datum aggregatedDatum
System.Object batchContext
System.Object typeContext

WriteLog(MessageType, String, String, String)

Declaration
protected void WriteLog(MessageType type, string message, string parameters = null, string from = null)
Parameters
Type Name Description
MessageType type
System.String message
System.String parameters
System.String from

Implements

System.IDisposable

Extension Methods