-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
InstrumentRule.xml
196 lines (194 loc) · 13.5 KB
/
InstrumentRule.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
<Type Name="InstrumentRule" FullName="Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule">
<TypeSignature Language="C#" Value="public class InstrumentRule" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit InstrumentRule extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule" />
<TypeSignature Language="VB.NET" Value="Public Class InstrumentRule" />
<TypeSignature Language="F#" Value="type InstrumentRule = class" />
<TypeSignature Language="C++ CLI" Value="public ref class InstrumentRule" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.Abstractions</AssemblyName>
<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(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name" /> or prefix.</param>
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name" />.</param>
<param name="listenerName">The <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name" />.</param>
<param name="scopes">A bitwise combination of the enumeration values that specifies the scopes to consider.</param>
<param name="enable">
<see langword="true" />to enable the matched instrument for this listener; otherwise, <see langword="false" />.</param>
<summary>Contains a set of parameters used to determine which instruments are enabled for which listeners. Unspecified parameters match anything.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
The most specific rule that matches a given instrument will be used. The priority of parameters is as follows:
- MeterName, either an exact match, or the longest prefix match. See <xref:System.Diagnostics.Metrics.Meter.Name>.
- InstrumentName, an exact match. See <xref:System.Diagnostics.Metrics.Instrument.Name>.
- ListenerName, an exact match. See <xref:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name>.
- Scopes.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InstrumentRule (string? meterName, string? instrumentName, string? listenerName, Microsoft.Extensions.Diagnostics.Metrics.MeterScope scopes, bool enable);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string meterName, string instrumentName, string listenerName, valuetype Microsoft.Extensions.Diagnostics.Metrics.MeterScope scopes, bool enable) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Diagnostics.Metrics.MeterScope,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (meterName As String, instrumentName As String, listenerName As String, scopes As MeterScope, enable As Boolean)" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule : string * string * string * Microsoft.Extensions.Diagnostics.Metrics.MeterScope * bool -> Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule" Usage="new Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule (meterName, instrumentName, listenerName, scopes, enable)" />
<MemberSignature Language="C++ CLI" Value="public:
 InstrumentRule(System::String ^ meterName, System::String ^ instrumentName, System::String ^ listenerName, Microsoft::Extensions::Diagnostics::Metrics::MeterScope scopes, bool enable);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.Abstractions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="meterName" Type="System.String" />
<Parameter Name="instrumentName" Type="System.String" />
<Parameter Name="listenerName" Type="System.String" />
<Parameter Name="scopes" Type="Microsoft.Extensions.Diagnostics.Metrics.MeterScope" />
<Parameter Name="enable" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="meterName">The <see cref="P:System.Diagnostics.Metrics.Meter.Name" /> or prefix.</param>
<param name="instrumentName">The <see cref="P:System.Diagnostics.Metrics.Instrument.Name" />.</param>
<param name="listenerName">The <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name" />.</param>
<param name="scopes">A bitwise combination of the enumeration values that specifies the scopes to consider.</param>
<param name="enable">
<see langword="true" />to enable the matched instrument for this listener; otherwise, <see langword="false" />.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule" /> class.</summary>
<remarks>
<para>The most specific rule that matches a given instrument will be used. The priority of parameters is as follows:</para>
<para>- MeterName, either an exact match, or the longest prefix match. See <see cref="P:System.Diagnostics.Metrics.Meter.Name" />.</para>
<para>- InstrumentName, an exact match. <see cref="P:System.Diagnostics.Metrics.Instrument.Name" />.</para>
<para>- ListenerName, an exact match. <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name" />.</para>
<para>- Scopes</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Enable">
<MemberSignature Language="C#" Value="public bool Enable { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Enable" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Enable" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Enable As Boolean" />
<MemberSignature Language="F#" Value="member this.Enable : bool" Usage="Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Enable" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool Enable { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.Abstractions</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 the instrument should be enabled for the listener.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InstrumentName">
<MemberSignature Language="C#" Value="public string? InstrumentName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string InstrumentName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.InstrumentName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property InstrumentName As String" />
<MemberSignature Language="F#" Value="member this.InstrumentName : string" Usage="Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.InstrumentName" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ InstrumentName { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.Abstractions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="P:System.Diagnostics.Metrics.Instrument.Name" />, an exact match.</summary>
<value>If <see langword="null" />, all instruments for the meter are matched.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListenerName">
<MemberSignature Language="C#" Value="public string? ListenerName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ListenerName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.ListenerName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ListenerName As String" />
<MemberSignature Language="F#" Value="member this.ListenerName : string" Usage="Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.ListenerName" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ListenerName { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.Abstractions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="P:Microsoft.Extensions.Diagnostics.Metrics.IMetricsListener.Name" />, an exact match.</summary>
<value>If <see langword="null" />, all instruments for the meter are matched.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MeterName">
<MemberSignature Language="C#" Value="public string? MeterName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MeterName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.MeterName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MeterName As String" />
<MemberSignature Language="F#" Value="member this.MeterName : string" Usage="Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.MeterName" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ MeterName { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.Abstractions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="P:System.Diagnostics.Metrics.Meter.Name" />, either an exact match or the longest prefix match. Only full segment matches are considered.</summary>
<value>If <see langword="null" />, all instruments for the meter are matched.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Scopes">
<MemberSignature Language="C#" Value="public Microsoft.Extensions.Diagnostics.Metrics.MeterScope Scopes { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Extensions.Diagnostics.Metrics.MeterScope Scopes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Scopes" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Scopes As MeterScope" />
<MemberSignature Language="F#" Value="member this.Scopes : Microsoft.Extensions.Diagnostics.Metrics.MeterScope" Usage="Microsoft.Extensions.Diagnostics.Metrics.InstrumentRule.Scopes" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Extensions::Diagnostics::Metrics::MeterScope Scopes { Microsoft::Extensions::Diagnostics::Metrics::MeterScope get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.Abstractions</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.Diagnostics.Metrics.MeterScope</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:Microsoft.Extensions.Diagnostics.Metrics.MeterScope" />.</summary>
<value>To be added.</value>
<remarks>This value is used to distinguish between meters created via <see cref="T:System.Diagnostics.Metrics.Meter" /> constructors (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Global" />), and those created via Dependency Injection with <see cref="M:System.Diagnostics.Metrics.IMeterFactory.Create(System.Diagnostics.Metrics.MeterOptions)" /> (<see cref="F:Microsoft.Extensions.Diagnostics.Metrics.MeterScope.Local" />).</remarks>
</Docs>
</Member>
</Members>
</Type>