PRTG Manual: OPC UA Custom Sensor

Channel #1 – #10 Naming Method

Select the naming method for the channels of the sensor:

• Use automatic naming (default): The sensor uses the name provided by the OPC UA node.
  You cannot use automatic naming after sensor creation.
• Enter custom name: Enter a custom name in field Channel #1 - #10 Name.

You can change this value later in the channel settings of this sensor.

Channel #1 - #10 Unit

Enter the unit for the numeric value that this sensor monitors.

You can change this value later in the channel settings of this sensor.

Channel #1 – #10 Node ID

Enter the node ID from which you want to receive numeric data.

A node ID looks like this, for example: ns=1;i=1234 or ns=2;s=test_one. The sensor supports string identifiers and numeric identifiers.

Channel #2 - #10

You can define up to 10 channels. You must define at least one channel, so you see all available settings for Channel #1. Specify how to handle all other possible channels:

• Disable: Do not create this channel.
• Enable: Create this channel.

It is not possible to enable or disable channels after sensor creation.

Sensor Name

Enter a 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.

If the name contains angle brackets (<>), PRTG replaces them with braces ({}) for security reasons. For more information, see the Knowledge Base: What security features does PRTG include?

Parent Tags

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

• opcua
• opcuacustom

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

Sensor Message Node ID

Optionally enter the node ID from which you want to receive a string that the sensor shows as sensor message.

A node ID looks like this, for example: ns=1;i=1234 or ns=2;s=test_one. The sensor supports string identifiers and numeric identifiers.

The sensor only shows the received string if the sensor is in the Up status. If the sensor enters the Down status, the sensor message shows the error message instead.

Channel #x Node ID

The node ID from which the sensor receives numeric data.

A node ID looks like this, for example: ns=1;i=1234 or ns=2;s=test_one. The sensor supports string identifiers and numeric identifiers.

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

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.

Result Handling

Define what PRTG does with the sensor result:

• Discard result: Do not store the sensor result.

• Store result: Store the last sensor result 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.

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

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

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

[Value]

The returned numeric values in up to ten channels