| Name | Description | |
|---|---|---|
 | Caption | A short caption of what the metric tracks, suitable for end-user display. |
| CategoryName | The category of this metric for display purposes. Category is the top displayed hierarchy. |
| CounterName | The display name of this metric (unique within the category name). |
| Definition | The definition of this event metric. |
| Description | A description of what is tracked by this metric, suitable for end-user display. |
| Id | The unique Id of this event metric instance. This can reliably be used as a key to refer to this item, within the same session which created it. |
| InstanceName | Gets the instance name for this event metric. |
| IsDefault | Indicates whether this is the default metric instance for this metric definition or not. |
| Key | The four-part key of the metric instance being captured, as a single string. |
| MetricsSystem | The metrics capture system label of this metric definition. |
EventMetric Class Members
In This Topic
The following tables list the members exposed by EventMetric.
Public Properties
Public Methods
| Name | Description | |
|---|---|---|
 | CompareTo | Indicates the relative sort order of this object to another of the same type. |
| CreateSample | Create a new, empty metric sample for this event metric instance, ready to be filled out and written. |
| Equals | Overloaded. Determines if the provided object is identical to this object. |
 | Register | Overloaded. Registers all event metric definitions defined by attributes on the provided object or Type, and registers metric instances where EventMetricInstanceName attribute is also found (with a live object). |
| Write | Overloaded. Write event metric samples for all event metrics defined on the provided data object by attributes. |
| WriteSample | Overloaded. Write an event metric sample for this event metric instance using the provided data object. |
See Also
Reference
EventMetric Class
Gibraltar.Agent.Metrics Namespace
Related Classes
EventMetricSample Class
EventMetricDefinition Class
EventMetricAttribute Class
EventMetricValueAttribute Class
SampledMetric Class
Developer's Reference
Metrics - Introduction
Metrics - Sampled and Event Metrics