Telemetry Configuration

Important

Telemetry Configuration is currently in PREVIEW.

Configuration information to establish a connection with the database for telemetry collection.

Note

TelemetryConfig is available in SDK version >= 1.3.0.

public class TelemetryConfig

Constructors

Name Description
TelemetryConfig(TokenProvider, EnvironmentType, string, bool)
tokenProvider: The user-defined token provider.
ingestAtLevel: Kusto ingestion security level for the execution environment.
region: Optional geographic information, e.g. "West US".
Initializes a new instance of the TelemetryConfig class with a user-defined implementation of the TokenProvider interface.
removeUserContent: Optional flag allowing CDM telemetry client to ingest user generated content (for example filenames)
TelemetryConfig(string, string, string, string, string, EnvironmentType, string, AzureCloudInstance, bool)
tenantId: Azure AD tenant (directory) ID.
clientId: The client ID of the AAD application accessing Kusto.
secret: The client secret of the AAD application accessing Kusto.
clusterName: Kusto cluster into which the telemetry will be ingested.
databaseName: Kusto database name.
ingestAtLevel: Kusto ingestion security level for the execution environment.
region: Optional geographic information, for example "West US".
cloudInstance: Optional Azure cloud instance, default to be AzureCloudInstance.AzurePublic.
Initializes a new instance of the TelemetryConfig class with client ID/secret authentication and default log table names.
removeUserContent: Optional flag allowing CDM telemetry client to ingest user generated content (for example filenames)
TelemetryConfig(string, string, string, string, string, string, string, string, EnvironmentType, string, AzureCloudInstance, bool)
tenantId: Azure AD tenant (directory) ID.
clientId: The client ID of the AAD application accessing Kusto.
secret: The client secret of the AAD application accessing Kusto.
clusterName: Kusto cluster into which the telemetry will be ingested.
databaseName: Kusto database name.
infoTable: Table for storing informational logs.
warningTable: Table for storing warning logs.
errorTable: Table for storing error logs.
ingestAtLevel: Kusto ingestion security level for the execution environment.
region: Optional geographic information, for example "West US".
cloudInstance: Optional Azure cloud instance, default to be AzureCloudInstance.AzurePublic.
Initializes a new instance of the TelemetryConfig class with client ID/secret authentication and custom log table names.
removeUserContent: Optional flag allowing CDM telemetry client to ingest user generated content (for example filenames)

Properties

Name Type Description
TenantId string Azure AD tenant (directory) ID.
ClientId string The client ID of the AAD application.
Secret string The client secret of the AAD application.
Region string User geographic info.
KustoClusterName string Kusto (ADX) cluster name.
KustoDatabaseName string Kusto database name.
KustoInfoLogTable string Kusto table for informational logs, default to be infoLogs.
KustoWarningLogTable string Kusto table for warning logs, default to be warningLogs.
KustoErrorLogTable string Kusto table for error logs, default to be errorLogs.
CloudInstance AzureCloudInstance The Azure cloud instance.
IngestAtLevel EnvironmentType The level of detail to be logged into the Kusto database depending on the environment.
Token Provider TokenProvider The token provider used to dynamically generate the access token.