PRTG Manual: Event Log (Windows API) Sensor

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 spaces or commas. 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 the sensor if you like. Other tags are automatically inherited from objects further up in the device tree. These are visible above as Parent Tags.

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

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

Log File

Specify the log file that this sensor monitors. The Windows event log provides several different log files, which PRTG shows here. Choose between:

• Application
• System
• Security
• Directory Service
• DNS Server
• File Replication Service

Event Type

Specify the type of event that this sensor processes. Other event types cannot be processed. Choose between the following event types:

• Any
• Error
• Warning
• Information
• Security Audit Success
• Security Audit Failure

Filter by Source

Filter all received events for a certain event source. If you enable this option, this sensor only processes messages that match the defined value. Choose between:

• Off: Do not filter by event source.
• On: Enable filtering by event source.

Filter Type

This field is only visible if you enable source filtering above. Choose between:

• Include Filter: Include the specified value and disregard all other values.
• Exclude Filter: Exclude the specified value and regard all other values.

Match String (Event Source)

This field is only visible if you enable source filtering above. Enter an event source that you want to filter for. Depending on the kind of filter, the event source is processed (Include Filter) or not processed (Exclude Filter). Please enter a string.

Filter by ID

Filter all received events for a certain event ID. If you enable this option, this sensor processes only messages that match the defined value(s). Choose between:

• Off: Do not filter by event ID.
• On: Enable filtering by event ID.

Filter Type

This field is only visible if you enable ID filtering above. Choose between:

• Include Filter: Include the specified value and disregard all other values.
• Exclude Filter: Exclude the specified value and regard all other values.

Match Values (Event ID)

This field is only visible if you enable ID filtering above. Enter an event ID that you want to filter for. Depending on the kind of filter, the event ID is processed (Include Filter) or not processed (Exclude Filter).

The Event Log (Windows API) Sensor supports more than one event ID. Using this sensor type, you can enter a comma-separated list of event IDs to filter for more than one ID.

The WMI Event Log Sensor supports filtering for only one ID.

Filter by Category

Filter all received events for a certain event category. If you enable this option, this sensor only processes messages that match the defined value. Choose between:

• Off: Do not filter by event category.
• On: Enable filtering by event category.

Filter Type

This field is only visible if you enable category filtering above. Choose between:

• Include Filter: Include the specified value and disregard all other values.
• Exclude Filter: Exclude the specified value and regard all other values.

Match String (Event Category)

This field is only visible if you enable category filtering above. Enter a category that you want to filter for. Depending on the kind of filter, the event category is processed (Include Filter) or not processed (Exclude Filter). Please enter a string.

Filter by User

Filter all received events for a certain event user. If you enable this option, this sensor only processes messages that match the defined value. Choose between:

• Off: Do not filter by event user.
• On: Enable filtering by event user.

Filter Type

This field is only visible if you enable user filtering above. Choose between:

• Include Filter: Include the specified value and disregard all other values.
• Exclude Filter: Exclude the specified value and regard all other values.

Match String (Event User)

This field is only visible if you enable user filtering above. Enter a username that you want to filter for. Depending on the kind of filter, the event user is processed (Include Filter) or not processed (Exclude Filter). Please enter a string.

Filter by Computer

Filter all received events for a certain event computer. If you enable this option, this sensor only processes messages that match the defined value. Choose between:

• Off: Do not filter by event computer.
• On: Enable filtering by event computer.

Filter Type

This field is only visible if you enable computer filtering above. Choose between:

• Include Filter: Include the specified value and disregard all other values.
• Exclude Filter: Exclude the specified value and regard all other values.

Match String (Event Computer)

This field is only visible if you enable computer filtering above. Enter a computer name that you want to filter for. Depending on the kind of filter, the event computer is processed (Include Filter) or not processed (Exclude Filter). Please enter a string.

Filter by Message

Filter all received events for a certain event message. If you enable this option, this sensor only processes messages that match the defined value. Choose between:

• Off: Do not filter by event message.
• On: Enable filtering by event message.

Filter Type

This field is only visible if you enable message filtering above. Choose between:

• Include Filter: Include the specified value and disregard all other values.
• Exclude Filter: Exclude the specified value and regard all other values.

Match String (Event Message)

This field is only visible if you enable message filtering above. Enter a message that you want to filter for. Depending on the kind of filter, the event message is processed (Include Filter) or not processed (Exclude Filter). Please enter a string.

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.

You can set another primary channel later by clicking the pin symbol of a channel in the sensor's Overview tab.

Graph 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 that visualizes the different components of your total traffic.
  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.

Click to disrupt the inheritance. See section Inheritance of Settings for more information.

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 on PRTG on premises installations.

If a Sensor Query Fails

Define the number of scanning intervals that a sensor has time to reach and check a device again in case a sensor query fails. The sensor can try to re-reach and check a device several times, depending on the option you select here, before it will be set to a Down status. This helps you 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 consecutively failed requests.
• Set sensor to "warning" for 3 intervals, then set to "down": Show an error status only after four consecutively failed requests.
• Set sensor to "warning" for 4 intervals, then set to "down": Show an error status only after five consecutively failed requests.
• Set sensor to "warning" for 5 intervals, then set to "down": Show an error status only after six consecutively failed requests.

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 to "down" immediately, so the first option will not apply to these sensor types. All other options can apply.

If a sensor has defined error limits for channels, it will always show a Down status immediately, so no "wait" option will apply.
 

If a channel uses lookup values, it will always show a Down status immediately, so no "wait" options will apply.

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

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.

To terminate a current maintenance window before the defined end date, change the time entry in Maintenance Ends field to a date in the past.

Maintenance Begins

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 Ends

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

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.

Dependency Delay (Sec.)

Define a time span in seconds for a dependency delay. After the master object for this dependency goes back to Up status, PRTG will start monitoring the depending objects after this extra delayed. 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.

This setting is not available if you choose this sensor to Use parent or to be the Master object for parent. In this case, please define delays in the parent Device Settings or in the superior Group Settings.

Click to disrupt the inheritance. See section Inheritance of Settings for more information.

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, see the section User Access Rights.