PRTG Manual: Event Log (Windows API) Sensor

The Event Log (Windows API) sensor monitors Event Log entries using the Windows application programming interface (API).

The sensor can show the following:

  • Number of new records per second (speed)
Event Log (Windows API) Sensor

Event Log (Windows API) Sensor

Sensor in Other Languages

  • Dutch: Event Log (Windows API)
  • French: Log des événements (Windows API)
  • German: Ereignisprotokoll (Windows API)
  • Japanese: イベントログ(Windows API)
  • Portuguese: Log de Eventos do Windows (API)
  • Russian: Журнал событий (API Windows)
  • Simplified Chinese: 事件日志 (Windows API)
  • Spanish: Registro de eventos (Windows API)

Remarks

i_podYou cannot add this sensor to the hosted probe of a PRTG hosted by Paessler instance. If you want to use this sensor, add it to a remote probe device.

Add Sensor

The Add Sensor dialog appears when you manually add a new sensor to a device. It only shows the setting fields that are required for creating the sensor. Therefore, you do not see all setting fields in this dialog. You can change (nearly) all settings in the sensor's Settings tab later.

Basic Sensor Settings

Click the Settings tab of a sensor to change its settings.

i_round_blueUsually, a sensor connects to the IP Address or DNS Name of the parent device on which you created the sensor. See the device settings for details. For some sensors, you can explicitly define the monitoring target in the sensor settings. See below for details on available settings.

Setting

Description

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 the sensor inherits from its parent device, parent group, and parent probe. This setting is shown for your information only and cannot be changed here.

Tags

Enter one or more tags. Confirm each tag with the Spacebar key, a comma, or the Enter key. You can use tags to group objects and use tag-filtered views later on. Tags are not case-sensitive. Tags are automatically inherited.

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

The sensor has the following default tags that are automatically predefined in the sensor's settings when you add the sensor:

  • wmiapieventlogsensor

Priority

Select a priority for the sensor. This setting determines the position of the sensor in lists. The highest priority is at the top of a list. Choose from the lowest priority (i_priority_1) to the highest priority (i_priority_5).

Windows API Event Log Specific

Setting

Description

Logfile

Specify the logfile that this sensor monitors. The Windows event log provides several different logfiles:

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

Filter Event Log Entries

Setting

Description

Event Type

Specify the type of event that this sensor processes:

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

i_round_blueOther event types cannot be processed.

Filter by Source

Filter all received events for a certain event source:

  • Off: Do not filter by event source.
  • On: Enable filtering by event source.
    i_round_blueIf you enable this option, this sensor only processes messages that match the defined value.

Filter Type

This setting is only visible if Filter by Source is enabled above. Select the filter type:

  • 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 setting is only visible if Filter by Source is enabled above. Enter an event source that you want to filter for. Depending on the kind of filter, the event source is processed (Include filter option) or not processed (Exclude filter option). Enter a string.

Filter by ID

Filter all received events for a certain event ID:

  • Off: Do not filter by event ID.
  • On: Enable filtering by event ID.
    i_round_blueIf you enable this option, this sensor only processes messages that match the defined values.

Filter Type

This setting is only visible if ID filtering is On above. Select a filter type:

  • 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 setting is only visible if Filter by ID is enabled above. Enter an event ID that you want to filter for. Depending on the kind of filter, the event ID is processed (Include filter option) or not processed (Exclude filter option).

i_round_blueThe Event Log (Windows API) supports more than one event ID. Using this sensor, you can enter a comma-separated list of event IDs to filter for more than one ID. For example: 1100,4627,4747,4884,5050,6422.

Filter by Category

Filter all received events for a certain event category:

  • Off: Do not filter by event category.
  • On: Enable filtering by event category.
    i_round_blueIf you enable this option, this sensor only processes messages that match the defined value.

Filter Type

This setting is only visible if Filter by Category is enabled above. Select a filter type:

  • 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 setting is only visible if Filter by Category is enabled above. Enter a category that you want to filter for. Depending on the kind of filter, the event category is processed (Include filter option) or not processed (Exclude filter option). Enter a string.

Filter by User

Filter all received events for a certain event user:

  • Off: Do not filter by event user.
  • On: Enable filtering by event user.
    i_round_blueIf you enable this option, this sensor only processes messages that match the defined value.

