Class Telemetry

Provides methods and properties for managing telemetry tracking in Syncfusion applications.

Inheritance

System.Object

Telemetry

Namespace: Syncfusion.Telemetry

Assembly: Syncfusion.Telemetry.dll

Syntax

public static class Telemetry : Object

Properties

IsTelemetryEnabled

Gets or sets a value indicating whether telemetry tracking is enabled.

Declaration

public static bool IsTelemetryEnabled { get; set; }

Property Value

Type	Description
System.Boolean	true if telemetry is enabled; otherwise, false. The default value is true.

Methods

Disable()

Disables telemetry tracking for the application.

Declaration

public static void Disable()

Remarks

When called, this method sets IsTelemetryEnabled to false, preventing any further telemetry data from being collected or sent.

Examples

The following example demonstrates how to disable telemetry:

Telemetry.Disable();

Shutdown()

Shuts down the telemetry client and releases all resources.

Declaration

public static void Shutdown()

Remarks

This method disposes the current Syncfusion.Telemetry.TelemetryClient instance and sets it to null. This method is thread-safe.

TrackComponent(ComponentName, TelemetryOptions)

Tracks the usage of a component in the application.

Declaration

public static void TrackComponent(ComponentName componentName, TelemetryOptions options)

Parameters

Type	Name	Description
ComponentName	componentName	The name of the component being tracked.
TelemetryOptions	options

Remarks

This method records when a specific component is used and automatically flushes the telemetry data asynchronously after tracking. Exceptions during tracking or flushing are silently caught and ignored.

TrackFeature(String, ComponentName, TelemetryOptions)

Tracks the usage of a feature in the application.

Declaration

public static void TrackFeature(string featureName, ComponentName componentName, TelemetryOptions options)

Parameters

Type	Name	Description
System.String	featureName	The name of the feature being tracked.
ComponentName	componentName	The component associated with the feature.
TelemetryOptions	options	The telemetry options to configure the client.

Remarks

This method records when a specific feature is used. Exceptions during tracking are silently caught and ignored.