Share via

Azure AI Bot Service monitoring data reference

  • Article

This article contains all the monitoring reference information for this service.

See Monitor Azure AI Bot Service for details on the data you can collect for Azure AI Bot Service and how to use it.

Metrics

This section lists all the automatically collected platform metrics for this service. These metrics are also part of the global list of all platform metrics supported in Azure Monitor.

For information on metric retention, see Azure Monitor Metrics overview.

Supported metrics for microsoft.botservice/botservices

The following table lists the metrics available for the microsoft.botservice/botservices resource type.

  • All columns might not be present in every table.
  • Some columns might be beyond the viewing area of the page. Select Expand table to view all available columns.

Table headings

  • Category - The metrics group or classification.
  • Metric - The metric display name as it appears in the Azure portal.
  • Name in REST API - The metric name as referred to in the REST API.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average (Avg), Minimum (Min), Maximum (Max), Total (Sum), Count.
  • Dimensions - Dimensions available for the metric.
  • Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export- Whether the metric is exportable to Azure Monitor Logs via diagnostic settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.
Category Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Latency Request Latency

Time taken by the server to process the request		 RequestLatency Milliseconds Total Operation, Authentication, Protocol, DataCenter PT1M Yes
Traffic Requests Traffic

Number of Requests Made		 RequestsTraffic Percent Count Operation, Authentication, Protocol, StatusCode, StatusCodeClass, DataCenter PT1M Yes

Supported metrics for Microsoft.BotService/botServices/channels

The following table lists the metrics available for the Microsoft.BotService/botServices/channels resource type.

  • All columns might not be present in every table.
  • Some columns might be beyond the viewing area of the page. Select Expand table to view all available columns.

Table headings

  • Category - The metrics group or classification.
  • Metric - The metric display name as it appears in the Azure portal.
  • Name in REST API - The metric name as referred to in the REST API.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average (Avg), Minimum (Min), Maximum (Max), Total (Sum), Count.
  • Dimensions - Dimensions available for the metric.
  • Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export- Whether the metric is exportable to Azure Monitor Logs via diagnostic settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.
Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Requests Latencies

How long it takes to get request response		 RequestLatency Milliseconds Average Operation, Authentication, Protocol, ResourceId, Region PT1M Yes
Requests Traffic

Number of requests within a given period of time		 RequestsTraffic Count Average Operation, Authentication, Protocol, ResourceId, Region, StatusCode, StatusCodeClass, StatusText PT1M Yes

Supported metrics for Microsoft.BotService/botServices/connections

The following table lists the metrics available for the Microsoft.BotService/botServices/connections resource type.

  • All columns might not be present in every table.
  • Some columns might be beyond the viewing area of the page. Select Expand table to view all available columns.

Table headings

  • Category - The metrics group or classification.
  • Metric - The metric display name as it appears in the Azure portal.
  • Name in REST API - The metric name as referred to in the REST API.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average (Avg), Minimum (Min), Maximum (Max), Total (Sum), Count.
  • Dimensions - Dimensions available for the metric.
  • Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export- Whether the metric is exportable to Azure Monitor Logs via diagnostic settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.
Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Requests Latencies

How long it takes to get request response		 RequestLatency Milliseconds Average Operation, Authentication, Protocol, ResourceId, Region PT1M Yes
Requests Traffic

Number of requests within a given period of time		 RequestsTraffic Count Average Operation, Authentication, Protocol, ResourceId, Region, StatusCode, StatusCodeClass, StatusText PT1M Yes

Supported metrics for Microsoft.BotService/checknameavailability

The following table lists the metrics available for the Microsoft.BotService/checknameavailability resource type.

  • All columns might not be present in every table.
  • Some columns might be beyond the viewing area of the page. Select Expand table to view all available columns.

Table headings

  • Category - The metrics group or classification.
  • Metric - The metric display name as it appears in the Azure portal.
  • Name in REST API - The metric name as referred to in the REST API.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average (Avg), Minimum (Min), Maximum (Max), Total (Sum), Count.
  • Dimensions - Dimensions available for the metric.
  • Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export- Whether the metric is exportable to Azure Monitor Logs via diagnostic settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.
Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Requests Latencies

How long it takes to get request response		 RequestLatency Milliseconds Average Operation, Authentication, Protocol, ResourceId, Region PT1M Yes
Requests Traffic

Number of requests within a given period of time		 RequestsTraffic Count Average Operation, Authentication, Protocol, ResourceId, Region, StatusCode, StatusCodeClass, StatusText PT1M Yes