Filter Type

This setting is only visible if Filter by User is enabled above. Select a filter type:

  • 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 setting is only visible if Filter by User is enabled above. Enter a username that you want to filter for. Depending on the kind of filter, the event user is processed (Include filter option) or not processed (Exclude filter option). Enter a string.

Filter by Computer

Filter all received events for a certain event computer:

  • Off: Do not filter by event computer.
  • On: Enable filtering by event computer.
    i_round_blueIf you enable this option, this sensor only processes messages that match the defined value.

Filter Type

This setting is only visible if Filter by Computer is enabled above. Select a filter type:

  • 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 setting is only visible if Filter by Computer is enabled above. Enter a computer name that you want to filter for. Depending on the kind of filter, the event computer is processed (Include filter option) or not processed (Exclude filter option). Enter a string.

Filter by Message

Filter all received events for a certain event message:

  • Off: Do not filter by event message.
  • On: Enable filtering by event message.
    i_round_blueIf you enable this option, this sensor only processes messages that match the defined value.

Filter Type

This setting is only visible if Filter by Message is enabled above. Select a filter type:

  • 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 setting is only visible if message filtering is On above. Enter a message that you want to filter for. Depending on the kind of filter, the event message is processed (Include filter option) or not processed (Exclude filter option). Enter a string.

i_round_blueYou must use the percent sign (%) as wildcard for any or no character if you want to check if the string is part of the message. Otherwise, the whole event message must match the string. For example, you can enter %RAS% for any event source containing the string RAS.

Sensor Display

Setting

Description

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 is always displayed below the sensor's name. The available options depend on what channels are available for this sensor.

i_round_blueYou can set a different primary channel later by clicking b_channel_primary below a channel gauge on the sensor's Overview tab.

Graph Type

Define how different channels are shown for this sensor:

  • Show channels independently (default): Show a 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 generates a graph that visualizes the different components of your total traffic.
    i_round_redYou cannot use this option in combination with manual Vertical Axis Scaling (available in the channel settings).

Stack Unit

This setting is only visible if you enable Stack channels on top of each other as Graph Type. Select a unit from the list. All channels with this unit are 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.

Inherited Settings

By default, all of the following settings are inherited from objects that are higher in the hierarchy. You should change them centrally in the root group settings if necessary. To change a setting for this object only, click b_inherited_enabled under the corresponding setting name to disable the inheritance. You then see the options described below.

i_square_cyanFor more information, see section Inheritance of Settings.

Scanning Interval

Click b_inherited_enabled to interrupt the inheritance.

Setting

Description

Scanning Interval

Select a scanning interval from the dropdown list. The scanning interval determines the amount of time that the sensor waits between two scans. Choose from:

  • 30 seconds
  • 60 seconds
  • 5 minutes
  • 10 minutes
  • 15 minutes
  • 30 minutes
  • 1 hour
  • 4 hours
  • 6 hours
  • 12 hours
  • 1 day

i_round_blueYou can change the available intervals in the system administration on PRTG on premises installations.

If a Sensor Query Fails

Select the number of scanning intervals that the sensor has time to reach and to check a device again if a sensor query fails. Depending on the option that you select, the sensor can try to reach and to check a device again several times before the sensor shows the Down status. This can avoid false alarms if the monitored device only has temporary issues. For previous scanning intervals with failed requests, the sensor shows the Warning status. Choose from:

  • Set sensor to down immediately: Set the sensor to the Down status immediately after the first request fails.
  • Set sensor to warning for 1 interval, then set to down (recommended): Set the sensor to the Warning status after the first request fails. If the second request also fails, the sensor shows the Down status.
  • Set sensor to warning for 2 intervals, then set to down: Set the sensor to the Down status only after the third request fails.
  • Set sensor to warning for 3 intervals, then set to down: Set the sensor to the Down status only after the fourth request fails.
  • Set sensor to warning for 4 intervals, then set to down: Set the sensor to the Down status only after the fifth request fails.
  • Set sensor to warning for 5 intervals, then set to down: Set the sensor to the Down status only after the sixth request fails.

i_round_blueSensors that monitor via Windows Management Instrumentation (WMI) always wait at least one scanning interval before they show the Down status. It is not possible to immediately set a WMI sensor to the Down status, so the first option does not apply to these sensors. All other options can apply.

