PRTG Manual: Microsoft Azure SQL Database Sensor

The Microsoft Azure SQL Database sensor monitors the metrics of an Azure SQL Database (single database or elastic pool) in a Microsoft Azure subscription.

Microsoft Azure SQL Database Sensor

Microsoft Azure SQL Database Sensor

i_square_cyanFor a detailed list and descriptions of the channels that this sensor can show, see section Channel List.

Sensor in Other Languages

  • Dutch: Microsoft Azure SQL Database
  • French: Microsoft Azure SQL Database
  • German: Microsoft Azure SQL Database
  • Japanese: Microsoft Azure SQL Database
  • Portuguese: Microsoft Azure SQL Database
  • Russian: Microsoft Azure SQL Database
  • Simplified Chinese: Microsoft Azure SQL Database
  • Spanish: Microsoft Azure SQL Database

Remarks

Detailed Requirements

Requirement

Description

Permissions for the Azure custom role

This sensor requires an Azure custom role with specific permissions. Create an Azure custom role and add permissions for the following actions:

  • "Microsoft.Sql/servers/*/read",
  • "Microsoft.Insights/Metrics/providers/Metrics/Read",
  • "Microsoft.Insights/Metrics/Microsoft.Insights/Read",
  • "Microsoft.Insights/Metrics/Read",
  • "Microsoft.Insights/Metricnamespaces/Read",
  • "Microsoft.Insights/MetricDefinitions/providers/Microsoft.Insights/Read",
  • "Microsoft.Insights/Components/providers/Microsoft.Insights/MetricDefinitions/Read"

i_square_cyanFor more information, see the Knowledge Base: How do I obtain credentials and create custom roles for the Microsoft Azure sensors?

Add Sensor

The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the settings that are required to create the sensor. You can change nearly all settings on the sensor's Settings tab after creation.

i_round_blueThe settings that you select in the Add Sensor dialog are valid for all sensors that you create when you finish the dialog.

Microsoft Azure Specific

Setting

Description

Azure SQL Databases

You see a list of all Azure SQL Databases that are available in the monitored Microsoft Azure subscription. All databases are listed by database name, server name, resource type, region, purchase model, and elastic pool name.

i_round_blueEnable check boxes in front of the respective lines to select the items. Use the check box in the table header to select all items or to cancel the selection. In large tables, use the search function in the upper-right corner.

Basic Sensor Settings

Click the Settings tab of a sensor to change its settings.

Basic Sensor Settings

Basic Sensor Settings

Setting

Description

Sensor Name

Enter a name to identify the sensor.

Parent Tags

Shows tags that the sensor inherits from its parent device, parent group, and parent probe.

i_round_blueThis setting is for your information only. You cannot change it.

Tags

Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited.

i_round_blueIt is not possible to enter tags with a leading plus (+) or minus (-) sign, nor tags with parentheses (()) or angle brackets (<>).

i_round_blueFor performance reasons, it can take some minutes until you can filter for new tags that you added.

The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:

  • microsoftazure
  • microsoftazuresqldatabase
  • azure

Priority

Select a priority for the sensor. This setting determines the position of the sensor in lists. The highest priority is at the top of a list. Choose from the lowest priority (i_priority_1) to the highest priority (i_priority_5).

i_round_blueUsually, a sensor connects to the IP Address/DNS Name of the parent device. See the device settings for details. For some sensors, you can explicitly define the monitoring target in the sensor settings.

Microsoft Azure Specific

Microsoft Azure Specific

Microsoft Azure Specific

Setting

Description

Azure SQL Database Name

Shows the name of the Azure SQL Database that this sensor monitors.

i_round_blueIf you change the database name in your Microsoft Azure subscription, you need to add the sensor anew.

Azure SQL Database ID

Shows the ID of the Azure SQL Database that this sensor monitors.

Azure SQL Server Name

Shows the name of the Azure SQL server that hosts the Azure SQL Database.

Resource Type

Shows the resource type of the Azure SQL Database that this sensor monitors. This can be a single database or an elastic pool in a virtual core (vCore) based purchasing model or a DTU-based purchasing model.

i_round_blueIf you change the resource type in your Microsoft Azure subscription, you need to add the sensor anew.

Region

Shows the Azure region of the Azure SQL Database that this sensor monitors.

Purchasing Model

