PRTG Manual: Syslog Receiver Sensor

Sensor Name

Enter a name to identify the sensor.

Parent Tags

Shows tags that the sensor inherits from its parent device, parent group, and parent probe.

This setting is for your information only. You cannot change it.

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.

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

For performance reasons, it can take some minutes until you can filter for new tags that you added.

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

• syslogsensor

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 () to the highest priority ().

Port

Enter the number of the port on which the sensor listens for Syslog messages. The default port is 514. Enter an integer value.

We recommend that you use the default value.

Purge Messages After

Define how long PRTG stores received Syslog messages for analysis. Select a period of time from the dropdown list.

Include Filter

Define if you want to filter Syslog messages. If you leave this field empty or use the keyword any, the sensor processes all data. To only include specific types of messages, define filters using a special syntax.

Exclude Filter

Define which types of Syslog messages the sensor discards and does not process. To exclude specific types of messages, define filters using a special syntax.

Warning Filter

Define which types of Syslog messages count for the Warnings channel. To categorize received messages as warning messages, define filters using a special syntax.

The sensor collects messages until a scanning interval ends. As long as the scanning interval is running, the sensor does not change its status. By default, the sensor changes to the Warning status after a scanning interval finishes and there was at least one warning message (and no error message) during this scanning interval. The sensor shows the Warning at least until the succeeding scanning interval finishes. If the sensor does not receive any warning or error message in this scanning interval, its status changes to the Up status again with the start of the next scanning interval.

Error Filter

Define which types of Syslog messages count for the Errors channel. To categorize received messages as error messages, define filters using a special syntax.

The sensor collects messages until a scanning interval ends. As long as the scanning interval is running, the sensor does not change its status. By default, the sensor changes to the Down status after a scanning interval finishes and there was at least one error message during this scanning interval. The sensor shows the Down status at least until the succeeding scanning interval finishes. If the sensor does not receive any warning or error message in this scanning interval, its status changes to the Up status again with the start of the next scanning interval.

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.

You can set a different primary channel later by clicking 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.
  You 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.

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
• 24 hours

You can change the available intervals in the system administration of PRTG Network Monitor.

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.

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

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

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

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

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

• Do not set up a one-time maintenance window: 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 the pause below.

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

To 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 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 select 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.

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

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.

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

Channel Unit Types

For each type of channel, select the unit in which PRTG displays the data. If you define this setting on probe, group, or device level, you can inherit these settings to all sensors underneath. You can set units for the following channel types (if available):

• Bandwidth
• Memory
• Disk
• File
• Custom

Custom channel types are only available on sensor level.

Result Handling

Define what PRTG does with the sensor result:

• Discard result (recommended): Do not store the sensor result.

• Store result: Store the last sensor result in the \Logs\debug subfolder of the PRTG data directory on the probe system. The file name is Sensor [ID]_[Date].log. This setting is for debugging purposes.
  Use with caution. We recommend that you only use this setting for a short time because it can create huge data files.

source[ip]

Enter an IP address where the messages come from. IP masks and ranges are also possible.

• source[10.0.23.50]
• source[10.0.23.10-50]
• source[10.0.23.10/24]
   

facility[number]

Enter any number or range from 0 to 23 specifying the program type that sends the message.

• facility[2]
• facility[5-7]
• facility[5] OR facility[6]
   

severity[number]

Enter any number or range from 0 (emergency) to 7 (debug) specifying the message type.

• severity[4]
• severity[1-3]
• severity[1] AND severity[2]
   

hostname[text]

Enter any string that specifies the hostname of a device in the message.

• hostname[www.example.com]
   

tag[text]

Enter any string that specifies the tag of a program or process in the message.

• tag[su]
   

appname[text]

Enter any string that specifies the appname part of the message.

• appname[myproc]
• appname[demo] AND msgid[m42]
   

procid[text]

Enter any string that specifies the process identifier part of the message.

• procid[1860]
   

msgid[text]

Enter any string that specifies the message identifier part of the message.

• msgid[ID47]
   

message[parttext]

Enter any string that specifies the message part of the message. (Any substring matches. This value is case insensitive.)

• message[Error]
   

data[id,param,value]

This checks the SD-ID block of the message's structured data for a parameter matching the specified value.

• data[[email protected],eventSource,Application]
   

data[parttext]

This checks if the specified substring matches structured data as displayed in the corresponding table.

• data[[email protected]]
   

data[id,param]

This checks if the parameter exists in the specified ID element.

• data[[email protected],eventSource]
   

Downtime

In the channel table on the Overview tab, this channel never shows any values. PRTG uses this channel in graphs and reports to show the amount of time in which the sensor was in the Down status in percent.

Drops

The number of dropped packets per second on the syslog port

Errors

The number of messages categorized as "error" per second

Messages

The number of received Syslog messages per second

This channel is the primary channel by default.

Warnings

The number of messages categorized as "warning" per second