i_round_blueIf you define error limits for a sensor's channels, the sensor immediately shows the Down status. None of the interval options apply.

i_round_blueIf a channel uses lookup values, the sensor immediately shows the Down status. None of the interval options apply.

Schedules, Dependencies, and Maintenance Window

i_round_blueYou cannot interrupt the inheritance for schedules, dependencies, and maintenance windows. The corresponding settings from the parent objects are always active. However, you can define additional schedules, dependencies, and maintenance windows. They are active at the same time as the parent objects' settings.

Setting

Description

Schedule

Select a schedule from the list. You can use schedules to monitor during a certain time span (days or hours) every week. Choose from:

  • None
  • Saturdays
  • Sundays
  • Weekdays
  • Weekdays Eight-To-Eight (08:00 - 20:00)
  • Weekdays Nights (17:00 - 09:00)
  • Weekdays Nights (20:00 - 08:00)
  • Weekdays Nine-To-Five (09:00 - 17:00)
  • Weekends

i_square_cyanYou can create schedules, edit schedules, or pause monitoring for a specific time span. For more information, see section Schedules.

Maintenance Window

Select if you want to set up a one-time maintenance window. During a maintenance window, monitoring stops for the selected object and all child objects. They show the Paused status instead. Choose between:

  • Not set (monitor continuously): Do not set up a one-time maintenance window. Monitoring is always active.
  • Set up a one-time maintenance window: Set up a one-time maintenance window and pause monitoring. You can define a time span for a the pause below.

i_round_blueTo terminate an active maintenance window before the defined end date, change the time entry in Maintenance Ends to a date in the past.

Maintenance Begins

This setting is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the start date and time of the one-time maintenance window.

Maintenance Ends

This setting is only visible if you enable Set up a one-time maintenance window above. Use the date time picker to enter the end date and time of the one-time maintenance window.

Dependency Type

Select a dependency type. You can use dependencies to pause monitoring for an object depending on the status of a different object. You can choose from:

  • Use parent: Use the dependency type of the parent object.
  • Select a sensor: Use the dependency type of the parent object. Additionally, pause the current object if a specific sensor is in the Down status or in the Paused status because of another dependency.
  • Master sensor for parent: Make this sensor the master object for its parent device. The sensor influences the behavior of its parent device: If the sensor is in the Down status, the device is 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 is paused if the parent group is paused by another dependency.

i_round_blueTo test your dependencies, select Simulate Error Status from the context menu of an object that other objects depend on. A few seconds later, all dependent objects are paused. You can check all dependencies under Devices | Dependencies in the main menu bar.

Dependency

This setting is only visible if you enable Select a sensor above. Click b_search_light and use the object selector to select a sensor on which the current object will depend.

Dependency Delay (Sec.)

This setting is only visible if you enable Select a sensor above. Define a time span in seconds for the dependency delay.

After the master sensor for this dependency returns to the Up status, PRTG additionally delays the monitoring of the dependent objects by the time span you define. This can prevent false alarms, for example, after a server restart or to give systems more time for all services to start. Enter an integer value.

i_round_redThis setting is not available if you set this sensor to Use parent or to be the Master sensor for parent. In this case, define delays in the parent device settings or in its parent group settings.

Access Rights

Click b_inherited_enabled to interrupt the inheritance.

Setting

Description

User Group Access

Define the user groups that have access to the sensor. You see a table with user groups and group access rights. The table contains all user groups in your setup. For each user group, you can choose from the following group access rights:

  • Inherited: Inherit the access rights settings of the parent object.
  • No access: Users in this user group cannot see or edit the sensor. The sensor neither shows up in lists nor in the device tree.
  • Read access: Users in this group can see the sensor and view its monitoring results. They cannot edit any settings.
  • Write access: Users in this group can see the sensor, view its monitoring results, and edit its settings. They cannot edit its access rights settings.
  • Full access: Users in this group can see the sensor, view its monitoring results, edit its settings, and edit its access rights settings.

i_square_cyanFor more details on access rights, see section Access Rights Management.

More

i_square_blueKNOWLEDGE BASE

My Event Log sensor ignores changes in the event log. What can I do?

How can I configure sensors using speed limits to keep the status for more than one interval?

Sensor Settings Overview

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