DiagnosticsTelemetryModule.AddHeartbeatProperty Method

Reference

Definition

Namespace:: Microsoft.ApplicationInsights.Extensibility.Implementation.Tracing

Assembly:: Microsoft.ApplicationInsights.dll

Package:: Microsoft.ApplicationInsights v2.21.0

Package:: Microsoft.ApplicationInsights v2.22.0-beta2

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.

Add a new Heartbeat property to the payload sent with each heartbeat.

To update the value of the property you are adding to the heartbeat, SetHeartbeatProperty(String, String, Nullable<Boolean>).

Note that you cannot add a HeartbeatProperty with a name that already exists in the Heartbeat payload, including (but not limited to) the name of SDK-default items.

public bool AddHeartbeatProperty (string propertyName, string propertyValue, bool isHealthy);

abstract member AddHeartbeatProperty : string * string * bool -> bool
override this.AddHeartbeatProperty : string * string * bool -> bool

Public Function AddHeartbeatProperty (propertyName As String, propertyValue As String, isHealthy As Boolean) As Boolean

Parameters

propertyName: String

Name of the heartbeat value to add.

propertyValue: String

Current value of the heartbeat value to add.

isHealthy: Boolean

Flag indicating whether or not the property represents a healthy value.

Returns

Boolean

True if the new payload item is successfully added, false otherwise.

Implements

AddHeartbeatProperty(String, String, Boolean)

Applies to

Share via