From 28d0c828341b8f0f101370dc2eed151b3be21137 Mon Sep 17 00:00:00 2001 From: Scott Addie Date: Wed, 24 Apr 2024 13:17:36 -0500 Subject: [PATCH] Add missing description node to XML docs --- .../IEnvironmentStatisticsProvider.cs | 4 ++-- src/Orleans.Core/Async/AsyncLock.cs | 4 ++-- .../ResourceOptimizedPlacementOptions.cs | 4 ++-- .../LocalSiloHealthMonitor.cs | 18 +++++++++--------- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/Orleans.Core.Abstractions/Statistics/IEnvironmentStatisticsProvider.cs b/src/Orleans.Core.Abstractions/Statistics/IEnvironmentStatisticsProvider.cs index 9b57dbf858..c89ebd639d 100644 --- a/src/Orleans.Core.Abstractions/Statistics/IEnvironmentStatisticsProvider.cs +++ b/src/Orleans.Core.Abstractions/Statistics/IEnvironmentStatisticsProvider.cs @@ -55,8 +55,8 @@ public readonly struct EnvironmentStatistics /// /// This value is computed as the lower of two amounts: /// - /// The amount of memory after which the garbage collector will begin aggressively collecting memory, defined by . - /// The process' configured memory limit, defined by . + /// The amount of memory after which the garbage collector will begin aggressively collecting memory, defined by . + /// The process' configured memory limit, defined by . /// /// Memory limits are common in containerized environments. For more information on configuring memory limits, see /// diff --git a/src/Orleans.Core/Async/AsyncLock.cs b/src/Orleans.Core/Async/AsyncLock.cs index 61ea5602d4..6df6c6e666 100644 --- a/src/Orleans.Core/Async/AsyncLock.cs +++ b/src/Orleans.Core/Async/AsyncLock.cs @@ -12,8 +12,8 @@ namespace Orleans /// /// When programming with async, the lock keyword is problematic: /// - /// lock will cause the thread to block while it waits for exclusive access to the critical section of code. - /// The await keyword cannot be used within the scope of a lock construct. + /// lock will cause the thread to block while it waits for exclusive access to the critical section of code. + /// The await keyword cannot be used within the scope of a lock construct. /// /// /// It is still useful, at times, to provide exclusive access to a critical section of code. AsyncLock provides semantics diff --git a/src/Orleans.Runtime/Configuration/Options/ResourceOptimizedPlacementOptions.cs b/src/Orleans.Runtime/Configuration/Options/ResourceOptimizedPlacementOptions.cs index 16731ef064..27b60f7b29 100644 --- a/src/Orleans.Runtime/Configuration/Options/ResourceOptimizedPlacementOptions.cs +++ b/src/Orleans.Runtime/Configuration/Options/ResourceOptimizedPlacementOptions.cs @@ -70,8 +70,8 @@ public sealed class ResourceOptimizedPlacementOptions /// /// 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. /// - /// 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. - /// 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 . + /// 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. + /// 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 . /// /// /// diff --git a/src/Orleans.Runtime/MembershipService/LocalSiloHealthMonitor.cs b/src/Orleans.Runtime/MembershipService/LocalSiloHealthMonitor.cs index 96fc47b6f1..0a93c7058e 100644 --- a/src/Orleans.Runtime/MembershipService/LocalSiloHealthMonitor.cs +++ b/src/Orleans.Runtime/MembershipService/LocalSiloHealthMonitor.cs @@ -41,12 +41,12 @@ internal interface ILocalSiloHealthMonitor /// membership algorithm (refutation, for example). /// The monitor implements the following heuristics: /// - /// Check that this silos is marked as active in membership. - /// Check that no other silo suspects this silo. - /// Check for recently received successful ping responses. - /// Check for recently received ping requests. - /// Check that the .NET Thread Pool is able to process work items within one second. - /// Check that local async timers have been firing on-time (within 3 seconds of their due time). + /// Check that this silos is marked as active in membership. + /// Check that no other silo suspects this silo. + /// Check for recently received successful ping responses. + /// Check for recently received ping requests. + /// Check that the .NET Thread Pool is able to process work items within one second. + /// Check that local async timers have been firing on-time (within 3 seconds of their due time). /// /// internal class LocalSiloHealthMonitor : ILifecycleParticipant, ILifecycleObserver, ILocalSiloHealthMonitor @@ -60,7 +60,7 @@ internal class LocalSiloHealthMonitor : ILifecycleParticipant, 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; @@ -103,7 +103,7 @@ public LocalSiloHealthMonitor( /// The time which the check is taking place. /// If not null, will be populated with the current set of detected health issues. /// The local health degradation score, which is a value between 0 (healthy) and (unhealthy). - public int GetLocalHealthDegradationScore(DateTime checkTime, List? complaints) + public int GetLocalHealthDegradationScore(DateTime checkTime, List? complaints) { var score = 0; score += CheckSuspectingNodes(checkTime, complaints); @@ -151,7 +151,7 @@ private int CheckThreadPoolQueueDelay(DateTime checkTime, List? 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;