| 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. Displayed as a dot (.) delimited hierarchal display. |
| CounterName | The display name of this metric (unique within the category name). |
| Definition | The definition of this sampled metric. |
| Description | A description of what is tracked by this metric, suitable for end-user display. |
| Id | The unique Id of this sampled 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 sampled 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. |
| SamplingType | The intended method of interpreting the sampled counter value. |
| UnitCaption | The display caption for the units this metric's values represent, or null for unit-less values. |
SampledMetric Class Members
In This Topic
The following tables list the members exposed by SampledMetric.
Public Properties
Public Methods
| Name | Description | |
|---|---|---|
 | CompareTo | Compare this sampled metric to another sampled metric. |
| Equals | Overloaded. Determines if the provided sampled metric is identical to this sampled metric. |
 | Register | Overloaded. Pre-registers all sampled metric definitions defined by attributes on the provided object or Type, and registers metric instances where SampledMetricInstanceName attribute is also found. |
| Write | Overloaded. Write sampled metric samples for all sampled metrics defined on the provided data object by attributes. |
| WriteSample | Overloaded. Write a metric sample with the provided data immediately, for non-fraction sampling types. |
See Also
Reference
SampledMetric Class
Gibraltar.Agent.Metrics Namespace
Developer's Reference
Metrics - Designing Sampled Metrics
Metrics - Sampled and Event Metrics