<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: Microsoft SQL Sensor
Important Notice |
---|
This sensor type is outdated. We strongly recommend that you use the Microsoft SQL v2 Sensor instead. This is a new sensor type to monitor databases on Microsoft SQL servers. |
The Microsoft SQL sensor monitors a Microsoft Structured Query Language (SQL) server. It shows the response time, the number of records, and the value. The sensor can monitor if the database server accepts connections, processes requests, and returns an expected result when executing a custom SQL command.
The following SQL servers are supported: SQL Server 2008, SQL Server 2005 (including SQL Server Express / Server Compact Editions), SQL Server 2000, SQL Server 7 and MSDE (requires OLE DB installed on the machine running the PRTG probe that accesses the server)
The Add Sensor dialog appears when adding a new sensor on a device manually. It only shows the setting fields that are imperative for creating the sensor. Therefore, you will not see all setting fields in this dialog. You can change (nearly) all settings in the sensor's Settings tab later.
On the details page of a sensor, click on the Settings tab to change its settings.
Note: Usually, a sensor connects to the IP Address or DNS Name of the parent device on which you created this sensor. See the Device Settings for details. For some sensor types, you can define the monitoring target explicitly in the sensor settings. Please see below for details on available settings.
Basic Sensor Settings |
|
---|---|
Sensor Name |
Enter a meaningful name to identify the sensor. By default, PRTG shows this name in the device tree, as well as in alarms, logs, notifications, reports, maps, libraries, and tickets. |
Parent Tags |
Shows Tags that this sensor inherits from its parent device, group, and probe. This setting is shown for your information only and cannot be changed here. |
Tags |
Enter one or more Tags, separated by space or comma. You can use tags to group sensors and use tag–filtered views later on. Tags are not case sensitive. We recommend that you use the default value. You can add additional tags to it, if you like. Other tags are automatically inherited from objects further up in the device tree. These are visible above as Parent Tags. |
Priority |
Select a priority for the sensor. This setting determines where the sensor is placed in sensor lists. Top priority is at the top of a list. Choose from one star (low priority) to five stars (top priority). |
SQL-Server Specific Data |
|
---|---|
Timeout (sec.) |
Enter a timeout in seconds for the request. If the reply takes longer than this value the request is aborted and an error message is triggered. |
Instance |
Enter the SQL server instance's name if you want to connect to a "named instance". For example, such an instance's name could be SQLEXPRESS. Note: Sometimes you will see connection strings like SQLSERVER\SQLINSTANCE in database clients. The first part is the server name configured under the general server settings. The second part refers to the instance name mentioned above. Never enter this complete string in this PRTG form, merely provide the second part (without the backslash). Please enter a string or leave the field empty. |
Port |
Define the port for the SQL connection. Choose between:
|
Port |
This field is only visible if manual port selection is enabled above. Define the port number for the SQL connection. Please enter an integer value. |
Database |
|
---|---|
Database |
Enter the name of the SQL database the sensor will connect to. For example, such a database's name could be Northwind |
Authentication |
Define the kind of authentication used for the connection to the database. Choose between:
|
User |
This field is only visible if SQL server authentication is enabled above. Enter the username that will be used for the database connection. |
Password |
This field is only visible if SQL server authentication is enabled above. Enter the password that will be used for the database connection. |
Data |
|
---|---|
SQL Expression |
Enter a valid SQL statement to execute on the server. In your SELECT statement, please specify the field name explicitly. Do not use SELECT *! For example, a correct expression could be: SELECT ProductName FROM Northwind.dbo.Products. When a cursor is returned (i.e. with a SELECT statement), only the first row of data will be processed. Note: Executing stored procedures is currently not supported. |
Record Count |
If you want to know how many records in your database were affected by your SQL expression as defined above, you can count the number of concerned records. Choose between:
|
Post-Processing |
If the SQL expression returns a result set, define if you want to further process it. Choose between:
|
Condition "Warning" |
This field is only visible if you enable numeric results processing above. Define a condition of the returned numeric SQL result set that sets the sensor to a Warning status. Choose between:
Note: This threshold check the SQL result set only. You can set additional thresholds in the sensor's channel settings. |
Value |
This field is only visible if you enable numeric results processing above. Enter a value of the returned numeric SQL result set that sets the sensor into a Warning status. Please enter an integer or float value. |
Condition "Down" |
This field is only visible if you enable numeric results processing above. Define a condition of the returned numeric SQL result set that sets the sensor to a Down status. Choose between:
Note: This threshold check the SQL result set only. You can set additional thresholds in the sensor's channel settings. |
Value |
This field is only visible if you enable numeric results processing above. Enter a value of the returned numeric SQL result set that sets the sensor to a Down status. Please enter an integer value. |
Response Must Include |
This field is only visible if you enable string results processing above. Enter a string that must be part of the returned SQL string. If this is not the case, the sensor will show a Down status. Please enter a string or leave the field empty. |
Response Must Not include |
This field is only visible if you enable string results processing above. Enter a string that must not be part of the returned SQL string. If this is the case, the sensor will show a Down status. Please enter a string or leave the field empty. |
Sensor Display |
|
---|---|
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 will always be displayed below the sensor's name. The available options depend on what channels are available for this sensor. Note: You can set another primary channel later by clicking on the pin symbol of a channel in the sensor's Overview tab. |
Chart Type |
Define how different channels will be shown for this sensor.
|
Stack Unit |
This setting is only available if stacked graphs are selected above. Choose a unit from the list. All channels with this unit will be 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. |
By default, all following settings are inherited from objects higher in the hierarchy and should be changed there, if necessary. Often, best practice is to change them centrally in the Root group's settings. To change a setting only for this object, disable inheritance by clicking on the check mark before the corresponding setting name. You will then see the options described below.
Scanning Interval |
|
---|---|
Scanning Interval |
Select a scanning interval (seconds, minutes, or hours) from the list. The scanning interval determines the time the sensor waits between two scans. You can change the available intervals in the system administration. |
When a Sensor Reports an Error |
Define the number of scanning intervals that a sensor has time to report an error before the sensor will be set to a Down status. The sensor can try to reach a device several times, depending on the setup you can specify here, to help avoid false alarms if the monitored device has only temporary issues. For previous scanning intervals with failed requests, the sensor will show a Warning status. Choose between:
Note: Sensors that monitor via Windows Management Instrumentation (WMI) always wait at least one scanning interval until they show an error. It is not possible to set a WMI sensor "down" immediately, so the first option will not apply to these sensor types (all other options can apply). Note: If a sensor has defined error limits for channels, this sensor will always be set to a Down status immediately, so no "wait" option will apply. Note: If a channel uses lookup values, the sensor will always be set to a Down status immediately, so no "wait" options will apply. |
Schedules, Dependencies, and Maintenance Window |
|
---|---|
Note: Inheritance for schedules, dependencies, and maintenance windows cannot be interrupted. The corresponding settings from the parent objects will always be active. However, you can define additional settings here. They will be active at the same time as the parent objects' settings. |
|
Schedule |
Select a schedule from the list. Schedules can be used to monitor for a certain time span (days, hours) throughout the week. With the period list option it is also possible to pause monitoring for a specific time span. You can create new schedules and edit existing ones in the account settings. Note: Schedules are generally inherited. New schedules will be added to existing ones, so all schedules are active at the same time. |
Maintenance Window |
Specify if you want to set-up a one-time maintenance window. During a "maintenance window" period, this object and all child objects will not be monitored. They will be in a paused state instead. Choose between:
Note: To terminate a current maintenance window before the defined end date, you can change the time in Maintenance End At field to a date in the past. |
Maintenance Begins At |
This field is only visible if you enabled the maintenance window above. Use the date time picker to enter the start date and time of the maintenance window. |
Maintenance End At |
This field is only visible if you enabled the maintenance window above. Use the date time picker to enter the end date and time of the maintenance window. |
Dependency Type |
Define a dependency type. Dependencies can be used to pause monitoring for an object depending on the status of another. You can choose between:
Note: Testing your dependencies is easy! Simply choose Simulate Error Status from the context menu of an object that other objects depend on. A few seconds later all dependent objects should be paused. You can check all dependencies in your PRTG installation by selecting Devices | Dependencies from the main menu bar. |
Dependency |
This field is only visible if the Select object option is enabled above. Click on the reading-glasses and use the object selector to choose an object on which the current sensor will depend. |
Delay (Seconds) |
Define a time span. After the master object for this dependency comes back to an Up status, the beginning of the monitoring of the depending objects will be additionally delayed by the time span you define here. This can help to avoid false alarms, for example, after a server restart, by giving systems more time for all services to start up. Please enter an integer value in seconds. Note: This setting is not available if you choose this sensor to be the Master object for parent. In this case, please define delays in the parent Device Settings or in the superior Group Settings. |
Access Rights |
|
---|---|
User Group Access |
Define which user group(s) will have access to the object you're editing. A table with user groups and types of access rights is shown: It contains all user groups from your setup. For each user group you can choose from the following access rights:
You can create new user groups in the System Administration—User Groups settings. To automatically set all objects further down in the hierarchy to inherit this object's access rights, set a check mark for the Revert children's access rights to inherited option. For more details on access rights, please see the section User Access Rights. |
To change display settings, spike filter, and limits, switch to the sensor's Overview tab and click the gear icon of a specific channel. For detailed information, please see the Sensor Channels Settings section.
Click the Notifications tab to change notification triggers. For detailed information, please see the Sensor Notifications Settings section.
For more general information about settings, please see the Object Settings section.
For information about sensor settings, please see the following sections:
Keywords: