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

Add Sensor

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.

Sensor Settings

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:

  • Automatic: Automatically choose the right port.
  • Manual: Use a specific port. Define below. Standard value is 3306.

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 the SQL expression that will be queried from the database. For example, such an expression could be: SELECT AVG(UnitPrice) FROM Products. Note: When a cursor is returned (i.e. with a SELECT statement), only the first row of data will be processed.

Postprocessing

If the SQL expression returns a result set, please define if you want to further process it. Choose between:

  • Ignore result set: Do not do anything with the data returned.
  • Process numerical result: Regard the result set returned as integer or float. You can set the sensor to Warning or Down status for specific thresholds. Define below.
  • Process string result: Regard the result set returned as a string. You can set the sensor to error for certain sub-strings contained or missing. Define below.
  • Monitor for changes: Monitor if the result set has changed since last check. The sensor will send an internal message indicating that its value has changed. In combination with a Change Trigger, you can use this mechanism to trigger a notification whenever a sensor value changes.

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:

  • none: Do not set the sensor to Warning status for any condition.
  • equals: Result set must be the same as the value provided below.
  • is above: Result set must be above the value provided below.
  • lower than: Result set must be below the value provided below.
  • does not equal: Result set must be unequal to the value provided below.

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:

  • none: Do not set the sensor to Down status for any condition.
  • equals: Result set must be the same as the value provided below.
  • is above: Result set must be above the value provided below.
  • lower than: Result set must be below the value provided below.
  • does not equal: Result set must be unequal to the value provided below.

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.

Chart Type

Define how different channels will be shown for this sensor.

  • Show channels independently (default): Show an own 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 will generate an easy-to-read graph which visualizes the different components of your total traffic. Note: This option cannot be used in combination with manual Vertical Axis Scaling (available in the Sensor Channels Settings settings).

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.

Inherited Settings

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 and Dependencies

Schedule

Select a schedule from the list. Schedules can be used to pause monitoring for a certain time span (days, hours) throughout the week. 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.

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:

  • Use parent: Pause the current sensor if the device it is created on is in a Down status, or if it is paused by another dependency.
  • Select object: Pause the current sensor if the device it is created on is in an Down status, or if it is paused by another dependency. Additionally, pause the current sensor if a specific other object in the device tree is in a Down status, or if it is paused by another dependency. Select below.
  • Master object for parent: Make this sensor the master object for its parent device. The sensor will influence the behavior of the device it is created on: If the sensor is in a Down status, the device will be paused. For example, it is a good idea to make a Ping sensor the master object for its parent device to pause monitoring for all other sensors on the device in case the device cannot even be pinged. Additionally, the sensor will be paused if the parent group of its parent device is in a Down status, or if it is paused by another dependency.

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.

Inherit 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:

  • Inherited: Use the settings of the parent object.
  • None: Users in this group cannot see or edit the object. The object does not show up in lists and in the device tree. Exception: If a child object is visible to the user, the object is visible in the device tree, though not accessible.
  • Read: Users in this group can see the object and review its monitoring results.
  • Write: Users in this group can see the object, review its monitoring results, and edit the object's settings. They cannot edit access rights settings.
  • Full: Users in this group can see the object, review its monitoring results, edit the object's settings, and edit access rights settings.

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.

Channels

Click on the Channels tab to change display settings, spike filter, and limits. For detailed information, please see Sensor Channels Settings section.

Notifications

Click on the Notifications tab to change notification triggers. For detailed information, please see Sensor Notifications Settings section.

Others

For more general information about settings, please see Object Settings section.

Sensor Settings Overview

For information about sensor settings, please see the following sections:

Continue

Keywords: