Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing description node to XML docs #8959

Merged
merged 1 commit into from
Apr 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ public readonly struct EnvironmentStatistics
/// <remarks>
/// This value is computed as the lower of two amounts:
/// <list type="bullet">
/// <item>The amount of memory after which the garbage collector will begin aggressively collecting memory, defined by <see cref="GCMemoryInfo.HighMemoryLoadThresholdBytes"/>.</item>
/// <item>The process' configured memory limit, defined by <see cref="GCMemoryInfo.TotalAvailableMemoryBytes"/>.</item>
/// <item><description>The amount of memory after which the garbage collector will begin aggressively collecting memory, defined by <see cref="GCMemoryInfo.HighMemoryLoadThresholdBytes"/>.</description></item>
/// <item><description>The process' configured memory limit, defined by <see cref="GCMemoryInfo.TotalAvailableMemoryBytes"/>.</description></item>
/// </list>
/// Memory limits are common in containerized environments. For more information on configuring memory limits, see <see href="https://learn.microsoft.com/en-us/dotnet/core/runtime-config/garbage-collector#heap-limit"/>
/// </remarks>
Expand Down
4 changes: 2 additions & 2 deletions src/Orleans.Core/Async/AsyncLock.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ namespace Orleans
///
/// When programming with <b>async</b>, the <b>lock</b> keyword is problematic:
/// <list type="bullet">
/// <item><b>lock</b> will cause the thread to block while it waits for exclusive access to the critical section of code.</item>
/// <item>The <b>await</b> keyword cannot be used within the scope of a <b>lock</b> construct.</item>
/// <item><description><b>lock</b> will cause the thread to block while it waits for exclusive access to the critical section of code.</description></item>
/// <item><description>The <b>await</b> keyword cannot be used within the scope of a <b>lock</b> construct.</description></item>
/// </list>
///
/// It is still useful, at times, to provide exclusive access to a critical section of code. AsyncLock provides semantics
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@ public sealed class ResourceOptimizedPlacementOptions
/// <summary>
/// The specified margin for which: if two silos (one of them being the local to the current pending activation), have a utilization score that should be considered "the same" within this margin.
/// <list type="bullet">
/// <item>When this value is 0, then the policy will always favor the silo with the lower resource utilization, even if that silo is remote to the current pending activation.</item>
/// <item>When this value is 100, then the policy will always favor the local silo, regardless of its relative utilization score. This policy essentially becomes equivalent to <see cref="PreferLocalPlacement"/>.</item>
/// <item><description>When this value is 0, then the policy will always favor the silo with the lower resource utilization, even if that silo is remote to the current pending activation.</description></item>
/// <item><description>When this value is 100, then the policy will always favor the local silo, regardless of its relative utilization score. This policy essentially becomes equivalent to <see cref="PreferLocalPlacement"/>.</description></item>
/// </list>
/// </summary>
/// <remarks><i>
Expand Down
18 changes: 9 additions & 9 deletions src/Orleans.Runtime/MembershipService/LocalSiloHealthMonitor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@ internal interface ILocalSiloHealthMonitor
/// membership algorithm (refutation, for example).
/// The monitor implements the following heuristics:
/// <list type="bullet">
/// <item>Check that this silos is marked as active in membership.</item>
/// <item>Check that no other silo suspects this silo.</item>
/// <item>Check for recently received successful ping responses.</item>
/// <item>Check for recently received ping requests.</item>
/// <item>Check that the .NET Thread Pool is able to process work items within one second.</item>
/// <item>Check that local async timers have been firing on-time (within 3 seconds of their due time).</item>
/// <item><description>Check that this silos is marked as active in membership.</description></item>
/// <item><description>Check that no other silo suspects this silo.</description></item>
/// <item><description>Check for recently received successful ping responses.</description></item>
/// <item><description>Check for recently received ping requests.</description></item>
/// <item><description>Check that the .NET Thread Pool is able to process work items within one second.</description></item>
/// <item><description>Check that local async timers have been firing on-time (within 3 seconds of their due time).</description></item>
/// </list>
/// </remarks>
internal class LocalSiloHealthMonitor : ILifecycleParticipant<ISiloLifecycle>, ILifecycleObserver, ILocalSiloHealthMonitor
Expand All @@ -60,7 +60,7 @@ internal class LocalSiloHealthMonitor : ILifecycleParticipant<ISiloLifecycle>, I
private readonly ClusterMembershipOptions _clusterMembershipOptions;
private readonly IAsyncTimer _degradationCheckTimer;
private readonly ThreadPoolMonitor _threadPoolMonitor;
private readonly ProbeRequestMonitor _probeRequestMonitor;
private readonly ProbeRequestMonitor _probeRequestMonitor;
private ValueStopwatch _clusteredDuration;
private Task? _runTask;
private bool _isActive;
Expand Down Expand Up @@ -103,7 +103,7 @@ public LocalSiloHealthMonitor(
/// <param name="checkTime">The time which the check is taking place.</param>
/// <param name="complaints">If not null, will be populated with the current set of detected health issues.</param>
/// <returns>The local health degradation score, which is a value between 0 (healthy) and <see cref="MaxScore"/> (unhealthy).</returns>
public int GetLocalHealthDegradationScore(DateTime checkTime, List<string>? complaints)
public int GetLocalHealthDegradationScore(DateTime checkTime, List<string>? complaints)
{
var score = 0;
score += CheckSuspectingNodes(checkTime, complaints);
Expand Down Expand Up @@ -151,7 +151,7 @@ private int CheckThreadPoolQueueDelay(DateTime checkTime, List<string>? complain

complaints?.Add(
$".NET Thread Pool is exhibiting delays of {threadPoolDelaySeconds}s. This can indicate .NET Thread Pool starvation, very long .NET GC pauses, or other runtime or machine pauses.");
}
}

// Each second of delay contributes to the score.
return (int)threadPoolDelaySeconds;
Expand Down
Loading