Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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.
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.
The following table lists the metrics available for the microsoft.botservice/botservices resource type.
Table headings
- Metric - The metric display name as it appears in the Azure portal.
- Name in Rest API - Metric name as referred to in the REST API.
- Unit - Unit of measure.
- Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, 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 |
---|---|---|---|---|---|---|
Request Latency Time taken by the server to process the request |
RequestLatency |
Milliseconds | Total (Sum) | Operation , Authentication , Protocol , DataCenter |
PT1M | Yes |
Metric | Name in REST API | Unit | Aggregation | Dimensions | Time Grains | DS Export |
---|---|---|---|---|---|---|
Requests Traffic Number of Requests Made |
RequestsTraffic |
Percent | Count | Operation , Authentication , Protocol , StatusCode , StatusCodeClass , DataCenter |
PT1M | Yes |
The following table lists the metrics available for the Microsoft.BotService/botServices/channels resource type.
Table headings
- Metric - The metric display name as it appears in the Azure portal.
- Name in Rest API - Metric name as referred to in the REST API.
- Unit - Unit of measure.
- Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, 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 |
The following table lists the metrics available for the Microsoft.BotService/botServices/connections resource type.
Table headings
- Metric - The metric display name as it appears in the Azure portal.
- Name in Rest API - Metric name as referred to in the REST API.
- Unit - Unit of measure.
- Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, 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 |
The following table lists the metrics available for the Microsoft.BotService/checknameavailability resource type.
Table headings
- Metric - The metric display name as it appears in the Azure portal.
- Name in Rest API - Metric name as referred to in the REST API.
- Unit - Unit of measure.
- Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, 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 |
The following table lists the metrics available for the Microsoft.BotService/hostsettings resource type.
Table headings
- Metric - The metric display name as it appears in the Azure portal.
- Name in Rest API - Metric name as referred to in the REST API.
- Unit - Unit of measure.
- Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, 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 |
The following table lists the metrics available for the Microsoft.BotService/listauthserviceproviders resource type.
Table headings
- Metric - The metric display name as it appears in the Azure portal.
- Name in Rest API - Metric name as referred to in the REST API.
- Unit - Unit of measure.
- Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, 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 |
The following table lists the metrics available for the Microsoft.BotService/listqnamakerendpointkeys resource type.
Table headings
- Metric - The metric display name as it appears in the Azure portal.
- Name in Rest API - Metric name as referred to in the REST API.
- Unit - Unit of measure.
- Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, 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 |
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.
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.
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 |
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.
Microsoft.BotService/botServices
The linked table lists the operations that may be recorded in the activity log for this service. This is 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.
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.
- See Monitor Bot Service for a description of monitoring Bot Service.
- See Monitor Azure resources with Azure Monitor for details on monitoring Azure resources.