-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
SystemResources.xml
176 lines (176 loc) · 11.1 KB
/
SystemResources.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
<Type Name="SystemResources" FullName="Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources">
<TypeSignature Language="C#" Value="public readonly struct SystemResources" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit SystemResources extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources" />
<TypeSignature Language="VB.NET" Value="Public Structure SystemResources" />
<TypeSignature Language="F#" Value="type SystemResources = struct" />
<TypeSignature Language="C++ CLI" Value="public value class SystemResources" />
<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.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-6.0;net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.IsReadOnly>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Provides information about the CPU and memory limits defined by the underlying system.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SystemResources (double guaranteedCpuUnits, double maximumCpuUnits, ulong guaranteedMemoryInBytes, ulong maximumMemoryInBytes);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(float64 guaranteedCpuUnits, float64 maximumCpuUnits, unsigned int64 guaranteedMemoryInBytes, unsigned int64 maximumMemoryInBytes) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources.#ctor(System.Double,System.Double,System.UInt64,System.UInt64)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (guaranteedCpuUnits As Double, maximumCpuUnits As Double, guaranteedMemoryInBytes As ULong, maximumMemoryInBytes As ULong)" />
<MemberSignature Language="F#" Value="new Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources : double * double * uint64 * uint64 -> Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources" Usage="new Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources (guaranteedCpuUnits, maximumCpuUnits, guaranteedMemoryInBytes, maximumMemoryInBytes)" />
<MemberSignature Language="C++ CLI" Value="public:
 SystemResources(double guaranteedCpuUnits, double maximumCpuUnits, System::UInt64 guaranteedMemoryInBytes, System::UInt64 maximumMemoryInBytes);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.ResourceMonitoring</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="guaranteedCpuUnits" Type="System.Double" />
<Parameter Name="maximumCpuUnits" Type="System.Double" />
<Parameter Name="guaranteedMemoryInBytes" Type="System.UInt64" />
<Parameter Name="maximumMemoryInBytes" Type="System.UInt64" />
</Parameters>
<Docs>
<param name="guaranteedCpuUnits">The CPU units available in the system.</param>
<param name="maximumCpuUnits">The maximum CPU units available in the system.</param>
<param name="guaranteedMemoryInBytes">The memory allocated to the system in bytes.</param>
<param name="maximumMemoryInBytes">The maximum memory allocated to the system in bytes.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources" /> struct.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GuaranteedCpuUnits">
<MemberSignature Language="C#" Value="public double GuaranteedCpuUnits { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 GuaranteedCpuUnits" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources.GuaranteedCpuUnits" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property GuaranteedCpuUnits As Double" />
<MemberSignature Language="F#" Value="member this.GuaranteedCpuUnits : double" Usage="Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources.GuaranteedCpuUnits" />
<MemberSignature Language="C++ CLI" Value="public:
 property double GuaranteedCpuUnits { double get(); };" />
<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.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the CPU units available in the system.
</summary>
<value>To be added.</value>
<remarks>
This value corresponds to the number of the guaranteed CPUs as described by Kubernetes CPU request parameter. Each 1000 CPU units
represent 1 CPU or 1 Core. For example, if the Pod is configured with 1500m units as the CPU request, this property will be assigned
to 1.5, which means one and a half CPU will be dedicated for the Pod.
For a Pod, this value is calculated based on the <c>cgroupv2</c> weight, using the formula
<c>y = (1 + ((x - 2) * 9999) / 262142)</c>, where <c>y</c> is the CPU weight and <c>x</c> is the CPU share (<c>cgroup v1</c>).
For more information, see <see href="https://github.com/kubernetes/enhancements/tree/master/keps/sig-node/2254-cgroup-v2#phase-1-convert-from-cgroups-v1-settings-to-v2" />.
</remarks>
</Docs>
</Member>
<Member MemberName="GuaranteedMemoryInBytes">
<MemberSignature Language="C#" Value="public ulong GuaranteedMemoryInBytes { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int64 GuaranteedMemoryInBytes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources.GuaranteedMemoryInBytes" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property GuaranteedMemoryInBytes As ULong" />
<MemberSignature Language="F#" Value="member this.GuaranteedMemoryInBytes : uint64" Usage="Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources.GuaranteedMemoryInBytes" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::UInt64 GuaranteedMemoryInBytes { System::UInt64 get(); };" />
<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.UInt64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the memory allocated to the system in bytes.
</summary>
<value>To be added.</value>
<remarks>
This value corresponds to the number of the guaranteed memory as configured by a Kubernetes memory request parameter.
</remarks>
</Docs>
</Member>
<Member MemberName="MaximumCpuUnits">
<MemberSignature Language="C#" Value="public double MaximumCpuUnits { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 MaximumCpuUnits" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources.MaximumCpuUnits" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MaximumCpuUnits As Double" />
<MemberSignature Language="F#" Value="member this.MaximumCpuUnits : double" Usage="Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources.MaximumCpuUnits" />
<MemberSignature Language="C++ CLI" Value="public:
 property double MaximumCpuUnits { double get(); };" />
<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.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the maximum CPU units available in the system.
</summary>
<value>To be added.</value>
<remarks>
This value corresponds to the number of the maximum CPUs as described by Kubernetes CPU limit parameter. Each 1000 CPU units
represent 1 CPU or 1 Core. For example, if the Pod is configured with 1500m units as the CPU limit, this property will be assigned
to 1.5, which means one and a half CPU will be the maximum CPU available.
</remarks>
</Docs>
</Member>
<Member MemberName="MaximumMemoryInBytes">
<MemberSignature Language="C#" Value="public ulong MaximumMemoryInBytes { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int64 MaximumMemoryInBytes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources.MaximumMemoryInBytes" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property MaximumMemoryInBytes As ULong" />
<MemberSignature Language="F#" Value="member this.MaximumMemoryInBytes : uint64" Usage="Microsoft.Extensions.Diagnostics.ResourceMonitoring.SystemResources.MaximumMemoryInBytes" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::UInt64 MaximumMemoryInBytes { System::UInt64 get(); };" />
<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.UInt64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the container's request memory limit or the maximum allocated for the VM.
</summary>
<value>To be added.</value>
<remarks>
This value corresponds to the number of the maximum memory as configured by a Kubernetes memory limit parameter.
</remarks>
</Docs>
</Member>
</Members>
</Type>