diff --git a/xml/System.Diagnostics.Tracing/DiagnosticCounter.xml b/xml/System.Diagnostics.Tracing/DiagnosticCounter.xml index 5e38b479998..c8f6b15b6f1 100644 --- a/xml/System.Diagnostics.Tracing/DiagnosticCounter.xml +++ b/xml/System.Diagnostics.Tracing/DiagnosticCounter.xml @@ -65,9 +65,18 @@ System.String - To be added. - To be added. - To be added. + Gets or sets display name of the counter. + The display name of the counter. + + + + @@ -137,8 +146,8 @@ After being disposed, this counter will do nothing, and its resources will be re System.Diagnostics.Tracing.EventSource - To be added. - To be added. + Gets the EventSource that this counter is attached to. + The EventSource that this counter is attached to. To be added. @@ -158,8 +167,8 @@ After being disposed, this counter will do nothing, and its resources will be re System.String - To be added. - To be added. + Gets the name of this counter. + The name of this counter. To be added. diff --git a/xml/System.Diagnostics.Tracing/EventCounter.xml b/xml/System.Diagnostics.Tracing/EventCounter.xml index 0fbc9ec7bff..5d7812bb30b 100644 --- a/xml/System.Diagnostics.Tracing/EventCounter.xml +++ b/xml/System.Diagnostics.Tracing/EventCounter.xml @@ -34,10 +34,11 @@ Provides the ability to collect statistics for very frequent events through the class. - class, see the [Introduction Tutorial: How to measure performance for very frequent events using EventCounters](https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.Tracing/documentation/EventCounterTutorial.md) topic. +## Remarks + +For an example of how to use the class, see [Introduction Tutorial: How to measure performance for very frequent events using EventCounters](https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.Tracing/documentation/EventCounterTutorial.md). ]]> @@ -158,9 +159,16 @@ For an example of how to use the - To be added. - To be added. - To be added. + The value to be written. + Writes the metric if performance counters are on. + + method, see [Introduction Tutorial: How to measure performance for very frequent events using EventCounters](https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.Tracing/documentation/EventCounterTutorial.md). + + ]]> + diff --git a/xml/System.Diagnostics.Tracing/IncrementingEventCounter.xml b/xml/System.Diagnostics.Tracing/IncrementingEventCounter.xml index 9d9e13a6645..3b46a8289a3 100644 --- a/xml/System.Diagnostics.Tracing/IncrementingEventCounter.xml +++ b/xml/System.Diagnostics.Tracing/IncrementingEventCounter.xml @@ -18,7 +18,11 @@ @@ -46,7 +50,9 @@ that they are attached to unless they are explicitly disposed. +## Remarks + + live as long as the that they are attached to unless they are explicitly disposed. ]]> @@ -68,9 +74,17 @@ Incrementing event counters live as long as the + diff --git a/xml/System.Diagnostics.Tracing/IncrementingPollingCounter.xml b/xml/System.Diagnostics.Tracing/IncrementingPollingCounter.xml index 9785b6525c7..e955a3cec9b 100644 --- a/xml/System.Diagnostics.Tracing/IncrementingPollingCounter.xml +++ b/xml/System.Diagnostics.Tracing/IncrementingPollingCounter.xml @@ -17,8 +17,16 @@ Provides a variant of for variables that are ever-increasing, such as the number of exceptions in the runtime. , this takes in a polling callback that it can call to update its own metric periodically. + +## Remarks + + objects live as long as the that they are attached to unless they are explicitly disposed. + +`totalValueProvider` is a method used for polling the values at the interval specified by the listener. This method is expected to return an incrementing float value; otherwise, an increment of a negative value may be reported. + +`IncrementingPollingCounter` does not calculate statistics like mean and standard deviation because it only accumulates the counter value. Unlike , this takes in a polling callback that it can call to update its own metric periodically. + +For an example that uses inside the runtime as for runtime performance counters, see the CoreCLR source for [RuntimeEventSource](https://github.com/dotnet/coreclr/blob/master/src/System.Private.CoreLib/src/System/Diagnostics/Eventing/RuntimeEventSource.cs) on GitHub. ]]> @@ -42,16 +50,10 @@ The name for this instance. - The event source. - To be added. + The event source this instance is a part of. + A method that will be used to poll the value. Initializes a new instance of the class. - - objects live as long as the that they are attached to unless they are explicitly disposed. - - ]]> - + To be added. @@ -70,9 +72,16 @@ System.TimeSpan - To be added. - To be added. - To be added. + Gets or sets rate at which this metric should be displayed as. + The rate at which this metric should be displayed. + + + diff --git a/xml/System.Diagnostics.Tracing/PollingCounter.xml b/xml/System.Diagnostics.Tracing/PollingCounter.xml index e4ee8149d97..457261323d8 100644 --- a/xml/System.Diagnostics.Tracing/PollingCounter.xml +++ b/xml/System.Diagnostics.Tracing/PollingCounter.xml @@ -18,7 +18,15 @@ in that it takes a callback function to collect metrics on its own rather than requiring the user to call every time. +## Remarks + + is a variant of that uses a callback method to poll for values rather than requiring the writer to explicitly call each time a value is tracked, `metricProvider` is a callback method that polls for values. The instance polls and reports a value retrieved by calling `metricProvider` exactly once per the interval requested by the listener. + +A lives as long as the that it is attached to unless it is explicitly disposed. + +`PollingCounter` differs from in that it takes a callback function to collect metrics on its own rather than requiring the user to call every time. + +For an example that uses inside the runtime for runtime performance counters, see the CoreCLR source for [RuntimeEventSource](https://github.com/dotnet/coreclr/blob/master/src/System.Private.CoreLib/src/System/Diagnostics/Eventing/RuntimeEventSource.cs) on GitHub. ]]> @@ -43,15 +51,9 @@ The name for this instance. The event source. - To be added. + A method that will be used to poll the value. Initializes a new instance of the class. - - that they are attached to unless they are explicitly disposed. - - ]]> - + To be added. @@ -77,4 +79,4 @@ Polling counters live as long as the property. Activities should be created by calling the constructor, configured as necessary, and then started with the method, which maintains parent-child relationships for the activities and sets . - + When an activity is finished, it should be stopped with the method. - + No `Activity` methods allow exceptions to escape as a response to bad inputs. They are thrown and caught (which allows debuggers and monitors to see the error), but the exception is suppressed, and the operation does something reasonable (typically it does nothing). ]]> @@ -114,8 +116,7 @@ Note that has a "builder" pattern: you call t The baggage key. The baggage value. Updates the to have a new baggage item with the specified key and value. - - for convenient chaining. + for convenient chaining. The tag key. The tag value. Updates the to have a new tag with the provided and . . - - for convenient chaining. + for convenient chaining. or the The UTC stop time. Updates the to set its as the difference between and the specified stop time. - - for convenient chaining. + for convenient chaining. To be added. @@ -635,8 +634,7 @@ The root ID is a substring from the or the The ID of the parent operation. Updates this to indicate that the with an ID of caused this . - - for convenient chaining. + for convenient chaining. - To be added. - To be added. + The parent activity's TraceId. + The parent activity's SpanId. To be added. - To be added. - To be added. - To be added. + Sets the parent ID using the W3C convention of a TraceId and a SpanId. + for convenient chaining. + + + @@ -699,8 +705,7 @@ This property should only be used in 'boundary' scenarios where an The start time in UTC. Sets the start time of this . - - for convenient chaining. + for convenient chaining. To be added. @@ -746,8 +751,7 @@ This property should only be used in 'boundary' scenarios where an for convenient chaining. + for convenient chaining. - \ No newline at end of file + diff --git a/xml/System.Diagnostics/ActivitySpanId.xml b/xml/System.Diagnostics/ActivitySpanId.xml index 24dd4f28da8..46373f355c7 100644 --- a/xml/System.Diagnostics/ActivitySpanId.xml +++ b/xml/System.Diagnostics/ActivitySpanId.xml @@ -189,9 +189,9 @@ The characters in are not all lower-case hexadecimal - To be added. - To be added. - To be added. + The instance to compare. + Determines whether this instance and the specified instance have the same value. + if has the same hex value as the current instance; otherwise, . To be added. @@ -214,9 +214,9 @@ The characters in are not all lower-case hexadecimal - To be added. - To be added. - To be added. + The object to compare. + the current instance and a specified object, which also must be an instance, have the same value. + if is an instance of and has the same hex value as the current instance; otherwise, . To be added. @@ -237,8 +237,8 @@ The characters in are not all lower-case hexadecimal - To be added. - To be added. + Returns the hash code of the SpanId. + The hash code of the SpanId. To be added. @@ -262,10 +262,10 @@ The characters in are not all lower-case hexadecimal - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two specified instances have the same value. + if the SpanId of is the same as the SpanId of ; otherwise, . To be added. @@ -289,10 +289,10 @@ The characters in are not all lower-case hexadecimal - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determine whether two specified instances have unequal values. + if the SpanId of is different from the SpanId of ; otherwise, . To be added. @@ -341,4 +341,4 @@ The characters in are not all lower-case hexadecimal - \ No newline at end of file + diff --git a/xml/System.Diagnostics/ActivityTraceFlags.xml b/xml/System.Diagnostics/ActivityTraceFlags.xml index 2bba38c2f4e..8091bf7a3ca 100644 --- a/xml/System.Diagnostics/ActivityTraceFlags.xml +++ b/xml/System.Diagnostics/ActivityTraceFlags.xml @@ -20,7 +20,9 @@ Specifies flags defined by the W3C standard that are associated with an activity. - property. @@ -45,7 +47,7 @@ An `ActivityTraceFflags` value is returned by the 0 - To be added. + The activity has not been marked. @@ -65,7 +67,7 @@ An `ActivityTraceFflags` value is returned by the 1 - To be added. + The activity (or more likely its parents) has been marked as useful to record. diff --git a/xml/System.Diagnostics/ActivityTraceId.xml b/xml/System.Diagnostics/ActivityTraceId.xml index 9eaa9177edf..d9ec586eac1 100644 --- a/xml/System.Diagnostics/ActivityTraceId.xml +++ b/xml/System.Diagnostics/ActivityTraceId.xml @@ -22,6 +22,8 @@ property. Because an `ActivityTraceId` is a structure that contains 16 bytes, it can be passed easily by reference. `ActivityTraceId` contains methods for converting to and from its hexadecimal string representation, tries to avoid changing formats until it has to, and caches its string representation after it is created. It is mostly useful as an exchange type. @@ -189,9 +191,9 @@ The characters in are not all lower-case hexadecimal - To be added. - To be added. - To be added. + The instance to compare. + Determines whether the current instance and a specified are equal. + if has the same hex value as the current instance; otherwise, . To be added. @@ -214,9 +216,9 @@ The characters in are not all lower-case hexadecimal - To be added. - To be added. - To be added. + The object to compare. + Determines whether this instance and a specified object, which must also be an instance, have the same value. + if is an instance of and has the same hex value as the current instance; otherwise, . To be added. @@ -237,8 +239,8 @@ The characters in are not all lower-case hexadecimal - To be added. - To be added. + Returns the hash code of the TraceId. + The hash code of the TraceId. To be added. @@ -262,11 +264,10 @@ The characters in are not all lower-case hexadecimal - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two specified instances have the same value. + if the TraceId of is the same as the TraceId of ; otherwise, . @@ -289,11 +290,10 @@ The characters in are not all lower-case hexadecimal - To be added. - To be added. - To be added. - To be added. - To be added. + The first instance to compare. + The second instance to compare. + Determines whether two specified instances have the same value. + if the TraceId of is different from the TraceId of ; otherwise, . @@ -314,7 +314,7 @@ The characters in are not all lower-case hexadecimal Returns a 16-character hexadecimal string that represents this span ID. - The 32-character hecxadecimal string representation of this trace ID. + The 32-character hexadecimal string representation of this trace ID. To be added. @@ -335,10 +335,10 @@ The characters in are not all lower-case hexadecimal - Returns a 32-aracter hexadecimal string that represents this trace ID. + Returns a 32-character hexadecimal string that represents this trace ID. The 32-character hecxadecimal string representation of this trace ID. To be added. - \ No newline at end of file + diff --git a/xml/System.Diagnostics/DiagnosticListener.xml b/xml/System.Diagnostics/DiagnosticListener.xml index 0762047073d..3432a266db1 100644 --- a/xml/System.Diagnostics/DiagnosticListener.xml +++ b/xml/System.Diagnostics/DiagnosticListener.xml @@ -28,8 +28,13 @@ Provides an implementation of the abstract class that represents a named place to which a source sends its information (events). - + method so notifications can be forwarded arbitrarily. Thus, its job is to forward things from the producer to all the listeners (multi-casting). Generally, you should not be making your own but use the default, so that notifications are as public as possible. + For more information on the and classes, see [DiagnosticSource User's Guide](https://github.com/dotnet/corefx/blob/d3942d4671919edb0cca6ddc1840190f524a809d/src/System.Diagnostics.DiagnosticSource/src/DiagnosticSourceUsersGuide.md). ]]> @@ -59,13 +64,7 @@ For more information on the and The name of this . Creates a new . - - method so notifications can be forwarded arbitrarily. Thus, its job is to forward things from the producer to all the listeners (multi-casting). Generally, you should not be making your own but use the default, so that notifications are as public as possible. - - ]]> - + To be added. @@ -269,9 +268,9 @@ If setup for the notification is expensive, you can call `IsEnabled` before perf - To be added. - To be added. - To be added. + The activity affected by an external event. + An object that represents the outgoing request. + Invokes the OnActivityExport method of all the subscribers. To be added. @@ -294,9 +293,9 @@ If setup for the notification is expensive, you can call `IsEnabled` before perf - To be added. - To be added. - To be added. + The activity affected by an external event. + An object that represents the incoming request. + Invokes the OnActivityImport method of all the subscribers. To be added. diff --git a/xml/System.Diagnostics/DiagnosticSource.xml b/xml/System.Diagnostics/DiagnosticSource.xml index e52f0a3bd02..eb198237683 100644 --- a/xml/System.Diagnostics/DiagnosticSource.xml +++ b/xml/System.Diagnostics/DiagnosticSource.xml @@ -41,7 +41,7 @@ - To be added. + Initializes an instance of the class. To be added. @@ -71,8 +71,7 @@ The name of the event being written. Verifies if the notification event is enabled. - - if the notification event is enabled, otherwise. + if the notification event is enabled, otherwise. An object that represents the additional context for IsEnabled. Consumers should expect to receive which may indicate that producer called pure IsEnabled(string) to check if consumer wants to get notifications for such events at all. Based on that, producer may call IsEnabled(string, object, object) again with non- context. Optional. An object that represents the additional context for IsEnabled. by default. Consumers should expect to receive which may indicate that producer called pure IsEnabled(string) or producer passed all necessary context in . Verifies it the notification event is enabled. - - if the notification event is enabled, otherwise. + if the notification event is enabled, otherwise. - To be added. - To be added. + The activity affected by an external event. + An object that represents the outgoing request. Transfers state from an activity to some event or operation, such as an outgoing HTTP request, that will occur outside the process. and the ougoing request logic at the instrumentation site. However, the instrumenation site can't handle policy (for example, whether activity information should be disabled or written in an older format for compatibility reasons). +To the extent possible, this should be done by the instrumentation site, because there is a contract between an and the ougoing request logic at the instrumentation site. However, the instrumentation site can't handle policy (for example, whether activity information should be disabled or written in an older format for compatibility reasons). For this, the instrumentation site needs to call back out to the logging system and ask it to resolve policy. This is the purpose of the `OnActivityExport` method. The `OnActivityExport` method is given the as well as a payload object that represents the outgoing request. A subscriber then has the ability to update the outgoing request before it is sent. -Note that this method is rarely used at instrumentation sites (only those sites that are on an outgoing boundary of the process). Moreover, typically the default policy that the instrumenation site performs (for example, to transfer all activity state in a +Note that this method is rarely used at instrumentation sites (only those sites that are on an outgoing boundary of the process). Moreover, typically the default policy that the instrumentation site performs (for example, to transfer all activity state in a particular outgoing convention) is likely to be fine. This method is only for cases where that is a problem. Thus, this method should be used very rarely and is mostly here for symetry with `OnActivityImport` and future-proofing. Note that `payload` is typed as an here, but any particular instrumentation site and subscriber should know the type of the payload and thus cast and decode it if necessary. @@ -186,7 +184,7 @@ Note that `payload` is typed as an here, but any particular and the incomming request logic at the instrumentation site. However, the instrumentation site can't handle policy. (For example, if sampling is done, exactly which requests should be sampled?) In these cases, the instrumentation site needs to call back out to the logging system and ask it to resolve policy (for example, to decide if the activity's "sampling" bit should be set). This is the purpose of the `OnActivityImport` method. It is given the activity as well as a payload object that represents the incomming request. The subscribers to the then have the opportunity to update this activity as desired.