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: Log de eventos (Windows API)

Remarks

icon-prtg-on-demandYou 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.

Sensor Settings

On the details page of a sensor, click the Settings tab to change its settings.

icon-i-roundUsually, 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.

Basic Sensor Settings

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.

There are default tags that are automatically predefined in a sensor's settings when you add a sensor. See section Default Tags below.

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.

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

Priority

Select a priority for the sensor. This setting determines where the sensor is placed in sensor lists. A sensor with a top priority is at the top of a list. Choose from one star (low priority) to five stars (top priority).

Default Tags

wmiapieventlogsensor

Windows API Event Log Specific

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

Event Type

Specify the type of event that this sensor processes:

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

icon-i-roundOther 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.
    icon-i-roundIf you enable this option, this sensor only processes messages that match the defined value.

Filter Type

This field 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 field 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.
    icon-i-roundIf you enable this option, this sensor only processes messages that match the defined values.

Filter Type

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

icon-i-roundThe Event Log (Windows API) sensor 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.

icon-i-roundThe WMI Event Log sensor supports filtering for only one ID.

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.
    icon-i-roundIf you enable this option, this sensor only processes messages that match the defined value.

Filter Type

This field 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 field 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.
    icon-i-roundIf you enable this option, this sensor only processes messages that match the defined value.

Filter Type

This field 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 field 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.
    icon-i-roundIf you enable this option, this sensor only processes messages that match the defined value.

Filter Type

This field 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 field 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.
    icon-i-roundIf you enable this option, this sensor only processes messages that match the defined value.

Filter Type

This field 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 field 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.

icon-i-round-redThe Event Log (Windows API) sensor always performs a substring match. Do not use any placeholder character. For example, enter RAS for any event source containing this string in part or as a whole.

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

icon-i-roundYou can set a different primary channel later by clicking the pin symbol of a channel 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.
    icon-i-roundThis option cannot be used in combination with manual Vertical Axis Scaling (available in the Sensor Channel Settings settings).

Stack Unit

This field 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 and should be changed there if necessary. Often, best practice is to change them centrally in the Root group's settings. For more information, see section Inheritance of Settings. To change a setting for this object only, disable inheritance by clicking the button next to inherit from under the corresponding setting name. You then see the options described below.

Scanning Interval

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

Scanning Interval

Select a scanning interval (seconds, minutes, or hours). The scanning interval determines the amount of time that 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 the sensor has time to reach and check a device again in case a sensor query fails. Depending on the option that you select, the sensor can try to reach and check a device again several times before the sensor shows a 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 a Warning status. Choose from:

  • Set sensor to down immediately: Set the sensor to a Down status immediately after the first failed request.
  • Set sensor to warning for 1 interval, then set to down (recommended): Set the sensor to a Warning status after the first failed request. If the following request also fails, the sensor shows an error.
  • Set sensor to warning for 2 intervals, then set to down: Set the sensor to a Down status only after three consecutively failed requests.
  • Set sensor to warning for 3 intervals, then set to down: Set the sensor to a Down status only after four consecutively failed requests.
  • Set sensor to warning for 4 intervals, then set to down: Set the sensor to a Down status only after five consecutively failed requests.
  • Set sensor to warning for 5 intervals, then set to down: Set the sensor to a Down status only after six consecutively failed requests.

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

icon-i-roundIf you define error limits for a sensor's channels, the sensor immediately shows a Down status. No "wait" option applies.

icon-i-roundIf a channel uses lookup values, the sensor immediately shows a Down status. No "wait" options apply.

Schedules, Dependencies, and Maintenance Window

icon-i-roundYou 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 settings here. They are 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 or hours) every week.

icon-book-arrowsYou can create schedules, edit schedules, or pause monitoring for a specific time span. For more information, see section Account Settings—Schedules.

icon-i-roundSchedules are generally inherited. New schedules are added to existing schedules, 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, the current object and all child objects are not monitored. They are in a Paused status instead. Choose between:

  • Not set (monitor continuously): No maintenance window is set and monitoring is always 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.

icon-i-roundTo terminate a current maintenance window before the defined end date, change the time entry in Maintenance Ends to a date in the past.

Maintenance Begins

This field 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 maintenance window.

Maintenance Ends

This field 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 maintenance window.

Dependency Type

Define a dependency type. You can use dependencies to pause monitoring for an object depending on the status of another 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 another specific sensor is in a Down status or in a Paused status caused by 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 a 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.

icon-i-roundTo 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 field is only visible if you enable Select a sensor above. Click the Search button and use the object selector to select a sensor on which the current object will depend.

Dependency Delay (Sec.)

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

After the master sensor for this dependency comes back to an Up status, monitoring of the dependent objects is 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. Enter an integer value.

icon-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 inherited_settings_button to interrupt the inheritance. See section Inheritance of Settings for more information.

User Group Access

Define the user groups that have access to the selected object. 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 but it cannot be accessed.
  • 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 its settings. They cannot edit access rights settings.
  • Full: Users in this group can see the object, review its monitoring results, edit its 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.

icon-book-arrowsFor more details on access rights, see section User Access Rights.

More

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

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

Edit Sensor Channels

To change display settings, spike filtering, and limits, switch to the sensor's Overview tab and click the gear icon of a specific channel. For detailed information, see section Sensor Channel Settings.

Notification Triggers

Click the Notification Triggers tab to change notification triggers. For detailed information, see section Sensor Notification Triggers Settings.

Others

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

Sensor Settings Overview

For information about sensor settings, see the following sections: