EventMetricValueAttribute Class

In This Topic

Define a value column mapped from this field, property, or zero-argument method as part of the event metric definition.

Syntax

Visual Basic
C#

'Declaration
 
<AttributeUsageAttribute(AttributeTargets.Field Or  _
    AttributeTargets.Method Or  _
    AttributeTargets.Property, 
   AllowMultiple=True, 
   Inherited=False)>
Public NotInheritable Class EventMetricValueAttribute 
   Inherits System.Attribute

[AttributeUsage(AttributeTargets.Field | 
    AttributeTargets.Method | 
    AttributeTargets.Property, 
   AllowMultiple=true, 
   Inherited=false)]
public sealed class EventMetricValueAttribute : System.Attribute

Remarks

By decorating a field, property, or zero-argument method with this attribute you can describe how it should be recorded as a value column of an event metric. The declaring type must also have the EventMetric attribute defined. More than one EventMetricValue attribute may be applied to any field, property, or zero-argument method provided that each specifies a name unique within this event metric definition. If not specified (or null), the name of the value column will be the name of the field, property, or method, and the default caption will be taken from the name of the value column. The type will be the member's type (if a supported numeric type) or string for all other types (using ToString()). A unit caption must be specified for each value column (or null for unit-less values), and a default summary function must be designated for the value column to describe how best to aggregate that column for graphing. Non-numeric value types (all converted to strings) should use SummaryFunction.Count and use null for unit caption. (Timespan, DateTime, and DateTimeOffset are also considered numeric types.)

Inheritance Hierarchy

System.Object
System.Attribute
Gibraltar.Agent.Metrics.EventMetricValueAttribute

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

EventMetricValueAttribute Members
Gibraltar.Agent.Metrics Namespace

Send Feedback