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.
The following table lists the metrics available for the Microsoft.Synapse/workspaces 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.
- Advanced platform metrics - A premium, paid tier of platform metrics in Azure Monitor that provide more granular observability for Azure resources.
- 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,
PT1Mindicates that the metric is sampled every minute,PT30Mevery 30 minutes,PT1Hevery hour, and so on. - DS Export -S Whether the metric is exportable to Azure Monitor Logs via Diagnostic Settings.
For information on exporting metrics, see - Metrics export using data collection rules and Create diagnostic settings in Azure Monitor.
For information on metric retention, see Azure Monitor Metrics overview.
For a list of supported logs, see Supported log categories - Microsoft.Synapse/workspaces
Category: Built-in SQL Pool
| Metric | Name in REST API | Advanced platform metrics | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| Data processed (bytes) Amount of data processed by queries |
BuiltinSqlPoolDataProcessedBytes |
No | Bytes | Total (Sum) | <none> | PT1M | No |
| Login attempts Count of login attempts that succeded or failed |
BuiltinSqlPoolLoginAttempts |
No | Count | Average, Minimum, Maximum, Total (Sum) | Result |
PT1M | No |
| Requests ended Count of Requests that succeeded, failed, or were cancelled |
BuiltinSqlPoolRequestsEnded |
No | Count | Average, Minimum, Maximum, Total (Sum) | Result |
PT1M | No |
Category: Integration
| Metric | Name in REST API | Advanced platform metrics | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| Activity runs ended Count of integration activities that succeeded, failed, or were cancelled |
IntegrationActivityRunsEnded |
No | Count | Count, Total (Sum) | Result, FailureType, Activity, ActivityType, Pipeline |
PT1M, PT1H | No |
| Link connection events Number of Synapse Link connection events including start, stop and failure. |
IntegrationLinkConnectionEvents |
No | Count | Total (Sum) | EventType, LinkConnectionName |
PT1M | No |
| Link processed rows Changed row count processed by Synapse Link. |
IntegrationLinkProcessedChangedRows |
No | Count | Total (Sum) | TableName, LinkConnectionName |
PT1M | No |
| Link processed data volume (bytes) Data volume in bytes processed by Synapse Link. |
IntegrationLinkProcessedDataVolume |
No | Bytes | Total (Sum) | TableName, LinkTableStatus, LinkConnectionName |
PT1M | No |
| Link latency in seconds Synapse Link data processing latency in seconds. |
IntegrationLinkProcessingLatencyInSeconds |
No | Count | Maximum, Minimum, Average | LinkConnectionName |
PT1M | No |
| Link table events Number of Synapse Link table events including snapshot, removal and failure. |
IntegrationLinkTableEvents |
No | Count | Total (Sum) | TableName, EventType, LinkConnectionName |
PT1M | No |
| Pipeline runs ended Count of integration pipeline runs that succeeded, failed, or were cancelled |
IntegrationPipelineRunsEnded |
No | Count | Count, Total (Sum) | Result, FailureType, Pipeline |
PT1M, PT1H | No |
| Trigger Runs ended Count of integration triggers that succeeded, failed, or were cancelled |
IntegrationTriggerRunsEnded |
No | Count | Count, Total (Sum) | Result, FailureType, Trigger |
PT1M, PT1H | No |
Category: Streaming job
| Metric | Name in REST API | Advanced platform metrics | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| Backlogged input events (preview) This is a preview metric available in East US, West Europe. Number of input events sources backlogged. |
SQLStreamingBackloggedInputEventSources |
No | Count | Total (Sum) | SQLPoolName, SQLDatabaseName, JobName, LogicalName, PartitionId, ProcessorInstance |
PT1M | No |
| Data conversion errors (preview) This is a preview metric available in East US, West Europe. Number of output events that could not be converted to the expected output schema. Error policy can be changed to 'Drop' to drop events that encounter this scenario. |
SQLStreamingConversionErrors |
No | Count | Total (Sum) | SQLPoolName, SQLDatabaseName, JobName, LogicalName, PartitionId, ProcessorInstance |
PT1M | No |
| Input deserialization errors (preview) This is a preview metric available in East US, West Europe. Number of input events that could not be deserialized. |
SQLStreamingDeserializationError |
No | Count | Total (Sum) | SQLPoolName, SQLDatabaseName, JobName, LogicalName, PartitionId, ProcessorInstance |
PT1M | No |
| Early input events (preview) This is a preview metric available in East US, West Europe. Number of input events which application time is considered early compared to arrival time, according to early arrival policy. |
SQLStreamingEarlyInputEvents |
No | Count | Total (Sum) | SQLPoolName, SQLDatabaseName, JobName, LogicalName, PartitionId, ProcessorInstance |
PT1M | No |
| Input event bytes (preview) This is a preview metric available in East US, West Europe. Amount of data received by the streaming job, in bytes. This can be used to validate that events are being sent to the input source. |
SQLStreamingInputEventBytes |
No | Count | Total (Sum) | SQLPoolName, SQLDatabaseName, JobName, LogicalName, PartitionId, ProcessorInstance |
PT1M | No |
| Input events (preview) This is a preview metric available in East US, West Europe. Number of input events. |
SQLStreamingInputEvents |
No | Count | Total (Sum) | SQLPoolName, SQLDatabaseName, JobName, LogicalName, PartitionId, ProcessorInstance |
PT1M | No |
| Input sources received (preview) This is a preview metric available in East US, West Europe. Number of input events sources per second. |
SQLStreamingInputEventsSourcesPerSecond |
No | Count | Total (Sum) | SQLPoolName, SQLDatabaseName, JobName, LogicalName, PartitionId, ProcessorInstance |
PT1M | No |
| Late input events (preview) This is a preview metric available in East US, West Europe. Number of input events which application time is considered late compared to arrival time, according to late arrival policy. |
SQLStreamingLateInputEvents |
No | Count | Total (Sum) | SQLPoolName, SQLDatabaseName, JobName, LogicalName, PartitionId, ProcessorInstance |
PT1M | No |
| Out of order events (preview) This is a preview metric available in East US, West Europe. Number of Event Hub Events (serialized messages) received by the Event Hub Input Adapter, received out of order that were either dropped or given an adjusted timestamp, based on the Event Ordering Policy. |
SQLStreamingOutOfOrderEvents |
No | Count | Total (Sum) | SQLPoolName, SQLDatabaseName, JobName, LogicalName, PartitionId, ProcessorInstance |
PT1M | No |
| Output events (preview) This is a preview metric available in East US, West Europe. Number of output events. |
SQLStreamingOutputEvents |
No | Count | Total (Sum) | SQLPoolName, SQLDatabaseName, JobName, LogicalName, PartitionId, ProcessorInstance |
PT1M | No |
| Watermark delay (preview) This is a preview metric available in East US, West Europe. Output watermark delay in seconds. |
SQLStreamingOutputWatermarkDelaySeconds |
No | Count | Maximum, Minimum, Average | SQLPoolName, SQLDatabaseName, JobName, LogicalName, PartitionId, ProcessorInstance |
PT1M | No |
| Resource % utilization (preview) This is a preview metric available in East US, West Europe. Resource utilization expressed as a percentage. High utilization indicates that the job is using close to the maximum allocated resources. |
SQLStreamingResourceUtilization |
No | Percent | Maximum, Minimum, Average | SQLPoolName, SQLDatabaseName, JobName, LogicalName, PartitionId, ProcessorInstance |
PT1M | No |
| Runtime errors (preview) This is a preview metric available in East US, West Europe. Total number of errors related to query processing (excluding errors found while ingesting events or outputting results). |
SQLStreamingRuntimeErrors |
No | Count | Total (Sum) | SQLPoolName, SQLDatabaseName, JobName, LogicalName, PartitionId, ProcessorInstance |
PT1M | No |