| 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). |
| Description | A description of what is tracked by this metric, suitable for end-user display. |
| Id | The unique Id of this sampled 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 that this sampled metric definition has been registered and can not be altered (always true for sampled metric definitions). |
| 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. |
| RequiresMultipleSamples | Indicates whether a final value can be determined from just one sample or if two comparable samples are required. |
| 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. |
SampledMetricDefinition Class Members
In This Topic
The following tables list the members exposed by SampledMetricDefinition.
Public Properties
Public Methods
| Name | Description | |
|---|---|---|
 | CompareTo | Compare this custom sampled metric definition with another to determine if they are identical. |
 | 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. |
| IsValidDataType | Checks the provided Type against the list of recognized numeric types and special types supported for SampledMetric data. |
| Register | Find or create a sampled metric definition from the specified parameters. |
| RequiresDivisor | Checks the provided SamplingType enum value to determine if that sampling type requires two values per sample. |
| TryGetValue | Overloaded. Retrieve a SampledMetricDefinition by its Id, if present. (Throws an ArgumentException if the Id resolves to an EventMetricDefinition instead.) |
| Write | Overloaded. Sample every sampled metric defined by SampledMetric and SampledMetricValue attributes on the provided data object at any interface or inheritance level. |
| WriteSample | Overloaded. Write a metric sample to the specified metric instance with the provided data, for non-fraction sampling types. |
See Also