Class TelemetryClient

Namespace

Microsoft.ApplicationInsights

Assembly

Microsoft.ApplicationInsights.dll

public sealed class TelemetryClient

Inheritance

object

TelemetryClient

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

TelemetryClientExtensions.GetMetricManager(TelemetryClient, MetricAggregationScope)

LogDispatcher.GetCurrentClassLogger(object)

LogDispatcher.GetCurrentClassLogger(object)

LogDispatcher.GetCurrentClassLogger(object)

LogDispatcher.GetCurrentClassLogger(object)

LogDispatcher.GetCurrentClassLogger(object)

LogDispatcher.GetCurrentClassLogger(object)

LogDispatcher.GetCurrentClassLogger(object)

LogDispatcher.GetCurrentClassLogger(object)

LogDispatcher.GetCurrentClassLogger(object)

LogDispatcher.GetCurrentClassLogger(object)

LogDispatcher.GetCurrentClassLogger(object)

LogDispatcher.GetCurrentClassLogger(object)

Constructors

TelemetryClient()

[Obsolete("We do not recommend using TelemetryConfiguration.Active on .NET Core. See https://github.com/microsoft/ApplicationInsights-dotnet/issues/1152 for more details")]
public TelemetryClient()

TelemetryClient(TelemetryConfiguration)

public TelemetryClient(TelemetryConfiguration configuration)

Parameters

configuration TelemetryConfiguration

Properties

Context

public TelemetryContext Context { get; }

Property Value

TelemetryContext

InstrumentationKey

public string InstrumentationKey { get; set; }

Property Value

string

Methods

Flush()

public void Flush()

FlushAsync(CancellationToken)

public Task<bool> FlushAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<bool>

GetMetric(MetricIdentifier)

public Metric GetMetric(MetricIdentifier metricIdentifier)

Parameters

metricIdentifier MetricIdentifier

Returns

Metric

GetMetric(MetricIdentifier, MetricConfiguration)

public Metric GetMetric(MetricIdentifier metricIdentifier, MetricConfiguration metricConfiguration)

Parameters

metricIdentifier MetricIdentifier

metricConfiguration MetricConfiguration

Returns

Metric

GetMetric(MetricIdentifier, MetricConfiguration, MetricAggregationScope)

public Metric GetMetric(MetricIdentifier metricIdentifier, MetricConfiguration metricConfiguration, MetricAggregationScope aggregationScope)

Parameters

metricIdentifier MetricIdentifier

metricConfiguration MetricConfiguration

aggregationScope MetricAggregationScope

Returns

Metric

GetMetric(string)

public Metric GetMetric(string metricId)

Parameters

metricId string

Returns

Metric

GetMetric(string, MetricConfiguration)

public Metric GetMetric(string metricId, MetricConfiguration metricConfiguration)

Parameters

metricId string

metricConfiguration MetricConfiguration

Returns

Metric

GetMetric(string, MetricConfiguration, MetricAggregationScope)

public Metric GetMetric(string metricId, MetricConfiguration metricConfiguration, MetricAggregationScope aggregationScope)

Parameters

metricId string

metricConfiguration MetricConfiguration

aggregationScope MetricAggregationScope

Returns

Metric

GetMetric(string, string)

public Metric GetMetric(string metricId, string dimension1Name)

Parameters

metricId string

dimension1Name string

Returns

Metric

GetMetric(string, string, MetricConfiguration)

public Metric GetMetric(string metricId, string dimension1Name, MetricConfiguration metricConfiguration)

Parameters

metricId string

dimension1Name string

metricConfiguration MetricConfiguration

Returns

Metric

GetMetric(string, string, MetricConfiguration, MetricAggregationScope)

public Metric GetMetric(string metricId, string dimension1Name, MetricConfiguration metricConfiguration, MetricAggregationScope aggregationScope)

Parameters

metricId string

dimension1Name string

metricConfiguration MetricConfiguration

aggregationScope MetricAggregationScope

