-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
GaugeAttribute.xml
217 lines (217 loc) · 12.2 KB
/
GaugeAttribute.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<Type Name="GaugeAttribute" FullName="Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute">
<TypeSignature Language="C#" Value="public sealed class GaugeAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit GaugeAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class GaugeAttribute
Inherits Attribute" />
<TypeSignature Language="F#" Value="type GaugeAttribute = class
 inherit Attribute" />
<TypeSignature Language="C++ CLI" Value="public ref class GaugeAttribute sealed : Attribute" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Telemetry.Abstractions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>8.4.0.0</AssemblyVersion>
<AssemblyVersion>8.5.0.0</AssemblyVersion>
<AssemblyVersion>8.6.0.0</AssemblyVersion>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Method)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Method)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.Conditional("CODE_GENERATION_ATTRIBUTES")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Provides information to guide the production of a strongly typed gauge metric factory method and associated type.
</summary>
<remarks>
This attribute is applied to a method that has the following constraints:
<list type="bullet"><item><description>Must be a partial method.</description></item><item><description>Must return <c>metricName</c> as the type. A class with that name will be generated.</description></item><item><description>Must not be generic.</description></item><item><description>Must have <c>System.Diagnostics.Metrics.Meter</c> as first parameter.</description></item><item><description>Must have all the keys provided in <c>staticTags</c> as string type parameters.</description></item></list></remarks>
<example>
<code language="csharp">
static partial class Metric
{
[Gauge]
static partial MemoryUsage CreateMemoryUsage(Meter meter);
}
</code>
</example>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GaugeAttribute (params string[] tagNames);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string[] tagNames) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute.#ctor(System.String[])" />
<MemberSignature Language="VB.NET" Value="Public Sub New (ParamArray tagNames As String())" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute : string[] -> Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute" Usage="new Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute tagNames" />
<MemberSignature Language="C++ CLI" Value="public:
 GaugeAttribute(... cli::array <System::String ^> ^ tagNames);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Telemetry.Abstractions</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="tagNames" Type="System.String[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="tagNames">Variable array of tag names.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GaugeAttribute (Type type);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Type type) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute.#ctor(System.Type)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (type As Type)" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute : Type -> Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute" Usage="new Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute type" />
<MemberSignature Language="C++ CLI" Value="public:
 GaugeAttribute(Type ^ type);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Telemetry.Abstractions</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<param name="type">A type providing the metric tag names. The tag values are taken from the type's public fields and properties.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string? Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute.Name" />
<MemberSignature Language="VB.NET" Value="Public Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute.Name" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Name { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Telemetry.Abstractions</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the metric.
</summary>
<value>To be added.</value>
<remarks>
In this example the metric name is <c>SampleMetric</c>. When <c>Name</c> is not provided
the return type of the method is used as metric name. In this example, this would
be <c>MemoryUsage</c> if <c>Name</c> wasn't provided.
</remarks>
<example>
In this example, the metric name is <c>SampleMetric</c>. When <c>Name</c> is not provided, the return type of the method is used as metric name. In this example,
the metric name would be <c>MemoryUsage</c> if <c>Name</c> wasn't provided.
<code language="csharp">
static partial class Metric
{
[Gauge(Name="SampleMetric")]
static partial MemoryUsage CreateMemoryUsage(Meter meter);
}
</code></example>
</Docs>
</Member>
<Member MemberName="TagNames">
<MemberSignature Language="C#" Value="public string[]? TagNames { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string[] TagNames" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute.TagNames" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TagNames As String()" />
<MemberSignature Language="F#" Value="member this.TagNames : string[]" Usage="Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute.TagNames" />
<MemberSignature Language="C++ CLI" Value="public:
 property cli::array <System::String ^> ^ TagNames { cli::array <System::String ^> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Telemetry.Abstractions</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the metric's tag names.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public Type? Type { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type Type" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute.Type" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Type As Type" />
<MemberSignature Language="F#" Value="member this.Type : Type" Usage="Microsoft.Extensions.Diagnostics.Metrics.GaugeAttribute.Type" />
<MemberSignature Language="C++ CLI" Value="public:
 property Type ^ Type { Type ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Telemetry.Abstractions</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the type that supplies metric tag values.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>