Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
968 lines (904 sloc) 59.2 KB
<Type Name="Activity" FullName="System.Diagnostics.Activity">
<TypeSignature Language="C#" Value="public class Activity" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Activity extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Diagnostics.Activity" />
<TypeSignature Language="VB.NET" Value="Public Class Activity" />
<TypeSignature Language="C++ CLI" Value="public ref class Activity" />
<TypeSignature Language="F#" Value="type Activity = class" />
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents an operation with context to be used for logging.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
An `Activity` has an operation name, an ID, a start time and duration, tags, and baggage.
The current activity can be accessed with the static <xref:System.Diagnostics.Activity.Current?displayProperty=nameWithType> property.
Activities should be created by calling the constructor, configured as necessary, and then started with the <xref:System.Diagnostics.Activity.Start%2A> method, which maintains parent-child relationships for the activities and sets <xref:System.Diagnostics.Activity.Current?displayProperty=nameWithType>.
When an activity is finished, it should be stopped with the <xref:System.Diagnostics.Activity.Stop?displayProperty=nameWithType> 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).
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Activity (string operationName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string operationName) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Activity.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (operationName As String)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; Activity(System::String ^ operationName);" />
<MemberSignature Language="F#" Value="new System.Diagnostics.Activity : string -&gt; System.Diagnostics.Activity" Usage="new System.Diagnostics.Activity operationName" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="operationName" Type="System.String" />
</Parameters>
<Docs>
<param name="operationName">The name of the operation.</param>
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.Activity" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Note that <xref:System.Diagnostics.Activity> has a "builder" pattern: you call the constructor, a number of `Set*` and `Add*` APIs, and then call <xref:System.Diagnostics.Activity.Start> to build the activity. You **must** call <xref:System.Diagnostics.Activity.Start> before using the new instance.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ActivityTraceFlags">
<MemberSignature Language="C#" Value="public System.Diagnostics.ActivityTraceFlags ActivityTraceFlags { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Diagnostics.ActivityTraceFlags ActivityTraceFlags" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.ActivityTraceFlags" />
<MemberSignature Language="VB.NET" Value="Public Property ActivityTraceFlags As ActivityTraceFlags" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Diagnostics::ActivityTraceFlags ActivityTraceFlags { System::Diagnostics::ActivityTraceFlags get(); void set(System::Diagnostics::ActivityTraceFlags value); };" />
<MemberSignature Language="F#" Value="member this.ActivityTraceFlags : System.Diagnostics.ActivityTraceFlags with get, set" Usage="System.Diagnostics.Activity.ActivityTraceFlags" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.ActivityTraceFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the flags (defined by the W3C ID specification) associated with the activity.</summary>
<value>the flags associated with the activity.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddBaggage">
<MemberSignature Language="C#" Value="public System.Diagnostics.Activity AddBaggage (string key, string value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Diagnostics.Activity AddBaggage(string key, string value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Activity.AddBaggage(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function AddBaggage (key As String, value As String) As Activity" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::Diagnostics::Activity ^ AddBaggage(System::String ^ key, System::String ^ value);" />
<MemberSignature Language="F#" Value="member this.AddBaggage : string * string -&gt; System.Diagnostics.Activity" Usage="activity.AddBaggage (key, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.Activity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="key">The baggage key.</param>
<param name="value">The baggage value.</param>
<summary>Updates the <see cref="T:System.Diagnostics.Activity" /> to have a new baggage item with the specified key and value.</summary>
<returns>
<see langword="this" /> for convenient chaining.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This key/value pair is included in the collection returned by the <xref:System.Diagnostics.Activity.Baggage> property, and can also be retrieved by the <xref:System.Diagnostics.Activity.GetBaggageItem%2A> method.
`Baggage` is meant for information that is needed for runtime control. For information that is useful to show up in the log with the <xref:System.Diagnostics.Activity>, use the <xref:System.Diagnostics.Activity.Tags> property.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="AddTag">
<MemberSignature Language="C#" Value="public System.Diagnostics.Activity AddTag (string key, string value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Diagnostics.Activity AddTag(string key, string value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Activity.AddTag(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function AddTag (key As String, value As String) As Activity" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::Diagnostics::Activity ^ AddTag(System::String ^ key, System::String ^ value);" />
<MemberSignature Language="F#" Value="member this.AddTag : string * string -&gt; System.Diagnostics.Activity" Usage="activity.AddTag (key, value)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.Activity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="key">The tag key.</param>
<param name="value">The tag value.</param>
<summary>Updates the <see cref="T:System.Diagnostics.Activity" /> to have a new tag with the provided <paramref name="key" /> and <paramref name="value" />. .</summary>
<returns>
<see langword="this" /> for convenient chaining.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This key/value pair is included in the collection returned by the <xref:System.Diagnostics.Activity.Tags> property.
<xref:System.Diagnostics.Activity.Tags> is meant for information that is useful to log with the <xref:System.Diagnostics.Activity>. For information that's needed for runtime control, use the <xref:System.Diagnostics.Activity.Baggage> property.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Baggage">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;string,string&gt;&gt; Baggage { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;valuetype System.Collections.Generic.KeyValuePair`2&lt;string, string&gt;&gt; Baggage" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.Baggage" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Baggage As IEnumerable(Of KeyValuePair(Of String, String))" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Collections::Generic::IEnumerable&lt;System::Collections::Generic::KeyValuePair&lt;System::String ^, System::String ^&gt;&gt; ^ Baggage { System::Collections::Generic::IEnumerable&lt;System::Collections::Generic::KeyValuePair&lt;System::String ^, System::String ^&gt;&gt; ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Baggage : seq&lt;System.Collections.Generic.KeyValuePair&lt;string, string&gt;&gt;" Usage="System.Diagnostics.Activity.Baggage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.String&gt;&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a collection of key/value pairs that represents information that is passed to children of this <see cref="T:System.Diagnostics.Activity" />.</summary>
<value>An enumeration of string-string key-value pairs.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
`Baggage` is serialized when requests leave the process (along with the ID). Typically, `Baggage` is used for fine-grained control over logging of the activity and any children. In general, if you are not using the data at runtime, you should be using <xref:System.Diagnostics.Activity.Tags> instead.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Current">
<MemberSignature Language="C#" Value="public static System.Diagnostics.Activity Current { get; }" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2" />
<MemberSignature Language="ILAsm" Value=".property class System.Diagnostics.Activity Current" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.Current" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property Current As Activity" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static property System::Diagnostics::Activity ^ Current { System::Diagnostics::Activity ^ get(); };" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2" />
<MemberSignature Language="F#" Value="member this.Current : System.Diagnostics.Activity" Usage="System.Diagnostics.Activity.Current" FrameworkAlternate="netcore-2.0;netcore-2.1;netcore-2.2" />
<MemberSignature Language="C#" Value="public static System.Diagnostics.Activity Current { get; set; }" FrameworkAlternate="netcore-3.0;netcore-3.1" />
<MemberSignature Language="VB.NET" Value="Public Shared Property Current As Activity" FrameworkAlternate="netcore-3.0;netcore-3.1" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static property System::Diagnostics::Activity ^ Current { System::Diagnostics::Activity ^ get(); void set(System::Diagnostics::Activity ^ value); };" FrameworkAlternate="netcore-3.0;netcore-3.1" />
<MemberSignature Language="F#" Value="member this.Current : System.Diagnostics.Activity with get, set" Usage="System.Diagnostics.Activity.Current" FrameworkAlternate="netcore-3.0;netcore-3.1" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.Activity</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the current operation (<see cref="T:System.Diagnostics.Activity" />) for the current thread. This flows across async calls.</summary>
<value>The current operation for the current thread.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultIdFormat">
<MemberSignature Language="C#" Value="public static System.Diagnostics.ActivityIdFormat DefaultIdFormat { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype System.Diagnostics.ActivityIdFormat DefaultIdFormat" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.DefaultIdFormat" />
<MemberSignature Language="VB.NET" Value="Public Shared Property DefaultIdFormat As ActivityIdFormat" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static property System::Diagnostics::ActivityIdFormat DefaultIdFormat { System::Diagnostics::ActivityIdFormat get(); void set(System::Diagnostics::ActivityIdFormat value); };" />
<MemberSignature Language="F#" Value="member this.DefaultIdFormat : System.Diagnostics.ActivityIdFormat with get, set" Usage="System.Diagnostics.Activity.DefaultIdFormat" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.ActivityIdFormat</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the default ID format for the <see cref="T:System.Diagnostics.Activity" />.</summary>
<value>To be added.</value>
<remarks>
<format type="text/markdown"><![CDATA[
The `Activity` instance tries to use the same format for IDs as its parent. If the activity has no parent, this property determines the default format to use.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Duration">
<MemberSignature Language="C#" Value="public TimeSpan Duration { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan Duration" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.Duration" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Duration As TimeSpan" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property TimeSpan Duration { TimeSpan get(); };" />
<MemberSignature Language="F#" Value="member this.Duration : TimeSpan" Usage="System.Diagnostics.Activity.Duration" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the duration of the operation.</summary>
<value>The delta between <see cref="P:System.Diagnostics.Activity.StartTimeUtc" /> and the end time if the <see cref="T:System.Diagnostics.Activity" /> has ended (<see cref="M:System.Diagnostics.Activity.Stop" /> or <see cref="M:System.Diagnostics.Activity.SetEndTime(System.DateTime)" /> was called), or <see cref="F:System.TimeSpan.Zero" /> if the <see cref="T:System.Diagnostics.Activity" /> has not ended and <see cref="M:System.Diagnostics.Activity.SetEndTime(System.DateTime)" /> was not called.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ForceDefaultIdFormat">
<MemberSignature Language="C#" Value="public static bool ForceDefaultIdFormat { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property bool ForceDefaultIdFormat" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.ForceDefaultIdFormat" />
<MemberSignature Language="VB.NET" Value="Public Shared Property ForceDefaultIdFormat As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static property bool ForceDefaultIdFormat { bool get(); void set(bool value); };" />
<MemberSignature Language="F#" Value="member this.ForceDefaultIdFormat : bool with get, set" Usage="System.Diagnostics.Activity.ForceDefaultIdFormat" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a valud that detrmines if the <see cref="P:System.Diagnostics.Activity.DefaultIdFormat" /> is always used to define the default ID format. </summary>
<value>
<see langword="true" /> to always use the <see cref="P:System.Diagnostics.Activity.DefaultIdFormat" />; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
Normally if the <xref:System.Diagnostics.Activity.ParentId> is defined, its format determines the format used by the current <xref:System.Diagnostics.Activity>. However, if `ForceDefaultFormat` is set to `true`, the ID format is always defined by the <xref:System.Diagnostics.Activity.DefaultIdFormat> property even if the <xref:System.Diagnostics.Activity.ParentId> is defined and the parent has a different format.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetBaggageItem">
<MemberSignature Language="C#" Value="public string GetBaggageItem (string key);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetBaggageItem(string key) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Activity.GetBaggageItem(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetBaggageItem (key As String) As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::String ^ GetBaggageItem(System::String ^ key);" />
<MemberSignature Language="F#" Value="member this.GetBaggageItem : string -&gt; string" Usage="activity.GetBaggageItem key" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<param name="key">The baggage key.</param>
<summary>Returns the value of a key-value pair added to the activity with <see cref="M:System.Diagnostics.Activity.AddBaggage(System.String,System.String)" />.</summary>
<returns>The value of the key-value-pair item if it exists, or <see langword="null" /> if it does not exist.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public string Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.Id" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Id As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Id { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Id : string" Usage="System.Diagnostics.Activity.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets an identifier that is specific to a particular request.</summary>
<value>The activity ID.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
An ID has a hierarchical structure: `root-id.id1_id2.id3_`. The ID is generated when <xref:System.Diagnostics.Activity.Start> is called by appending a suffix to the `Activity.Parent.Id` or the <xref:System.Diagnostics.Activity.ParentId>. An <xref:System.Diagnostics.Activity> has no ID until it starts. For more information, see [Id Format](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/ActivityUserGuide.md#id-format).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="IdFormat">
<MemberSignature Language="C#" Value="public System.Diagnostics.ActivityIdFormat IdFormat { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Diagnostics.ActivityIdFormat IdFormat" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.IdFormat" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IdFormat As ActivityIdFormat" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Diagnostics::ActivityIdFormat IdFormat { System::Diagnostics::ActivityIdFormat get(); };" />
<MemberSignature Language="F#" Value="member this.IdFormat : System.Diagnostics.ActivityIdFormat" Usage="System.Diagnostics.Activity.IdFormat" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.ActivityIdFormat</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the format for the <see cref="P:System.Diagnostics.Activity.Id" />.</summary>
<value>The format for the <see cref="P:System.Diagnostics.Activity.Id" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OperationName">
<MemberSignature Language="C#" Value="public string OperationName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string OperationName" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.OperationName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property OperationName As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ OperationName { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.OperationName : string" Usage="System.Diagnostics.Activity.OperationName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the operation name.</summary>
<value>The name of the operation.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
An operation name is the *coarsest* name that is useful for grouping/filtering. The name is typically a compile-time constant. Names of Rest APIs are reasonable, but arguments (such as specific accounts) should not be in the name but rather in the tags.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Parent">
<MemberSignature Language="C#" Value="public System.Diagnostics.Activity Parent { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Diagnostics.Activity Parent" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.Parent" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Parent As Activity" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Diagnostics::Activity ^ Parent { System::Diagnostics::Activity ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Parent : System.Diagnostics.Activity" Usage="System.Diagnostics.Activity.Parent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.Activity</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the parent <see cref="T:System.Diagnostics.Activity" /> that created this activity.</summary>
<value>The parent of this <see cref="T:System.Diagnostics.Activity" />, if it is from the same process, or <see langword="null" /> if this instance has no parent (it is a root activity) or if the parent is from outside the process.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ParentId">
<MemberSignature Language="C#" Value="public string ParentId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ParentId" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.ParentId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ParentId As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ ParentId { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.ParentId : string" Usage="System.Diagnostics.Activity.ParentId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the ID of this activity's parent.</summary>
<value>The parent ID, if one exists, or <see langword="null" /> if it does not.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the parent for this <xref:System.Diagnostics.Activity> comes from outside the process, the <xref:System.Diagnostics.Activity> does not have a parent but *may* have a parent ID (which was deserialized from the parent).
This property value can be `null` if this is a root <xref:System.Diagnostics.Activity> (that is, it has no <xref:System.Diagnostics.Activity.Parent>). For more information, see [ID format](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/ActivityUserGuide.md#id-format).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ParentSpanId">
<MemberSignature Language="C#" Value="public System.Diagnostics.ActivitySpanId ParentSpanId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Diagnostics.ActivitySpanId ParentSpanId" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.ParentSpanId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ParentSpanId As ActivitySpanId" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Diagnostics::ActivitySpanId ParentSpanId { System::Diagnostics::ActivitySpanId get(); };" />
<MemberSignature Language="F#" Value="member this.ParentSpanId : System.Diagnostics.ActivitySpanId" Usage="System.Diagnostics.Activity.ParentSpanId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.ActivitySpanId</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the parent's <see cref="P:System.Diagnostics.Activity.SpanId" />.</summary>
<value>The parent's <see cref="P:System.Diagnostics.Activity.SpanId" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
If the <xref:System.Diagnostics.Activity.ParentId?displayProperty=nameWithType> is in the W3C format, this property returns the <xref:System.Diagnostics.Activity.SpanId> part of the ParentId. Otherwise it returns a zero <xref:System.Diagnostics.Activity.SpanId>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Recorded">
<MemberSignature Language="C#" Value="public bool Recorded { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Recorded" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.Recorded" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Recorded As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool Recorded { bool get(); };" />
<MemberSignature Language="F#" Value="member this.Recorded : bool" Usage="System.Diagnostics.Activity.Recorded" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether the W3CIdFlags.Recorded flag is set.</summary>
<value>
<see langword="true" /> if the W3CIdFlags.Recorded flag is set; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RootId">
<MemberSignature Language="C#" Value="public string RootId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RootId" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.RootId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property RootId As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ RootId { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.RootId : string" Usage="System.Diagnostics.Activity.RootId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the root ID of this <see cref="T:System.Diagnostics.Activity" />.</summary>
<value>The root ID, or <see langword="null" /> if the current instance has either a <see cref="P:System.Diagnostics.Activity.ParentId" /> or an <see cref="P:System.Diagnostics.Activity.Id" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The root ID is a substring from the <xref:System.Diagnostics.Activity.Id> or the <xref:System.Diagnostics.Activity.ParentId>) between '|' (or the beginning) and the first `.`. Filtering by root ID allows you to find all activities involved in operation processing. For more information, see [ID Format](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Diagnostics.DiagnosticSource/src/ActivityUserGuide.md#id-format).
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="SetEndTime">
<MemberSignature Language="C#" Value="public System.Diagnostics.Activity SetEndTime (DateTime endTimeUtc);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Diagnostics.Activity SetEndTime(valuetype System.DateTime endTimeUtc) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Activity.SetEndTime(System.DateTime)" />
<MemberSignature Language="VB.NET" Value="Public Function SetEndTime (endTimeUtc As DateTime) As Activity" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::Diagnostics::Activity ^ SetEndTime(DateTime endTimeUtc);" />
<MemberSignature Language="F#" Value="member this.SetEndTime : DateTime -&gt; System.Diagnostics.Activity" Usage="activity.SetEndTime endTimeUtc" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.Activity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="endTimeUtc" Type="System.DateTime" />
</Parameters>
<Docs>
<param name="endTimeUtc">The UTC stop time.</param>
<summary>Updates the <see cref="T:System.Diagnostics.Activity" /> to set its <see cref="P:System.Diagnostics.Activity.Duration" /> as the difference between <see cref="P:System.Diagnostics.Activity.StartTimeUtc" /> and the specified stop time.</summary>
<returns>
<see langword="this" /> for convenient chaining.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetIdFormat">
<MemberSignature Language="C#" Value="public System.Diagnostics.Activity SetIdFormat (System.Diagnostics.ActivityIdFormat format);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Diagnostics.Activity SetIdFormat(valuetype System.Diagnostics.ActivityIdFormat format) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Activity.SetIdFormat(System.Diagnostics.ActivityIdFormat)" />
<MemberSignature Language="VB.NET" Value="Public Function SetIdFormat (format As ActivityIdFormat) As Activity" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::Diagnostics::Activity ^ SetIdFormat(System::Diagnostics::ActivityIdFormat format);" />
<MemberSignature Language="F#" Value="member this.SetIdFormat : System.Diagnostics.ActivityIdFormat -&gt; System.Diagnostics.Activity" Usage="activity.SetIdFormat format" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.Activity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="format" Type="System.Diagnostics.ActivityIdFormat" Index="0" FrameworkAlternate="netcore-3.0;netcore-3.1" />
</Parameters>
<Docs>
<param name="format">One of the enumeration values that specifies the format of the <see cref="P:System.Diagnostics.Activity.Id" /> property.</param>
<summary>Sets the ID format on this <see cref="T:System.Diagnostics.Activity" /> before it is started.</summary>
<returns>
<see langword="this" /> for convenient chaining.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The specified format will take precedence over `Parent.IdFormat`, the <xref:System.Diagnostics.Activity.ParentId> format, <xref:System.Diagnostics.Activity.DefaultIdFormat>, and <xref:System.Diagnostics.Activity.ForceDefaultIdFormat>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="SetParentId">
<MemberSignature Language="C#" Value="public System.Diagnostics.Activity SetParentId (string parentId);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Diagnostics.Activity SetParentId(string parentId) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Activity.SetParentId(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function SetParentId (parentId As String) As Activity" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::Diagnostics::Activity ^ SetParentId(System::String ^ parentId);" />
<MemberSignature Language="F#" Value="member this.SetParentId : string -&gt; System.Diagnostics.Activity" Usage="activity.SetParentId parentId" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.Activity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="parentId" Type="System.String" />
</Parameters>
<Docs>
<param name="parentId">The ID of the parent operation.</param>
<summary>Updates this <see cref="T:System.Diagnostics.Activity" /> to indicate that the <see cref="T:System.Diagnostics.Activity" /> with an ID of <paramref name="parentId" /> caused this <see cref="T:System.Diagnostics.Activity" />.</summary>
<returns>
<see langword="this" /> for convenient chaining.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property should only be used in 'boundary' scenarios where an <xref:System.Diagnostics.Activity> from another process logically started this <xref:System.Diagnostics.Activity>. The `parentId` brings up the <xref:System.Diagnostics.Activity.Tags> (as well as the <xref:System.Diagnostics.Activity.ParentId> property) and can be used to reconstruct the causal tree.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="SetParentId">
<MemberSignature Language="C#" Value="public System.Diagnostics.Activity SetParentId (System.Diagnostics.ActivityTraceId traceId, System.Diagnostics.ActivitySpanId spanId, System.Diagnostics.ActivityTraceFlags activityTraceFlags = System.Diagnostics.ActivityTraceFlags.None);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Diagnostics.Activity SetParentId(valuetype System.Diagnostics.ActivityTraceId traceId, valuetype System.Diagnostics.ActivitySpanId spanId, valuetype System.Diagnostics.ActivityTraceFlags activityTraceFlags) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Activity.SetParentId(System.Diagnostics.ActivityTraceId,System.Diagnostics.ActivitySpanId,System.Diagnostics.ActivityTraceFlags)" />
<MemberSignature Language="F#" Value="member this.SetParentId : System.Diagnostics.ActivityTraceId * System.Diagnostics.ActivitySpanId * System.Diagnostics.ActivityTraceFlags -&gt; System.Diagnostics.Activity" Usage="activity.SetParentId (traceId, spanId, activityTraceFlags)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.Activity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="traceId" Type="System.Diagnostics.ActivityTraceId" Index="0" FrameworkAlternate="netcore-3.0;netcore-3.1" />
<Parameter Name="spanId" Type="System.Diagnostics.ActivitySpanId" Index="1" FrameworkAlternate="netcore-3.0;netcore-3.1" />
<Parameter Name="activityTraceFlags" Type="System.Diagnostics.ActivityTraceFlags" Index="2" FrameworkAlternate="netcore-3.0;netcore-3.1" />
</Parameters>
<Docs>
<param name="traceId">The parent activity's TraceId.</param>
<param name="spanId">The parent activity's SpanId.</param>
<param name="activityTraceFlags">One of the enumeration values that specifies flags defined by the W3C standard that are associated with an activity.</param>
<summary>Sets the parent ID using the W3C convention of a TraceId and a SpanId.</summary>
<returns>
<see langword="this" /> for convenient chaining.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method has the advantage that no string manipulation is needed to set the ID.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="SetStartTime">
<MemberSignature Language="C#" Value="public System.Diagnostics.Activity SetStartTime (DateTime startTimeUtc);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Diagnostics.Activity SetStartTime(valuetype System.DateTime startTimeUtc) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Activity.SetStartTime(System.DateTime)" />
<MemberSignature Language="VB.NET" Value="Public Function SetStartTime (startTimeUtc As DateTime) As Activity" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::Diagnostics::Activity ^ SetStartTime(DateTime startTimeUtc);" />
<MemberSignature Language="F#" Value="member this.SetStartTime : DateTime -&gt; System.Diagnostics.Activity" Usage="activity.SetStartTime startTimeUtc" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.Activity</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="startTimeUtc" Type="System.DateTime" />
</Parameters>
<Docs>
<param name="startTimeUtc">The <see cref="T:System.Diagnostics.Activity" /> start time in UTC.</param>
<summary>Sets the start time of this <see cref="T:System.Diagnostics.Activity" />.</summary>
<returns>
<see langword="this" /> for convenient chaining.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SpanId">
<MemberSignature Language="C#" Value="public System.Diagnostics.ActivitySpanId SpanId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Diagnostics.ActivitySpanId SpanId" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.SpanId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SpanId As ActivitySpanId" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Diagnostics::ActivitySpanId SpanId { System::Diagnostics::ActivitySpanId get(); };" />
<MemberSignature Language="F#" Value="member this.SpanId : System.Diagnostics.ActivitySpanId" Usage="System.Diagnostics.Activity.SpanId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.ActivitySpanId</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the SPAN part of the <see cref="P:System.Diagnostics.Activity.Id" />.</summary>
<value>The ID for the SPAN part of <see cref="P:System.Diagnostics.Activity.Id" />, if the <see cref="T:System.Diagnostics.Activity" /> has the W3C format; otherwise, a zero <see langword="SpanId" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Start">
<MemberSignature Language="C#" Value="public System.Diagnostics.Activity Start ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Diagnostics.Activity Start() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Activity.Start" />
<MemberSignature Language="VB.NET" Value="Public Function Start () As Activity" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; System::Diagnostics::Activity ^ Start();" />
<MemberSignature Language="F#" Value="member this.Start : unit -&gt; System.Diagnostics.Activity" Usage="activity.Start " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.Activity</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Starts the activity.</summary>
<returns>
<see langword="this" /> for convenient chaining.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Calling the `Start` method does the following:
- Sets <xref:System.Diagnostics.Activity.Parent> to hold <xref:System.Diagnostics.Activity.Current>.
- Sets <xref:System.Diagnostics.Activity.Current> to this <xref:System.Diagnostics.Activity>.
- If <xref:System.Diagnostics.Activity.StartTimeUtc> was not set previously, sets it to <xref:System.DateTime.UtcNow?displayProperty=nameWithType>.
- Generates a unique <xref:System.Diagnostics.Activity.Id> for this activity.</item>
Use <xref:System.Diagnostics.DiagnosticSource.StartActivity%2A?displayProperty=nameWithType> to start the <see cref="T:System.Diagnostics.Activity" /> and write the start event.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="StartTimeUtc">
<MemberSignature Language="C#" Value="public DateTime StartTimeUtc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime StartTimeUtc" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.StartTimeUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StartTimeUtc As DateTime" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property DateTime StartTimeUtc { DateTime get(); };" />
<MemberSignature Language="F#" Value="member this.StartTimeUtc : DateTime" Usage="System.Diagnostics.Activity.StartTimeUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the time when the operation started.</summary>
<value>The UTC time that the operation started.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The `StartTimeUtc` property is typically initialized when <xref:System.Diagnostics.Activity.Start> is called, but it can be set at any time by calling <xref:System.Diagnostics.Activity.SetStartTime%2A>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Stop">
<MemberSignature Language="C#" Value="public void Stop ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Stop() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Activity.Stop" />
<MemberSignature Language="VB.NET" Value="Public Sub Stop ()" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; void Stop();" />
<MemberSignature Language="F#" Value="member this.Stop : unit -&gt; unit" Usage="activity.Stop " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Stops the activity.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This information is NOT passed on to the children of this <xref:System.Diagnostics.Activity>.
Calling the `Stop` method:
- Sets <xref:System.Diagnostics.Activity.Current> to <xref:System.Diagnostics.Activity.Parent>.
- If the end time was not set previously, sets <xref:System.Diagnostics.Activity.Duration> as the difference between <xref:System.DateTime.UtcNow?displayProperty=nameWithType> and <xref:System.Diagnostics.Activity.StartTimeUtc>.
Call <xref:System.Diagnostics.DiagnosticSource.StopActivity%2A?displayProperty=nameWithType> to stop the <xref:System.Diagnostics.Activity> and write the stop event.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Tags">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;string,string&gt;&gt; Tags { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1&lt;valuetype System.Collections.Generic.KeyValuePair`2&lt;string, string&gt;&gt; Tags" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.Tags" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Tags As IEnumerable(Of KeyValuePair(Of String, String))" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Collections::Generic::IEnumerable&lt;System::Collections::Generic::KeyValuePair&lt;System::String ^, System::String ^&gt;&gt; ^ Tags { System::Collections::Generic::IEnumerable&lt;System::Collections::Generic::KeyValuePair&lt;System::String ^, System::String ^&gt;&gt; ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Tags : seq&lt;System.Collections.Generic.KeyValuePair&lt;string, string&gt;&gt;" Usage="System.Diagnostics.Activity.Tags" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.2.1</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable&lt;System.Collections.Generic.KeyValuePair&lt;System.String,System.String&gt;&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a collection of key/value pairs that represent information that will be logged along with the <see cref="T:System.Diagnostics.Activity" /> to the logging system.</summary>
<value>An enumeration of string-string key-value-pairs.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TraceId">
<MemberSignature Language="C#" Value="public System.Diagnostics.ActivityTraceId TraceId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Diagnostics.ActivityTraceId TraceId" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.TraceId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TraceId As ActivityTraceId" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Diagnostics::ActivityTraceId TraceId { System::Diagnostics::ActivityTraceId get(); };" />
<MemberSignature Language="F#" Value="member this.TraceId : System.Diagnostics.ActivityTraceId" Usage="System.Diagnostics.Activity.TraceId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Diagnostics.ActivityTraceId</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the TraceId part of the <see cref="P:System.Diagnostics.Activity.Id" />.</summary>
<value>The ID for the TraceId part of the <see cref="P:System.Diagnostics.Activity.Id" />, if the ID has the W3C format; otherwise, a zero TraceId.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TraceStateString">
<MemberSignature Language="C#" Value="public string TraceStateString { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TraceStateString" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Activity.TraceStateString" />
<MemberSignature Language="VB.NET" Value="Public Property TraceStateString As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ TraceStateString { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="F#" Value="member this.TraceStateString : string with get, set" Usage="System.Diagnostics.Activity.TraceStateString" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>4.0.4.0</AssemblyVersion>
<AssemblyVersion>4.0.5.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the W3C <see langword="tracestate" /> header.</summary>
<value>The W3C <see langword="tracestate" /> header.</value>
<remarks>
<format type="text/markdown"><![CDATA[
The `tracestate` header is intended to carry supplemental information to trace identity contained in the trace parent. `tracestate` consists of a list of key/value pairs that convey information about the request position in multiple distributed tracing graphs. This information is typically used by distributed tracing systems and should not be used for general purpose baggage, since this may break the correlation of a distributed trace.
Logically `TraceStateString` is just a kind of baggage (if flows just like baggage), but because it is expected to be special-cased (it has its own HTTP header), it is more convenient/efficient if it is not lumped in with other baggage.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.