Power BI Embedded monitoring data reference
This article contains all the monitoring reference information for this service.
See Monitor Power BI Embedded for details on the data you can collect for Power BI Embedded and how to use it.
Tip
Use the Microsoft Fabric Capacity Metrics app to monitor your capacity.
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.PowerBIDedicated/capacities
The following table lists the metrics available for the Microsoft.PowerBIDedicated/capacities 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,
PT1Mindicates that the metric is sampled every minute,PT30Mevery 30 minutes,PT1Hevery 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 |
|---|---|---|---|---|---|---|
| CPU (Gen2) CPU Utilization. Supported only for Power BI Embedded Generation 2 resources. |
cpu_metric |
Percent | Average | <none> | PT1M | Yes |
| Overload (Gen2) Resource Overload, 1 if resource is overloaded, otherwise 0. Supported only for Power BI Embedded Generation 2 resources. |
overload_metric |
Count | Average | <none> | PT1M | Yes |
This table provides additional information about the preceding table.
| Name | Metric | Description |
|---|---|---|
| CPU | cpu_metric | CPU utilization. |
| CPU Per Workload | cpu_workload_metric | CPU utilization per workload. |
| Overload | overload_metric | Resource overload, 1 if resource is overloaded, otherwise 0. |
Metric dimensions
For information about what metric dimensions are, see Multi-dimensional metrics.
This service doesn't have any metrics that contain dimensions.
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.PowerBIDedicated/capacities
| Category | Category display name | Log table | Supports basic log plan | Supports ingestion-time transformation | Example queries | Costs to export |
|---|---|---|---|---|---|---|
Engine |
Engine | AzureDiagnostics Logs from multiple Azure resources. |
No | No | No |
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.
Power BI Embedded Microsoft.PowerBIDedicated/capacities
| Table | Description |
|---|---|
| AzureActivity | Entries from the Azure Activity log that provides insight into any subscription-level or management group level events that occurred in Azure. |
| AzureMetrics | Stores resource logs for Azure services that use Azure Diagnostics mode. Resource logs describe the internal operation of Azure resources. |
| AzureDiagnostics | Metric data emitted by Azure services that measure their health and performance. |
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.
You can select Engine and the AllMetrics categories or either.
Engine
The engine category instructs the resource to log the events listed in the following table. For each event, there are properties.
| Event Name | Event Description |
|---|---|
| Audit Login | Records all new connection to the engine events since the trace started. |
| Session Initialize | Records all session initialization events since the trace started. |
| Vertipaq Query Begin | Records all VertiPaq SE query begin events since the trace started. |
| Query Begin | Records all query begin events since the trace started. |
| Query End | Records all query end events since the trace started. |
| Vertipaq Query End | Records all VertiPaq SE query end events since the trace started. |
| Audit Logout | Records all disconnect from engine events since the trace started. |
| Error | Records all engine error events since the trace started. |
Event example
The following table shows an event example.
| Property Name | Vertipaq Query End Example | Property Description |
|---|---|---|
| EventClass | XM_SEQUERY_END | Event Class is used to categorize events. |
| EventSubclass | 0 | Event Subclass provides additional information about each event class. (for example, 0: VertiPaq Scan) |
| RootActivityId | ff217fd2-611d-43c0-9c12-19e202a94f70 | Root activity ID. |
| CurrentTime | 2018-04-06T18:30:11.9137358Z | Time at which the event started when available. |
| StartTime | 2018-04-06T18:30:11.9137358Z | Time at which the event started when available. |
| JobID | 0 | Job ID for progress. |
| ObjectID | 464 | Object ID |
| ObjectType | 802012 | ObjectType |
| EndTime | 2018-04-06T18:30:11.9137358Z | Time at which the event ended. |
| Duration | 0 | Amount of time (in milliseconds) taken by the event. |
| SessionType | User | Session type (what entity caused the operation). |
| ProgressTotal | 0 | Progress total. |
| IntegerData | 0 | Integer data. |
| Severity | 0 | Severity level of an exception. |
| Success | 1 | 1 = success. 0 = failure. For example, a 1 means success of a permissions check and a 0 means a failure of that check. |
| Error | 0 | Error number of a given event. |
| ConnectionID | 3 | Unique connection ID. |
| DatasetID | 5eaa550e-06ac-4adf-aba9-dbf0e8fd1527 | ID of the semantic model in which the statement of the user is running. |
| SessionID | 3D063F66-A111-48EE-B960-141DEBDA8951 | Session GUID. |
| SPID | 180 | Server process ID. This process ID uniquely identifies a user session. This ID directly corresponds to the session GUID used by XML/A. |
| ClientProcessID | null | The process ID of the client application. |
| ApplicationName | null | Name of the client application that created the connection to the server. |
| CapacityName | pbi641fb41260f84aa2b778a85891ae2d97 | The name of the Power BI Embedded capacity resource. |
AllMetrics
Checking the AllMetrics option logs the data of all the metrics that you can use with a Power BI Embedded resource.
The following table lists the operations related to Power BI Embedded that might appear in the Activity log.
Schemas
Power BI Embedded uses the Power BI Dedicated schema.
Example script for scaling a capacity
To scale a capacity resource, you can use the ScaleUp-Automation-RunBook.ps1 PowerShell RunBook script.
The script uses Power BI and Azure Resource Manager REST APIs that are called in Azure Automation and triggered by Azure alert.
You can either copy the script, or download it as part of the PowerBI-Developer-Samples repository, by selecting the green code button, and downloading the ZIP.
Related content
- See Monitor Power BI Embedded for a description of monitoring Power BI Embedded.
- See Monitor Azure resources with Azure Monitor for details on monitoring Azure resources.