Loupe - Log - Monitor - Resolve
Gibraltar.Agent.Metrics Namespace / EventMetricDefinition Class
Properties Methods


In This Topic
    EventMetricDefinition Class Members
    In This Topic

    The following tables list the members exposed by EventMetricDefinition.

    Public Constructors
     NameDescription
    Public ConstructorCreate a new (empty) event metric definition, ready to have value columns defined for it (with AddValue()).  
    Top
    Public Properties
     NameDescription
    Public PropertyWhen bound, indicates the exact interface or object type that was bound.  
    Public PropertyA short display string for this metric definition, suitable for end-user display.  
    Public PropertyThe category of this metric for display purposes. This can be a period delimited string to represent a variable height hierarchy.  
    Public PropertyThe display name of this metric (unique within the category name).  
    Public PropertyThe default value column to display for this event metric. Typically this should be a numeric value column.  
    Public PropertyA description of what is tracked by this metric, suitable for end-user display.  
    Public PropertyThe unique Id of this event metric definition. This can reliably be used as a key to refer to this item, within the same session which created it.  
    Public PropertyThe recommended default display interval for graphing.  
    Public PropertyIndicates if this definition is configured to retrieve its information directly from an object.  
    Public PropertyIndicates whether this event metric definition is now read-only because it has been officially registered and can be used to create event metric instances.  
    Public PropertyThe three-part key of the metric definition being captured, as a single string.  
    Public PropertyThe metric capture system label under which this metric definition was created.  
    Public PropertyThe set of values defined for this metric definition. (A snapshot array copy. AddValue() through this definition object.)  
    Top
    Public Methods
     NameDescription
    Public MethodCreate a new value column definition with the supplied name and type. The name must be unique within this definition.  
    Public MethodIndicates the relative sort order of this object to another of the same type.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Determines whether the collection of all metric definitions contains an element with the specified key.  
    Public MethodOverloaded. Determines if the provided object is identical to this object.  
    Public Methodstatic (Shared in Visual Basic)Indicates whether the provided object is a numeric type or can only be graphed by a SummaryFunction.Count.  
    Public Methodstatic (Shared in Visual Basic)Indicates whether the provided type can be stored as a value or not.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Register the referenced EventMetricDefinition template, or update the reference to the official definition if a compatible event metric definition already exists for the same 3-part Key.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Retrieve an EventMetricDefinition by its Id, if present. (Throws an ArgumentException if the Id resolves to a SampledMetricDefinition instead.)  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Sample every event metric defined by EventMetric and EventMetricValue attributes on the provided data object at any interface or inheritance level.  
    Public MethodOverloaded. Write a metric sample to the specified instance of this event metric definition using the provided data object.  
    Top
    See Also

    Reference

    EventMetricDefinition Class
    Gibraltar.Agent.Metrics Namespace

    Developer's Reference

    Metrics - Designing Event Metrics

    Related Classes

    EventMetric Class