Microsoft.VisualStudio.LiveShare.Tracing

Describes the kind of data to be formatted.

Other flags are only for use with when applied to properties.

Data is formatted (with no privacy) using the type's standard or overridden `ToString()` method.

Text is hashed when privacy is enabled.

File name or file path is partially hashed when privacy is enabled.

Email address is partially hashed when privacy is enabled.

URI is partially hashed when privacy is enabled.

Tokens are never formatted, regardless of whether privacy is enabled. Instead they are replaced by a placeholder.

Indicates a property should always be omitted from a formatted object, regardless of whether privacy is enabled.

Indicates a property should be omitted from a formatted object if the value is null or the default value for the type, rather than included as "Name=null". Can be combined with other format flags.

This may be inferred from [DataMember(EmitDefaultValue=false)].

Indicates a property should be omitted from a formatted object when privacy is enabled. Can be combined with other format flags.

An object that normally has a single non-null member value is formatted in a more-compact form.

Indicates that a class or property should be formatted in a specific way by a live share format provider instance.

Use when `DataContract` and `DataMember` attributes are not used or do not provide sufficient formatting hints.

Gets or sets the kind of data represented by the property, for purposes of data formatting and hashing.

Not valid for use on a class attribute.

Supports formatting various fields for logging purposes, including optional hashing of potentially sensitive information to protect privacy.

This class implements `IFormatProvider`, so an instance can be passed as the first parameter to `String.Format()`. For example this line: String.Format(new DataFormatter(), "{0:P}", filePath); will use the `DataFormatter` to hash the file path when formatting it. Use an instance of this class as the format provider for a class that extends `TraceListenerBase` to enable smart formatting of traced data objects.

Format string suitable for use with DebuggerDisplayAttribute, for example: [DebuggerDisplay(DataFormatter.Debug)]

Registers a format for a data contract class. Equivalent to applying a `[DataFormat]` attribute to the class.

Registers a format for a property. Equivalent to applying a `[DataFormat]` attribute to the property.

Formats an object using the object's default format.

This static method does NOT use hashing, regardless of any instance setting.

Manages a key used to hash sensitive data to ensure privacy.

Once generated (or set by a client), the key is stored in .NET isolated storage, so that it remains consistent across sessions. The key does not need to be stored in a secure vault because it is only used as an HMAC key for hashing the current user's data for tracing and telemetry; the hashed data is then uploaded without the key.

Gets the key, generating it if not found in storage, or sets the key and stores it for later use.

Writes trace events to stdout.

Writes trace events (with basic metadata) to a log file in the temp directory.

Enables filtering based on a combination of trace source name and trace level.

Creates a new filter with a default level and optional specific levels for certain sources.

Default levels to be traced, for sources for which no specific levels are specified. Optional mapping from source names to trace levels, to use non-default levels for specific components. Optional enumeration of event ids that go to console unfiltered, ignoring console verbosity.

Parses trace output to extract an event id associated with the message.

Trace output line. Event ID or null if the line doesn't match expected pattern

Convenience methods for TraceSource.TraceEvent().

Methods that take format arguments or (dollar-prefixed) interpolated strings delay the formatting of arguments until the trace event is actually consumed by a trace listener (assuming it's not ignored by a trace filter).

Creates a new TraceSource with listeners and switch copied from the existing TraceSource.

Return a new TraceSource by appending a name

Returns true if there is at least one listener that will consume this trace event type.

Work around an overload resolution problem with `FormattableString`, enabling interpolated string to be used with tracing efficiently while also supporting plain strings.

See Overloaded string methods with string interpolation. An extra implicit conversion causes the compiler to prefer the overloads that take `FormattableString` when interpolated strings are used with the tracing methods. While plain `string` parameters get converted to/from this struct, the conversions should basically evaporate in inlining.

Write HTTP request and response details to a trace source.

True to turn on tracing of request and response headers. Off by default.

True trace request and response body content. Off by default.

Note trace listeners may truncate tracing messages to some reasonable length.