Supported metrics for Microsoft.BotService/hostsettings

The following table lists the metrics available for the Microsoft.BotService/hostsettings resource type.

  • All columns might not be present in every table.
  • Some columns might be beyond the viewing area of the page. Select Expand table to view all available columns.

Table headings

  • Category - The metrics group or classification.
  • Metric - The metric display name as it appears in the Azure portal.
  • Name in REST API - The metric name as referred to in the REST API.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average (Avg), Minimum (Min), Maximum (Max), Total (Sum), Count.
  • Dimensions - Dimensions available for the metric.
  • Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export- Whether the metric is exportable to Azure Monitor Logs via diagnostic settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.
Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Requests Latencies

How long it takes to get request response		 RequestLatency Milliseconds Average Operation, Authentication, Protocol, ResourceId, Region PT1M Yes
Requests Traffic

Number of requests within a given period of time		 RequestsTraffic Count Average Operation, Authentication, Protocol, ResourceId, Region, StatusCode, StatusCodeClass, StatusText PT1M Yes

Supported metrics for Microsoft.BotService/listauthserviceproviders

The following table lists the metrics available for the Microsoft.BotService/listauthserviceproviders resource type.

  • All columns might not be present in every table.
  • Some columns might be beyond the viewing area of the page. Select Expand table to view all available columns.

Table headings

  • Category - The metrics group or classification.
  • Metric - The metric display name as it appears in the Azure portal.
  • Name in REST API - The metric name as referred to in the REST API.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average (Avg), Minimum (Min), Maximum (Max), Total (Sum), Count.
  • Dimensions - Dimensions available for the metric.
  • Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export- Whether the metric is exportable to Azure Monitor Logs via diagnostic settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.
Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Requests Latencies

How long it takes to get request response		 RequestLatency Milliseconds Average Operation, Authentication, Protocol, ResourceId, Region PT1M Yes
Requests Traffic

Number of requests within a given period of time		 RequestsTraffic Count Average Operation, Authentication, Protocol, ResourceId, Region, StatusCode, StatusCodeClass, StatusText PT1M Yes

Supported metrics for Microsoft.BotService/listqnamakerendpointkeys

The following table lists the metrics available for the Microsoft.BotService/listqnamakerendpointkeys resource type.

  • All columns might not be present in every table.
  • Some columns might be beyond the viewing area of the page. Select Expand table to view all available columns.

Table headings

  • Category - The metrics group or classification.
  • Metric - The metric display name as it appears in the Azure portal.
  • Name in REST API - The metric name as referred to in the REST API.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average (Avg), Minimum (Min), Maximum (Max), Total (Sum), Count.
  • Dimensions - Dimensions available for the metric.
  • Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export- Whether the metric is exportable to Azure Monitor Logs via diagnostic settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.
Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Requests Latencies

How long it takes to get request response		 RequestLatency Milliseconds Average Operation, Authentication, Protocol, ResourceId, Region PT1M Yes
Requests Traffic

Number of requests within a given period of time		 RequestsTraffic Count Average Operation, Authentication, Protocol, ResourceId, Region, StatusCode, StatusCodeClass, StatusText PT1M Yes

Metric dimensions

For information about what metric dimensions are, see Multi-dimensional metrics.

This service has the following dimensions associated with its metrics.

The Dimensions columns in the preceding metrics tables list the dimensions associated with Bot Service metrics.

Resource logs

This section lists the types of resource logs you can collect for this service. The section pulls from the list of all resource logs category types supported in Azure Monitor.

Supported resource logs for microsoft.botservice/botservices

Category Category display name Log table Supports basic log plan Supports ingestion-time transformation Example queries Costs to export
BotRequest Requests from the channels to the bot ABSBotRequests

Logs of requests made by Azure Bot Service onbehalf of a bot such as requests from channel to bot and to other dependencies.

 No Yes Queries Yes

Azure Monitor Logs tables

This section lists the Azure Monitor Logs tables relevant to this service, which are available for query by Log Analytics using Kusto queries. The tables contain resource log data and possibly more depending on what is collected and routed to them.

Bot Services

Microsoft.BotService/botServices

Activity log

The linked table lists the operations that can be recorded in the activity log for this service. These operations are a subset of all the possible resource provider operations in the activity log.

For more information on the schema of activity log entries, see Activity Log schema.

Other schemas

The following schemas are in use for this service.

For a listing of the most common fields that bots log telemetry data into, see Schema of bot analytics instrumentation.

Related content