Interface IApplicationInsightsTelemetryClient

Represents an interface of the Insights telemetry client component.

Namespace: Relativity.Testing.Framework

Assembly: Relativity.Testing.Framework.dll

Syntax

public interface IApplicationInsightsTelemetryClient

Properties

Instance

Gets instance of TelemetryClient.

Declaration

TelemetryClient Instance { get; }

Property Value

Type	Description
TelemetryClient

Methods

Flush()

Flushes TelemetryClient.

Declaration

void Flush()

TrackEvent(String, Dictionary<String, String>)

Sends an arbitrary event to the configured telemetry client.

Declaration

void TrackEvent(string metricName, Dictionary<string, string> properties)

Parameters

Type	Name	Description
System.String	metricName	The name of the event being sent.
System.Collections.Generic.Dictionary<System.String, System.String>	properties	A related dictionary of properties to associate with the event.

TrackEvent(String, Dictionary<String, String>, Dictionary<String, Double>)

Sends an arbitrary event with related metrics to the configured telemetry client.

Declaration

void TrackEvent(string metricName, Dictionary<string, string> properties, Dictionary<string, double> metrics)

Parameters

Type	Name	Description
System.String	metricName	The name of the event being sent.
System.Collections.Generic.Dictionary<System.String, System.String>	properties	A related dictionary of properties to associate with the event.
System.Collections.Generic.Dictionary<System.String, System.Double>	metrics	A relevant set of metrics associated with the event.

TrackException(Exception)

Sends an exception to the configured telemetry client.

Declaration

void TrackException(Exception ex)

Parameters

Type	Name	Description
System.Exception	ex	The exception that occurred.

TrackException(Exception, Dictionary<String, String>)

Sends an exception to the configured telemetry client with extra information.

Declaration

void TrackException(Exception ex, Dictionary<string, string> properties)

Parameters

Type	Name	Description
System.Exception	ex	The exception that occurred.
System.Collections.Generic.Dictionary<System.String, System.String>	properties	A related dictionary of properties to associate with the exception.

TrackMetric(String, Double, Dictionary<String, String>)

Sends a metric value to the configured telemetry client.

Declaration

void TrackMetric(string metricName, double metricValue, Dictionary<string, string> properties)

Parameters

Type	Name	Description
System.String	metricName	The name of the metric being sent.
System.Double	metricValue	An individual metric value.
System.Collections.Generic.Dictionary<System.String, System.String>	properties	A related dictionary of properties to associate with the metric.