-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ResourceMonitoringOptions.xml
232 lines (232 loc) · 13.7 KB
/
ResourceMonitoringOptions.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
<Type Name="ResourceMonitoringOptions" FullName="Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions">
<TypeSignature Language="C#" Value="public class ResourceMonitoringOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ResourceMonitoringOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions" />
<TypeSignature Language="VB.NET" Value="Public Class ResourceMonitoringOptions" />
<TypeSignature Language="F#" Value="type ResourceMonitoringOptions = class" />
<TypeSignature Language="C++ CLI" Value="public ref class ResourceMonitoringOptions" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.ResourceMonitoring</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.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>
Options to control resource monitoring behavior.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ResourceMonitoringOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 ResourceMonitoringOptions();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.ResourceMonitoring</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CollectionWindow">
<MemberSignature Language="C#" Value="public TimeSpan CollectionWindow { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan CollectionWindow" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.CollectionWindow" />
<MemberSignature Language="VB.NET" Value="Public Property CollectionWindow As TimeSpan" />
<MemberSignature Language="F#" Value="member this.CollectionWindow : TimeSpan with get, set" Usage="Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.CollectionWindow" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan CollectionWindow { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.ResourceMonitoring</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum time window for which utilization can be requested.
</summary>
<value>
The default value is 5 seconds.
</value>
<remarks>
This value represents the total amount of time for which the resource monitor tracks utilization
information for the system.
</remarks>
</Docs>
</Member>
<Member MemberName="CpuConsumptionRefreshInterval">
<MemberSignature Language="C#" Value="public TimeSpan CpuConsumptionRefreshInterval { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan CpuConsumptionRefreshInterval" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.CpuConsumptionRefreshInterval" />
<MemberSignature Language="VB.NET" Value="Public Property CpuConsumptionRefreshInterval As TimeSpan" />
<MemberSignature Language="F#" Value="member this.CpuConsumptionRefreshInterval : TimeSpan with get, set" Usage="Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.CpuConsumptionRefreshInterval" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan CpuConsumptionRefreshInterval { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.ResourceMonitoring</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the default interval used for refreshing values reported by <c>"process.cpu.utilization"</c> metrics.
</summary>
<value>
The default value is 5 seconds.
</value>
<remarks>
This property is Linux-specific and has no effect on other operating systems.
This is the time interval for a metric value to fetch resource utilization data from the operating system.
</remarks>
</Docs>
</Member>
<Member MemberName="MemoryConsumptionRefreshInterval">
<MemberSignature Language="C#" Value="public TimeSpan MemoryConsumptionRefreshInterval { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan MemoryConsumptionRefreshInterval" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.MemoryConsumptionRefreshInterval" />
<MemberSignature Language="VB.NET" Value="Public Property MemoryConsumptionRefreshInterval As TimeSpan" />
<MemberSignature Language="F#" Value="member this.MemoryConsumptionRefreshInterval : TimeSpan with get, set" Usage="Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.MemoryConsumptionRefreshInterval" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan MemoryConsumptionRefreshInterval { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.ResourceMonitoring</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the default interval used for refreshing values reported by <c>"dotnet.process.memory.virtual.utilization"</c> metrics.
</summary>
<value>
The default value is 5 seconds.
</value>
<remarks>
This property is Linux-specific and has no effect on other operating systems.
This is the time interval for a metric value to fetch resource utilization data from the operating system.
</remarks>
</Docs>
</Member>
<Member MemberName="PublishingWindow">
<MemberSignature Language="C#" Value="public TimeSpan PublishingWindow { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan PublishingWindow" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.PublishingWindow" />
<MemberSignature Language="VB.NET" Value="Public Property PublishingWindow As TimeSpan" />
<MemberSignature Language="F#" Value="member this.PublishingWindow : TimeSpan with get, set" Usage="Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.PublishingWindow" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan PublishingWindow { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.ResourceMonitoring</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the observation window used to calculate the <see cref="T:Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceUtilization" /> instances pushed to publishers.
</summary>
<value>
The default value is 5 seconds.
</value>
<remarks>
The value needs to be less than or equal to <see cref="P:Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.CollectionWindow" />.
</remarks>
</Docs>
</Member>
<Member MemberName="SamplingInterval">
<MemberSignature Language="C#" Value="public TimeSpan SamplingInterval { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan SamplingInterval" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.SamplingInterval" />
<MemberSignature Language="VB.NET" Value="Public Property SamplingInterval As TimeSpan" />
<MemberSignature Language="F#" Value="member this.SamplingInterval : TimeSpan with get, set" Usage="Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.SamplingInterval" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan SamplingInterval { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.ResourceMonitoring</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the interval at which a new utilization sample is captured.
</summary>
<value>
The default value is 1 second.
</value>
<remarks>
This value must be less than or equal to <see cref="P:Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.CollectionWindow" />.
</remarks>
</Docs>
</Member>
<Member MemberName="SourceIpAddresses">
<MemberSignature Language="C#" Value="public System.Collections.Generic.ISet<string> SourceIpAddresses { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.ISet`1<string> SourceIpAddresses" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.SourceIpAddresses" />
<MemberSignature Language="VB.NET" Value="Public Property SourceIpAddresses As ISet(Of String)" />
<MemberSignature Language="F#" Value="member this.SourceIpAddresses : System.Collections.Generic.ISet<string> with get, set" Usage="Microsoft.Extensions.Diagnostics.ResourceMonitoring.ResourceMonitoringOptions.SourceIpAddresses" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::ISet<System::String ^> ^ SourceIpAddresses { System::Collections::Generic::ISet<System::String ^> ^ get(); void set(System::Collections::Generic::ISet<System::String ^> ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.ResourceMonitoring</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DataAnnotations.Required]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DataAnnotations.Required>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.ISet<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the list of source IPv4 addresses to track the connections for in telemetry.
</summary>
<value>To be added.</value>
<remarks>
This property is Windows-specific and has no effect on other operating systems.
</remarks>
</Docs>
</Member>
</Members>
</Type>