-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
Instrument.xml
330 lines (330 loc) · 20.8 KB
/
Instrument.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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
<Type Name="Instrument" FullName="System.Diagnostics.Metrics.Instrument">
<TypeSignature Language="C#" Value="public abstract class Instrument" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Instrument extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Diagnostics.Metrics.Instrument" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class Instrument" />
<TypeSignature Language="F#" Value="type Instrument = class" />
<TypeSignature Language="C++ CLI" Value="public ref class Instrument abstract" />
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<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(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Base class of all metrics instrument classes</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Instrument (System.Diagnostics.Metrics.Meter meter, string name, string? unit, string? description);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Diagnostics.Metrics.Meter meter, string name, string unit, string description) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Metrics.Instrument.#ctor(System.Diagnostics.Metrics.Meter,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (meter As Meter, name As String, unit As String, description As String)" />
<MemberSignature Language="F#" Value="new System.Diagnostics.Metrics.Instrument : System.Diagnostics.Metrics.Meter * string * string * string -> System.Diagnostics.Metrics.Instrument" Usage="new System.Diagnostics.Metrics.Instrument (meter, name, unit, description)" />
<MemberSignature Language="C++ CLI" Value="protected:
 Instrument(System::Diagnostics::Metrics::Meter ^ meter, System::String ^ name, System::String ^ unit, System::String ^ description);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="meter" Type="System.Diagnostics.Metrics.Meter" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="unit" Type="System.String">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="description" Type="System.String">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="meter">The meter that created the instrument.</param>
<param name="name">The instrument name. Cannot be <see langword="null" />.</param>
<param name="unit">Optional instrument unit of measurements.</param>
<param name="description">Optional instrument description.</param>
<summary>Protected constructor to initialize the common instrument properties like the meter, name, description, and unit.</summary>
<remarks>All classes that Instrument must call this constructor when constructing objects of the extended class.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Instrument (System.Diagnostics.Metrics.Meter meter, string name, string? unit, string? description, System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object?>>? tags);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Diagnostics.Metrics.Meter meter, string name, string unit, string description, class System.Collections.Generic.IEnumerable`1<valuetype System.Collections.Generic.KeyValuePair`2<string, object>> tags) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Metrics.Instrument.#ctor(System.Diagnostics.Metrics.Meter,System.String,System.String,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.Object}})" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (meter As Meter, name As String, unit As String, description As String, tags As IEnumerable(Of KeyValuePair(Of String, Object)))" />
<MemberSignature Language="F#" Value="new System.Diagnostics.Metrics.Instrument : System.Diagnostics.Metrics.Meter * string * string * string * seq<System.Collections.Generic.KeyValuePair<string, obj>> -> System.Diagnostics.Metrics.Instrument" Usage="new System.Diagnostics.Metrics.Instrument (meter, name, unit, description, tags)" />
<MemberSignature Language="C++ CLI" Value="protected:
 Instrument(System::Diagnostics::Metrics::Meter ^ meter, System::String ^ name, System::String ^ unit, System::String ^ description, System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>> ^ tags);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="meter" Type="System.Diagnostics.Metrics.Meter" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="unit" Type="System.String">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="description" Type="System.String">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="tags" Type="System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String,System.Object>>">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 0, 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 0, 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="meter">The meter that created the instrument.</param>
<param name="name">The instrument name. Cannot be <see langword="null" />.</param>
<param name="unit">An optional instrument unit of measurements.</param>
<param name="description">An optional instrument description.</param>
<param name="tags">Optional instrument tags.</param>
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.Metrics.Instrument" /> class with the specified meter, name, description, and unit.</summary>
<remarks> All classes extending <see cref="T:System.Diagnostics.Metrics.Instrument" /> need to call this constructor when constructing an object of the extended class.</remarks>
</Docs>
</Member>
<Member MemberName="Description">
<MemberSignature Language="C#" Value="public string? Description { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Description" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Metrics.Instrument.Description" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Description As String" />
<MemberSignature Language="F#" Value="member this.Description : string" Usage="System.Diagnostics.Metrics.Instrument.Description" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Description { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.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(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the instrument description.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Enabled">
<MemberSignature Language="C#" Value="public bool Enabled { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Enabled" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Metrics.Instrument.Enabled" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Enabled As Boolean" />
<MemberSignature Language="F#" Value="member this.Enabled : bool" Usage="System.Diagnostics.Metrics.Instrument.Enabled" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool Enabled { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates if there are any listeners for this instrument.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsObservable">
<MemberSignature Language="C#" Value="public virtual bool IsObservable { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsObservable" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Metrics.Instrument.IsObservable" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property IsObservable As Boolean" />
<MemberSignature Language="F#" Value="member this.IsObservable : bool" Usage="System.Diagnostics.Metrics.Instrument.IsObservable" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool IsObservable { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether the instrument is an observable instrument.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Meter">
<MemberSignature Language="C#" Value="public System.Diagnostics.Metrics.Meter Meter { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Diagnostics.Metrics.Meter Meter" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Metrics.Instrument.Meter" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Meter As Meter" />
<MemberSignature Language="F#" Value="member this.Meter : System.Diagnostics.Metrics.Meter" Usage="System.Diagnostics.Metrics.Instrument.Meter" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Diagnostics::Metrics::Meter ^ Meter { System::Diagnostics::Metrics::Meter ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.Metrics.Meter</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the Meter that created the instrument.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Metrics.Instrument.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="System.Diagnostics.Metrics.Instrument.Name" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Name { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the instrument name.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Publish">
<MemberSignature Language="C#" Value="protected void Publish ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void Publish() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Metrics.Instrument.Publish" />
<MemberSignature Language="VB.NET" Value="Protected Sub Publish ()" />
<MemberSignature Language="F#" Value="member this.Publish : unit -> unit" Usage="instrument.Publish " />
<MemberSignature Language="C++ CLI" Value="protected:
 void Publish();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Activates the instrument to start recording measurements and to allow listeners to start listening to such measurements.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Tags">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,object?>>? Tags { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1<valuetype System.Collections.Generic.KeyValuePair`2<string, object>> Tags" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Metrics.Instrument.Tags" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Tags As IEnumerable(Of KeyValuePair(Of String, Object))" />
<MemberSignature Language="F#" Value="member this.Tags : seq<System.Collections.Generic.KeyValuePair<string, obj>>" Usage="System.Diagnostics.Metrics.Instrument.Tags" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>> ^ Tags { System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.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, 0, 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 0, 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String,System.Object>></ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the tags associated with the instrument.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Unit">
<MemberSignature Language="C#" Value="public string? Unit { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Unit" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Metrics.Instrument.Unit" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Unit As String" />
<MemberSignature Language="F#" Value="member this.Unit : string" Usage="System.Diagnostics.Metrics.Instrument.Unit" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Unit { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.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(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the instrument unit of measurements.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>