Shows the purchasing model of the Azure SQL Database. This can be vCore based or DTU based.

Elastic Pool

Shows the name of the elastic pool if the resource type of the Azure SQL Database is an elastic pool. If the resource type is not an elastic pool, the field shows n/a.

Sensor Display

Sensor Display

Sensor Display

Setting

Description

Primary Channel

Select a channel from the list to define it as the primary channel. In the device tree, the last value of the primary channel is always displayed below the sensor's name. The available options depend on what channels are available for this sensor.

i_round_blueYou can set a different primary channel later by clicking b_channel_primary below a channel gauge on the sensor's Overview tab.

Graph Type

Define how different channels are shown for this sensor:

  • Show channels independently (default): Show a graph for each channel.
  • Stack channels on top of each other: Stack channels on top of each other to create a multi-channel graph. This generates a graph that visualizes the different components of your total traffic.
    i_round_redYou cannot use this option in combination with manual Vertical Axis Scaling (available in the channel settings).

Stack Unit

This setting is only visible if you enable Stack channels on top of each other as Graph Type. Select a unit from the list. All channels with this unit are stacked on top of each other. By default, you cannot exclude single channels from stacking if they use the selected unit. However, there is an advanced procedure to do so.

Debug Options

Debug Options

Debug Options

Setting

Description

Result Handling

Define what PRTG does with the sensor result:

  • Discard result: Do not store the sensor result.
  • Store result: Store the last sensor result in the \Logs\sensors subfolder of the PRTG data directory on the probe system. The file name is Result of Sensor [ID].log. This setting is for debugging purposes. PRTG overwrites this file with each scanning interval.

i_podThis option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance.

i_round_blueIn a cluster, PRTG stores the result in the PRTG data directory of the master node.

Inherited Settings

By default, all of these settings are inherited from objects that are higher in the hierarchy. We recommend that you change them centrally in the root group settings if necessary. To change a setting for this object only, click b_inherited_enabled under the corresponding setting name to disable the inheritance and to display its options.

i_square_cyanFor more information, see section Inheritance of Settings.

Scanning Interval

i_round_blueThe minimum scanning interval of this sensor is 1 minute.

i_round_blueThe recommended scanning interval of this sensor is 5 minutes.

Scanning Interval

Scanning Interval

i_square_cyanFor more information, see section Root Group Settings, section Scanning Interval.

Schedules, Dependencies, and Maintenance Window

i_round_blueYou cannot interrupt the inheritance for schedules, dependencies, and maintenance windows. The corresponding settings from the parent objects are always active. However, you can define additional schedules, dependencies, and maintenance windows. They are active at the same time as the parent objects' settings.

Schedules, Dependencies, and Maintenance Window

Schedules, Dependencies, and Maintenance Window

i_square_cyanFor more information, see section Root Group Settings, section Schedules, Dependencies, and Maintenance Window.

Access Rights

Access Rights

Access Rights

i_square_cyanFor more information, see section Root Group Settings, section Access Rights.

Channel Unit Configuration

i_round_blueWhich channel units are available depends on the sensor type and the available parameters. If no configurable channels are available, this field shows No configurable channels.

Channel Unit Configuration

Channel Unit Configuration

i_square_cyanFor more information, see section Root Group Settings, section Channel Unit Configuration.

Channel List

i_round_blueWhich channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.

Channel

Description

Connections Failed

The number of failed connections

CPU Used %

The CPU usage in percent

i_round_blueThis channel is the primary channel by default.

Data I/O %

The data input/output (I/O) operations in percent

Data Space Used

The data space usage in bytes

Data Space Used %

The data space usage in percent

Deadlocks

The number of deadlocks

Downtime

In the channel table on the Overview tab, this channel never shows any values. PRTG uses this channel in graphs and reports to show the amount of time in which the sensor was in the Down status in percent.

DTU %

The Database Transaction Units (DTUs) in percent

DTU Limit

The DTU limit

DTU Used

The used DTU

eDTU Limit

The elastic Database Transaction Unit (eDTU) limit

eDTU Used

The used eDTU

Log I/O

The log I/O operations in percent

Sessions %

The sessions in percent

More

i_square_blueKnowledge Base

How do I obtain credentials and create custom roles for the Microsoft Azure sensors?

What security features does PRTG include?