Merge pull request #56 from thiagograndesso/update-readme-file

nblumhardt · web-flow · commit 1039beee6435 · 2020-05-07T15:17:46.000+10:00
update documentation to use BufferSize property in code example
diff --git a/README.md b/README.md
@@ -49,8 +49,8 @@ In practice, this configuration (assuming one provisions an adequate `bufferSize
 // Example check: log message to an out of band alarm channel if logging is showing signs of getting overwhelmed
 void ExecuteAsyncBufferCheck(IAsyncLogEventSinkInspector inspector)
 {
-    var usagePct = inspector.Count * 100 / inspector.BoundedCapacity;
-    if (usagePct > 50) SelfLog.WriteLine("Log buffer exceeded {0:p0} usage (limit: {1})", usagePct, inspector.BoundedCapacity);
+    var usagePct = inspector.Count * 100 / inspector.BufferSize;
+    if (usagePct > 50) SelfLog.WriteLine("Log buffer exceeded {0:p0} usage (limit: {1})", usagePct, inspector.BufferSize);
 }
 
 class MonitorConfiguration : IAsyncLogEventSinkMonitor

Original file line number	Diff line number	Diff line change
@@ -49,8 +49,8 @@ In practice, this configuration (assuming one provisions an adequate `bufferSize
`49`	`49`	`// Example check: log message to an out of band alarm channel if logging is showing signs of getting overwhelmed`
`50`	`50`	`void ExecuteAsyncBufferCheck(IAsyncLogEventSinkInspector inspector)`
`51`	`51`	`{`
`52`		`- var usagePct = inspector.Count * 100 / inspector.BoundedCapacity;`
`53`		`- if (usagePct > 50) SelfLog.WriteLine("Log buffer exceeded {0:p0} usage (limit: {1})", usagePct, inspector.BoundedCapacity);`
	`52`	`+ var usagePct = inspector.Count * 100 / inspector.BufferSize;`
	`53`	`+ if (usagePct > 50) SelfLog.WriteLine("Log buffer exceeded {0:p0} usage (limit: {1})", usagePct, inspector.BufferSize);`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`class MonitorConfiguration : IAsyncLogEventSinkMonitor`