Analyzing Performance Toolkit telemetry

APPLIES TO: Business Central 2022 release wave 1 and later

The Performance Toolkit (BCPT) extension is built for Independent Solution Vendors (ISVs) and Value Added Resellers (VARs) who develop vertical solutions and customize Business Central for their customers. Because things change between released versions, it's important that ISVs and VARs can test the performance of their solutions to ensure that new versions don't introduce performance regressions when the volume of users grows. To help, the Performance Toolkit lets developers simulate workloads in realistic scenarios to compare performance between builds of their solutions.

The Performance Toolkit extension helps answer questions such as, "Does my solution for Business Central support X number of users doing this, that, and the other thing at the same time?"

The extension doesn't answer questions such as, "How many orders can Business Central process per hour?"

To gather this data, you'll have to install and implement the Performance Toolkit extension. Learn more in The Performance Toolkit Extension in the Development help.

Telemetry is then logged for the following operations:

  • When the BCPT header has the status Running
  • When the BCPT header has the status Completed
  • When the BCPT header has the status Cancelled
  • When a BCPT operation or scenario is finished

These events use normal verbosity (severityLevel 1) and TelemetryScope::All, including scenario events with an error status.

When the BCPT header has the status running

Occurs when the BCPT header gets the status running.

General dimensions

DimensionDescription or value
messagePerformance Toolkit run started.
severityLevel1

Custom dimensions

DimensionDescription or value
eventIdAL0000DHR
alRunIDNumber from the BCPT header.
alCodeCode from the BCPT Header.
alCurrentRunTypeValues are BCPT and PRT. BCPT runs all the sessions and PRT runs only one iteration.
alVersionVersion number of the BCPT Header.
alSessionCountTotal number of all sessions.
alTest Company NameCompany where the BCPT is performed.

Common custom dimensions

The following table explains other custom dimensions that are common to all Performance Toolkit traces.

DimensionDescription or value
aadTenantIdSpecifies the Microsoft Entra tenant ID used for Microsoft Entra authentication. For on-premises, if you aren't using Microsoft Entra authentication, this value is common.
alDataClassificationSystemMetadata
componentDynamics 365 Business Central Server.
componentVersionSpecifies the version number of the component that emits telemetry (see the component dimension.)
deprecatedKeysWhen present, lists deprecated dimension keys. We recommend that you update queries to use the new key names.
environmentNameSpecifies the name of the tenant environment. Learn more in Managing Environments. This dimension isn't included for Business Central on-premises environments.
environmentTypeSpecifies the environment type for the tenant, such as Production, Sandbox, Trial. Learn more in Environment Types.
extensionNameSpecifies the name of the Performance Toolkit extension.
extensionIdSpecifies the ID of the Performance Toolkit extension.
extensionPublisherSpecifies the publisher of the extension.
extensionVersionSpecifies the version of the Performance Toolkit extension.
telemetrySchemaVersionSpecifies the version of the Business Central telemetry schema.

When the BCPT header has the status completed

Occurs when the BCPT header gets the status completed.

DimensionDescription or value
messagePerformance Toolkit run finished.
severityLevel1

Custom dimensions

DimensionDescription or value
eventIdAL0000DHS
alRunIDNumber from the BCPT header.
alCodeSpecified the code from the BCPT Header.
alCurrentRunTypeValues are BCPT and PRT. BCPT for running all the sessions and PRT for only one iteration.
alDurationInMinutesSpecified the total duration in minutes of the run.
alVersionSpecified the version number of the BCPT Header.
alSessionCountSpecified the total number of all sessions.
alTest Company NameSpecified the company where the BCPT is performed.

Common custom dimensions

The following table explains other custom dimensions that are common to all Performance Toolkit traces.

DimensionDescription or value
aadTenantIdSpecifies the Microsoft Entra tenant ID used for Microsoft Entra authentication. For on-premises, if you aren't using Microsoft Entra authentication, this value is common.
alDataClassificationSystemMetadata
componentDynamics 365 Business Central Server.
componentVersionSpecifies the version number of the component that emits telemetry (see the component dimension.)
deprecatedKeysWhen present, lists deprecated dimension keys. We recommend that you update queries to use the new key names.
environmentNameSpecifies the name of the tenant environment. Learn more in Managing Environments. This dimension isn't included for Business Central on-premises environments.
environmentTypeSpecifies the environment type for the tenant, such as Production, Sandbox, Trial. Learn more in Environment Types.
extensionNameSpecifies the name of the Performance Toolkit extension.
extensionIdSpecifies the ID of the Performance Toolkit extension.
extensionPublisherSpecifies the publisher of the extension.
extensionVersionSpecifies the version of the Performance Toolkit extension.
telemetrySchemaVersionSpecifies the version of the Business Central telemetry schema.

