<%NUMBERING1%>.<%NUMBERING2%>.<%NUMBERING3%> PRTG Manual: MySQL Sensor

This sensor type is outdated. We strongly recommend that you use the MySQL v2 Sensor instead. This is a new sensor type to monitor databases on MySQL servers.

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).

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.

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 username that will be used for the database connection.

Password

Enter the password that will be used for the database connection.

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:

• Do not count number of records: Disable the counting of affected records. The "Record Count" channel always shows "0" if you choose this option.
• Count number of records: Show the number of affected records in the "Record Count" channel.
  Note: Enabling this option might increase the execution time of this sensor.

Post-Processing

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

• Ignore result set: Do not process 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: Check if the result set has changed since last sensor scan. 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 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:

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

• 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 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.

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.

• 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.

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:

• Set sensor to "down" immediately: The sensor will show an error immediately after the first failed request.
• Set sensor to "warning" for 1 interval, then set to "down" (recommended): After the first failed request, the sensor will show a yellow warning status. If the following request also fails, the sensor will show an error.
• Set sensor to "warning" for 2 intervals, then set to "down": Show an error status only after three continuously failed requests.
• Set sensor to "warning" for 3 intervals, then set to "down": Show an error status only after four continuously failed requests.
• Set sensor to "warning" for 4 intervals, then set to "down": Show an error status only after five continuously failed requests.
• Set sensor to "warning" for 5 intervals, then set to "down": Show an error status only after six continuously failed requests.

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.

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:

• Not set (monitor continuously): No maintenance window will be set and monitoring will always be active.
• Set up a one-time maintenance window: Pause monitoring within a maintenance window. You can define a time span for a monitoring pause below and change it even for a currently running maintenance window.

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:

• Use parent: Pause the current sensor if the device, where it is created on, is in a Down status, or if the sensor is paused by another dependency.
• Select object: Pause the current sensor if the device, where it is created on, is in an Down status, or if the sensor 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, where 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. 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.

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:

• Inherited: Use the access rights settings of the parent object.
• None: Users in this group cannot see or edit the object. The object neither shows up in lists nor 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.

For more details on access rights, please see the section User Access Rights.