IMeter.CreateVSHistogram Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| CreateVSHistogram<T>(String, String, String) |
Creates a VS Histogram, which is an instrument that can be used to report arbitrary values that are likely to be statistically meaningful. It is intended for statistics such as histograms, summaries, and percentiles. The VS version of a histogram enables additional properties but requires additional work to migrate to OpenTelemetry when available. |
| CreateVSHistogram<T>(String, HistogramConfiguration, String, String) |
Creates a VS Histogram, which is an instrument that can be used to report arbitrary values that are likely to be statistically meaningful. It is intended for statistics such as histograms, summaries, and percentiles. The VS version of a histogram enables additional properties but requires additional work to migrate to OpenTelemetry when available. |
CreateVSHistogram<T>(String, String, String)
Creates a VS Histogram, which is an instrument that can be used to report arbitrary values that are likely to be statistically meaningful. It is intended for statistics such as histograms, summaries, and percentiles. The VS version of a histogram enables additional properties but requires additional work to migrate to OpenTelemetry when available.
public Microsoft.VisualStudio.Telemetry.Metrics.IVSHistogram<T> CreateVSHistogram<T> (string name, string unit = default, string description = default) where T : struct;abstract member CreateVSHistogram : string * string * string -> Microsoft.VisualStudio.Telemetry.Metrics.IVSHistogram<'T (requires 'T : struct)> (requires 'T : struct)Public Function CreateVSHistogram(Of T As Structure) (name As String, Optional unit As String = Nothing, Optional description As String = Nothing) As IVSHistogram(Of T)Type Parameters
- T
The numerical type of the measurement.
Parameters
- name
- String
The instrument name. Cannot be null.
- unit
- String
Optional instrument unit of measurements.
- description
- String
Optional instrument description.
Returns
A new histogram.
Exceptions
Throws if T is not a valid numeric type. For supported types, check documentation: Microsoft.VisualStudio.Telemetry.Metrics.Histogram`1.
Applies to
CreateVSHistogram<T>(String, HistogramConfiguration, String, String)
Creates a VS Histogram, which is an instrument that can be used to report arbitrary values that are likely to be statistically meaningful. It is intended for statistics such as histograms, summaries, and percentiles. The VS version of a histogram enables additional properties but requires additional work to migrate to OpenTelemetry when available.
public Microsoft.VisualStudio.Telemetry.Metrics.IVSHistogram<T> CreateVSHistogram<T> (string name, Microsoft.VisualStudio.Telemetry.Metrics.HistogramConfiguration configuration, string unit = default, string description = default) where T : struct;abstract member CreateVSHistogram : string * Microsoft.VisualStudio.Telemetry.Metrics.HistogramConfiguration * string * string -> Microsoft.VisualStudio.Telemetry.Metrics.IVSHistogram<'T (requires 'T : struct)> (requires 'T : struct)Public Function CreateVSHistogram(Of T As Structure) (name As String, configuration As HistogramConfiguration, Optional unit As String = Nothing, Optional description As String = Nothing) As IVSHistogram(Of T)Type Parameters
- T
The numerical type of the measurement.
Parameters
- name
- String
The instrument name. Cannot be null.
- configuration
- HistogramConfiguration
Optional histogram configuration with bucket boundaries + statistical configuration.
- unit
- String
Optional instrument unit of measurements.
- description
- String
Optional instrument description.
Returns
A new histogram.
Exceptions
Throws if T is not a valid numeric type. For supported types, check documentation: Microsoft.VisualStudio.Telemetry.Metrics.Histogram`1.