PRTG Manual: MySQL Sensor
The MySQL sensor monitors a MySQL server. It connects to the server and shows the response time. Additionally, it can read the number of records and a value.
The following SQL servers are supported: MySQL server 5.1, 5.0, 4.1, 4.0, and 3.23
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 all settings in the sensor's Settings tab later.
On the sensor's details page, click on the Settings tab to change settings.
Note: If not set explicitly in a sensor's settings, it will connect to the IP Address or DNS Name defined in the settings of the parent device the sensor is created on.
Basic Sensor Settings |
|
---|---|
Sensor Name |
Enter a meaningful name to identify the sensor. The name will be shown by default in the device tree and in all alarms. |
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 using 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. Those are not visible here. |
Priority |
Select a priority for the sensor. This setting determines where the sensor will be placed in sensor lists. Top priority will be at the top of a list. You can choose from one star (low priority) to five stars (top priority). |
MySQL Server Specific Data |
|
---|---|
Port |
Define the port for the SQL connection. Choose between:
|
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. |
DB/SQL Data |
|
---|---|
Database |
Enter the name of the SQL database the sensor will connect to. For example, such a database's name could be MyDatabase. This is a logical entity on the database server where database objects like tables or stored procedures exist. In case of the mySQL server it also reflects a physical directory structure where your database objects are stored. Enter the appropriate string which is the same as you would supply when invoking the mysql.exe admin tool (with the command line switch -p) or after the login with mysql.exe with the command use. |
User |
Enter the user name that will be used for the database connection. |
Password |
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 AVG(UnitPrice) FROM Products. When a cursor is returned (i.e. with a SELECT statement), only the first row of data will be processed. |
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, please define if you want to further process it. Choose between:
|
Condition "Warning" |
This field is only visible if numeric results is enabled above. Define a condition of the returned numeric SQL result set that will set 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 numeric results is enabled above. Enter a value of the returned numeric SQL result set that will set the sensor into a Warning status. Please enter an integer or float value. |
Condition "Down" |
This field is only visible if numeric results is enabled above. Define a condition of the returned numeric SQL result set that will set 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 numeric results is enabled above. Enter a value of the returned numeric SQL result set that will set the sensor to a Down status. Please enter an integer value. |
Response Must Include |
This field is only visible if string results is enabled above. Enter a string that must be part of the returned SQL string. If it is not, the sensor will be set to an error state. Please enter a string or leave the field empty. |
Response Must Not include |
This field is only visible if string results is enabled above. Enter a string that must not be part of the returned SQL string. If it is, the sensor will be set to an error state. 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 underneath 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. |
Note: For this sensor type, no port number can be set.
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 for this object, disable inheritance by clicking on the check mark symbol in front of the respective setting name. You will then see the options described below.
Scanning Interval |
|
Scanning Interval |
The scanning interval determines the time the sensor waits between two scans. Select a scanning interval (seconds, minutes, or hours) from the list. You can change the available intervals in the system administration. |
Schedules, Dependencies, and Maintenance Window |
|
---|---|
Note: Inheritance for schedules, dependencies, and maintenance windows cannot be interrupted; the according settings from the parent objects will always be active. However, you can define additional settings here. They will be active in parallel to 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. |
Maintenance Window |
Specify if you want to set-up a one-time maintenance window. During a maintenance window this object and all child objects will not be monitored. They will enter a paused state then. Choose between:
|
Maintenance Begins At |
This field is only visible if maintenance window is enabled 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 maintenance window is enabled 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. |
Dependency |
This field is only visible if the select object option is enabled above. Click on the reading-glass symbol and use the object selector to choose an object on which the current sensor will be dependent on. |
Delay (Seconds) |
Define a time span. After the master object for this dependency comes back to an Up status, monitoring of the depending objects will be additionally delayed by the defined time span. This can help 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 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 right 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 about access rights, please see section User Access Rights. |
In order to change display settings, spike filter, and limits, please switch to the sensor's Overview tab and click on the gear icon of a specific channel. For detailed information, please see Sensor Channels Settings section.
Click on the Notifications tab to change notification triggers. For detailed information, please see Sensor Notifications Settings section.
For more general information about settings, please see Object Settings section.
For information about sensor settings, please see the following sections:
Keywords: