Skip to content

Commit 5aaee7b

Browse files
committed
Update documentation on lock contention metrics.
1 parent 43df76e commit 5aaee7b

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

src/Autofac/Diagnostics/AutofacMetrics.cs

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,10 +213,17 @@ public static void RecordReflectionActivation(Type implementationType, TimeSpan
213213
}
214214

215215
/// <summary>
216-
/// Records the wait duration for a lock contention event.
216+
/// Records the wait duration for a lock contention event. This may include
217+
/// time spent waiting as well as acquiring the lock, but will be closely
218+
/// correlated with contention time.
217219
/// </summary>
218220
/// <param name="category">The lock category (e.g., service or lifetime scope).</param>
219-
/// <param name="detail">Additional details about the lock, if any.</param>
221+
/// <param name="detail">
222+
/// Additional details about the lock, if any. Note this will likely
223+
/// generate high-cardinality metrics in a production environment since it
224+
/// will track information about services and lifetime scopes acquiring
225+
/// locks and include identities for each.
226+
/// </param>
220227
/// <param name="elapsed">The time spent waiting.</param>
221228
public static void RecordLockContention(string category, string? detail, TimeSpan elapsed)
222229
{

0 commit comments

Comments
 (0)