IEnrichmentTagCollector.Add(String, Object) Method

  • Reference

Definition

Namespace:
Microsoft.Extensions.Diagnostics.Enrichment
Assembly:
Microsoft.Extensions.Telemetry.Abstractions.dll
Package:
Microsoft.Extensions.Telemetry.Abstractions v8.10.0
Package:
Microsoft.Extensions.Telemetry.Abstractions v9.0.0-preview.9.24507.7
Source:
IEnrichmentTagCollector.cs
Source:
IEnrichmentTagCollector.cs

Adds a tag in form of a key/value pair.

public:
 void Add(System::String ^ tagName, System::Object ^ tagValue);
public void Add (string tagName, object tagValue);
abstract member Add : string * obj -> unit
Public Sub Add (tagName As String, tagValue As Object)

Parameters

tagName
String

Enrichment property key.

tagValue
Object

Enrichment property value.

Exceptions

ArgumentException

tagName is an empty string.

ArgumentNullException

Either tagName or tagValue is null.

Remarks

For log enrichment, tagValue is serialized as per the rules below:

  • Arrays: Recognized and serialized in a loop.
  • IDictionary: Recognized as IDictionary<string, object> and serialized in a loop.
  • DateTime: Recognized and serialized after converting to ToUniversalTime().
  • All other primitive types: Converted to String as is and serialized.
For metric enrichment, tagValue is converted to String format using ToString() method.

Applies to