Returns

Metric

GetMetric(string, string, string)

public Metric GetMetric(string metricId, string dimension1Name, string dimension2Name)

Parameters

metricId string

dimension1Name string

dimension2Name string

Returns

Metric

GetMetric(string, string, string, MetricConfiguration)

public Metric GetMetric(string metricId, string dimension1Name, string dimension2Name, MetricConfiguration metricConfiguration)

Parameters

metricId string

dimension1Name string

dimension2Name string

metricConfiguration MetricConfiguration

Returns

Metric

GetMetric(string, string, string, MetricConfiguration, MetricAggregationScope)

public Metric GetMetric(string metricId, string dimension1Name, string dimension2Name, MetricConfiguration metricConfiguration, MetricAggregationScope aggregationScope)

Parameters

metricId string

dimension1Name string

dimension2Name string

metricConfiguration MetricConfiguration

aggregationScope MetricAggregationScope

Returns

Metric

GetMetric(string, string, string, string)

public Metric GetMetric(string metricId, string dimension1Name, string dimension2Name, string dimension3Name)

Parameters

metricId string

dimension1Name string

dimension2Name string

dimension3Name string

Returns

Metric

GetMetric(string, string, string, string, MetricConfiguration)

public Metric GetMetric(string metricId, string dimension1Name, string dimension2Name, string dimension3Name, MetricConfiguration metricConfiguration)

Parameters

metricId string

dimension1Name string

dimension2Name string

dimension3Name string

metricConfiguration MetricConfiguration

Returns

Metric

GetMetric(string, string, string, string, MetricConfiguration, MetricAggregationScope)

public Metric GetMetric(string metricId, string dimension1Name, string dimension2Name, string dimension3Name, MetricConfiguration metricConfiguration, MetricAggregationScope aggregationScope)

Parameters

metricId string

dimension1Name string

dimension2Name string

dimension3Name string

metricConfiguration MetricConfiguration

aggregationScope MetricAggregationScope

Returns

Metric

GetMetric(string, string, string, string, string)

public Metric GetMetric(string metricId, string dimension1Name, string dimension2Name, string dimension3Name, string dimension4Name)

Parameters

metricId string

dimension1Name string

dimension2Name string

dimension3Name string

dimension4Name string

Returns

Metric

GetMetric(string, string, string, string, string, MetricConfiguration)

public Metric GetMetric(string metricId, string dimension1Name, string dimension2Name, string dimension3Name, string dimension4Name, MetricConfiguration metricConfiguration)

Parameters

metricId string

dimension1Name string

dimension2Name string

dimension3Name string

dimension4Name string

metricConfiguration MetricConfiguration

Returns

Metric

GetMetric(string, string, string, string, string, MetricConfiguration, MetricAggregationScope)

public Metric GetMetric(string metricId, string dimension1Name, string dimension2Name, string dimension3Name, string dimension4Name, MetricConfiguration metricConfiguration, MetricAggregationScope aggregationScope)

Parameters

metricId string

dimension1Name string

dimension2Name string

dimension3Name string

dimension4Name string

metricConfiguration MetricConfiguration

aggregationScope MetricAggregationScope

Returns

Metric

IsEnabled()

public bool IsEnabled()

Returns

bool

TrackAvailability(AvailabilityTelemetry)

public void TrackAvailability(AvailabilityTelemetry telemetry)

Parameters

telemetry AvailabilityTelemetry

TrackAvailability(string, DateTimeOffset, TimeSpan, string, bool, string, IDictionary<string, string>, IDictionary<string, double>)

public void TrackAvailability(string name, DateTimeOffset timeStamp, TimeSpan duration, string runLocation, bool success, string message = null, IDictionary<string, string> properties = null, IDictionary<string, double> metrics = null)

Parameters

name string

timeStamp DateTimeOffset

duration TimeSpan

runLocation string

success bool

message string

properties IDictionary<string, string>

metrics IDictionary<string, double>