When the BCPT header has the status cancelled

Occurs when the BCPT header gets the status cancelled.

DimensionDescription or value
messagePerformance Toolkit run cancelled.
severityLevel1

Custom dimensions

DimensionDescription or value
eventIdAL0000DHT
alRunIDSpecified the number from the BCPT header.
alCodeSpecified the code from the BCPT Header.
alCurrentRunTypeValues are BCPT and PRT. BCPT for running all the sessions and PRT for only one iteration.
alVersionSpecified the version number of the BCPT Header.
alSessionCountSpecified the total number of all sessions.
alTest Company NameSpecified the company where the BCPT is performed.

Common custom dimensions

The following table explains other custom dimensions that are common to all Performance Toolkit traces.

DimensionDescription or value
aadTenantIdSpecifies the Microsoft Entra tenant ID used for Microsoft Entra authentication. For on-premises, if you aren't using Microsoft Entra authentication, this value is common.
alDataClassificationSystemMetadata
componentDynamics 365 Business Central Server.
componentVersionSpecifies the version number of the component that emits telemetry (see the component dimension.)
deprecatedKeysWhen present, lists deprecated dimension keys. We recommend that you update queries to use the new key names.
environmentNameSpecifies the name of the tenant environment. Learn more in Managing Environments. This dimension isn't included for Business Central on-premises environments.
environmentTypeSpecifies the environment type for the tenant, such as Production, Sandbox, Trial. Learn more in Environment Types.
extensionNameSpecifies the name of the Performance Toolkit extension.
extensionIdSpecifies the ID of the Performance Toolkit extension.
extensionPublisherSpecifies the publisher of the extension.
extensionVersionSpecifies the version of the Performance Toolkit extension.
telemetrySchemaVersionSpecifies the version of the Business Central telemetry schema.

When a BCPT scenario is finished

Occurs when a BCPT operation or scenario is finished and a log entry is written.

DimensionDescription or value
messagePerformance Toolkit - {BCPT Header code} - {Scenario label} - {BCPT log entry status}
severityLevel1

Custom dimensions

DimensionDescription or value
eventIdAL0000DGF
alRunIDSpecified the number from the BCPT header.
alCodeSpecified the code from the BCPT Header.
alLineNoSpecifies the BCPT configuration line number associated with the log entry.
alVersionSpecifies the version number recorded in the BCPT log entry.
alCodeunitIdSpecified the codeunit ID of the scenario that is executed.
alCodeunitNameSpecified the codeunit name of the scenario that is executed.
alOperationSpecifies the operation name recorded in the log entry.
alTagSpecified the tag from the BCPT header.
alStatusSpecified the status of the BCPT log Entry. This can be success or error.
alStackTraceSpecifies the error call stack. Included only when the log entry has an error status.
alMessageSpecifies the message recorded in the log entry.
alNoOfSqlStatementsSpecified the number of SQL statements that is executed during the operation.
alStartTimeSpecified the starting time when the operation is executed.
alEndTimeSpecified the ending time when the operation is executed.
alDurationInMsSpecified the total duration in milliseconds that the operation is executed.
alSessionNoSpecified the session number of the executed operation.

The scenario label in the message is Scenario in English and can be localized. It isn't the codeunit or operation name. Use alCodeunitName and alOperation to identify the work being measured.

Common custom dimensions

The following table explains other custom dimensions that are common to all Performance Toolkit traces.

DimensionDescription or value
aadTenantIdSpecifies the Microsoft Entra tenant ID used for Microsoft Entra authentication. For on-premises, if you aren't using Microsoft Entra authentication, this value is common.
alDataClassificationSystemMetadata
componentDynamics 365 Business Central Server.
componentVersionSpecifies the version number of the component that emits telemetry (see the component dimension.)
deprecatedKeysWhen present, lists deprecated dimension keys. We recommend that you update queries to use the new key names.
environmentNameSpecifies the name of the tenant environment. Learn more in Managing Environments. This dimension isn't included for Business Central on-premises environments.
environmentTypeSpecifies the environment type for the tenant, such as Production, Sandbox, Trial. Learn more in Environment Types.
extensionNameSpecifies the name of the Performance Toolkit extension.
extensionIdSpecifies the ID of the Performance Toolkit extension.
extensionPublisherSpecifies the publisher of the extension.
extensionVersionSpecifies the version of the Performance Toolkit extension.
telemetrySchemaVersionSpecifies the version of the Business Central telemetry schema.

Monitoring and Analyzing Telemetry
Enable Sending Telemetry to Application Insights