PRTG Manual: Data Hub Rule Sensor

The Data Hub Rule sensor monitors the network traffic and the status of an individual rule of a PRTG Data Hub instance.

i_betaThis sensor is in beta status. The operating methods and the available settings are still subject to change. Do not expect that all functions work properly, or that this sensor works as expected at all.

Data Hub Rule Sensor

Data Hub Rule Sensor

i_square_cyanFor a detailed list and descriptions of the channels that this sensor can show, see section Channel List.

Sensor in Other Languages

  • Dutch: Data Hub Rule
  • French: Data Hub Rule
  • German: Data-Hub-Regel
  • Japanese: Data Hub Rule
  • Portuguese: Data Hub Rule
  • Russian: Data Hub Rule
  • Simplified Chinese: Data Hub Rule
  • Spanish: Regla PRTG Data Hub

Remarks

Consider the following remarks and requirements for this sensor:

Requirement

Description

Enabled Beta Sensors experimental feature

This sensor requires that the Beta Sensors experimental feature is enabled.

i_square_cyanFor more information, see the Knowledge Base: What are beta sensors and how can I use them?

Credentials

This sensor requires credentials for PRTG Data Hub in the settings of the parent device.

Performance impact

This sensor has a very low performance impact.

Limits

This sensor has predefined limits for several metrics.

Basic Sensor Settings

Basic Sensor Settings

Basic Sensor Settings

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

  • datahub

i_square_cyanFor more information about basic sensor settings, see section Sensor Settings.

Specific Sensor Settings

Specific Sensor Settings

Specific Sensor Settings

Setting

Description

Rule

The name of the rule that this sensor monitors.

Sensor Display

Sensor Display

Sensor Display

Setting

Description

Primary Channel

Select a channel from the list to define it as the primary channel. In the device tree, PRTG displays the last value of the primary channel 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 this sensor shows different channels:

  • 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 select Stack channels on top of each other above.

Select a unit from the list. PRTG stacks all channels with this unit 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.

Debug Options

Debug Options

Debug Options

Setting

Description

Result Handling

Define what PRTG does with the sensor result:

  • Discard result (default): Do not store the sensor result.
  • Store result: Store the sensor result and the last response in the \Logs\sensors subfolder of the PRTG data directory on the probe system. The file name is Result of Sensor [ID].log. This setting is for debugging purposes. PRTG overwrites this file with each scanning interval.

i_podThis option is not available when the sensor runs on the hosted probe of a PRTG Hosted Monitor instance.

i_round_blueIn a cluster, PRTG stores the result in the PRTG data directory of the master node.

Inherited Settings

By default, all of these settings are inherited from objects that are higher in the hierarchy. We recommend that you 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 and to display its options.

i_square_cyanFor more information, see section Inheritance of Settings.

Channel List

i_round_blueWhich channels the sensor actually shows might depend on the target device, the available components, and the sensor setup.

Channel

Description

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.

Last Message In

The time since the last incoming message

Messages Accepted

The number of messages accepted by the rule over time

Messages Dropped

The number of messages dropped by the rule

i_round_blueThis channel has default limits:

  • Upper error limit: 0

Messages In

i_round_blueThis channel is the primary channel by default.

The number of incoming messages over time

Messages Out

The number of outgoing messages over time

Messages Rejected

The number of messages rejected by the rule over time

Traffic In

The incoming traffic

Traffic Out

The outgoing traffic

More

i_square_blueKNOWLEDGE BASE

What are beta sensors and how can I use them?

What security features does PRTG include?