TrackDependency(DependencyTelemetry)

public void TrackDependency(DependencyTelemetry telemetry)

Parameters

telemetry DependencyTelemetry

TrackDependency(string, string, DateTimeOffset, TimeSpan, bool)

[Obsolete("Please use a different overload of TrackDependency")]
public void TrackDependency(string dependencyName, string data, DateTimeOffset startTime, TimeSpan duration, bool success)

Parameters

dependencyName string

data string

startTime DateTimeOffset

duration TimeSpan

success bool

TrackDependency(string, string, string, DateTimeOffset, TimeSpan, bool)

public void TrackDependency(string dependencyTypeName, string dependencyName, string data, DateTimeOffset startTime, TimeSpan duration, bool success)

Parameters

dependencyTypeName string

dependencyName string

data string

startTime DateTimeOffset

duration TimeSpan

success bool

TrackDependency(string, string, string, string, DateTimeOffset, TimeSpan, string, bool)

public void TrackDependency(string dependencyTypeName, string target, string dependencyName, string data, DateTimeOffset startTime, TimeSpan duration, string resultCode, bool success)

Parameters

dependencyTypeName string

target string

dependencyName string

data string

startTime DateTimeOffset

duration TimeSpan

resultCode string

success bool

TrackEvent(EventTelemetry)

public void TrackEvent(EventTelemetry telemetry)

Parameters

telemetry EventTelemetry

TrackEvent(string, IDictionary<string, string>, IDictionary<string, double>)

public void TrackEvent(string eventName, IDictionary<string, string> properties = null, IDictionary<string, double> metrics = null)

Parameters

eventName string

properties IDictionary<string, string>

metrics IDictionary<string, double>

TrackException(ExceptionTelemetry)

public void TrackException(ExceptionTelemetry telemetry)

Parameters

telemetry ExceptionTelemetry

TrackException(Exception, IDictionary<string, string>, IDictionary<string, double>)

public void TrackException(Exception exception, IDictionary<string, string> properties = null, IDictionary<string, double> metrics = null)

Parameters

exception Exception

properties IDictionary<string, string>

metrics IDictionary<string, double>

TrackMetric(MetricTelemetry)

public void TrackMetric(MetricTelemetry telemetry)

Parameters

telemetry MetricTelemetry

TrackMetric(string, double, IDictionary<string, string>)

public void TrackMetric(string name, double value, IDictionary<string, string> properties = null)

Parameters

name string

value double

properties IDictionary<string, string>

TrackPageView(PageViewTelemetry)

public void TrackPageView(PageViewTelemetry telemetry)

Parameters

telemetry PageViewTelemetry

TrackPageView(string)

public void TrackPageView(string name)

Parameters

name string

TrackRequest(RequestTelemetry)

public void TrackRequest(RequestTelemetry request)

Parameters

request RequestTelemetry

TrackRequest(string, DateTimeOffset, TimeSpan, string, bool)

public void TrackRequest(string name, DateTimeOffset startTime, TimeSpan duration, string responseCode, bool success)

Parameters

name string

startTime DateTimeOffset

duration TimeSpan

responseCode string

success bool

TrackTrace(TraceTelemetry)

public void TrackTrace(TraceTelemetry telemetry)

Parameters

telemetry TraceTelemetry

TrackTrace(string)

public void TrackTrace(string message)

Parameters

message string

TrackTrace(string, SeverityLevel)

public void TrackTrace(string message, SeverityLevel severityLevel)

Parameters

message string

severityLevel SeverityLevel

TrackTrace(string, SeverityLevel, IDictionary<string, string>)

public void TrackTrace(string message, SeverityLevel severityLevel, IDictionary<string, string> properties)

Parameters

message string

severityLevel SeverityLevel

properties IDictionary<string, string>

TrackTrace(string, IDictionary<string, string>)

public void TrackTrace(string message, IDictionary<string, string> properties)

Parameters

message string

properties IDictionary<string, string>