Activity.AddBaggage(String, String) Method

Reference

Definition

Namespace:: System.Diagnostics

Assembly:: System.Diagnostics.DiagnosticSource.dll

Source:: Activity.cs

Source:: Activity.cs

Source:: Activity.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Updates the Activity to have a new baggage item with the specified key and value.

public:
 System::Diagnostics::Activity ^ AddBaggage(System::String ^ key, System::String ^ value);

public System.Diagnostics.Activity AddBaggage (string key, string? value);

public System.Diagnostics.Activity AddBaggage (string key, string value);

member this.AddBaggage : string * string -> System.Diagnostics.Activity

Public Function AddBaggage (key As String, value As String) As Activity

Parameters

key: String

The baggage key.

value: String

The baggage value.

Returns

Activity

this for convenient chaining.

Remarks

This key/value pair is included in the collection returned by the Baggage property, and can also be retrieved by the GetBaggageItem 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 Activity, use the Tags property.

Applies to