| Name | Description | |
|---|---|---|
 | EventMetricDefinition Constructor | Create a new (empty) event metric definition, ready to have value columns defined for it (with AddValue()). |
EventMetricDefinition Class Members
In This Topic
The following tables list the members exposed by EventMetricDefinition.
Public Constructors
Public Properties
| Name | Description | |
|---|---|---|
 | BoundType | When bound, indicates the exact interface or object type that was bound. |
| Caption | A short display string for this metric definition, suitable for end-user display. |
| CategoryName | The category of this metric for display purposes. This can be a period delimited string to represent a variable height hierarchy. |
| CounterName | The display name of this metric (unique within the category name). |
| DefaultValue | The default value column to display for this event metric. Typically this should be a numeric value column. |
| Description | A description of what is tracked by this metric, suitable for end-user display. |
| Id | The 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. |
| Interval | The recommended default display interval for graphing. |
| IsBound | Indicates if this definition is configured to retrieve its information directly from an object. |
| IsReadOnly | Indicates whether this event metric definition is now read-only because it has been officially registered and can be used to create event metric instances. |
| Key | The three-part key of the metric definition being captured, as a single string. |
| MetricsSystem | The metric capture system label under which this metric definition was created. |
| ValueDefinitions | The set of values defined for this metric definition. (A snapshot array copy. AddValue() through this definition object.) |
Public Methods
| Name | Description | |
|---|---|---|
 | AddValue | Create a new value column definition with the supplied name and type. The name must be unique within this definition. |
| CompareTo | Indicates the relative sort order of this object to another of the same type. |
 | ContainsKey | Overloaded. Determines whether the collection of all metric definitions contains an element with the specified key. |
| Equals | Overloaded. Determines if the provided object is identical to this object. |
| IsNumericValueType | Indicates whether the provided object is a numeric type or can only be graphed by a SummaryFunction.Count. |
| IsSupportedValueType | Indicates whether the provided type can be stored as a value or not. |
| Register | 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. |
| TryGetValue | Overloaded. Retrieve an EventMetricDefinition by its Id, if present. (Throws an ArgumentException if the Id resolves to a SampledMetricDefinition instead.) |
| Write | Overloaded. Sample every event metric defined by EventMetric and EventMetricValue attributes on the provided data object at any interface or inheritance level. |
| WriteSample | Overloaded. Write a metric sample to the specified instance of this event metric definition using the provided data object. |
See Also
Reference
EventMetricDefinition Class
Gibraltar.Agent.Metrics Namespace
Developer's Reference
Metrics - Designing Event Metrics