PRTG Manual: OPC UA Custom Sensor

Valid port

This sensor requires a valid port for the connection to the OPC UA server.

Credentials

This sensor requires credentials for OPC UA in the settings of the parent device.

IPv6

This sensor supports IPv6.

Performance impact

This sensor has a low performance impact.

Lookups

This sensor uses lookups to determine the status values of one or more channels.

Scanning interval

The minimum scanning interval of this sensor is 30 seconds.

Multi-platform probe

You can add this sensor to a multi-platform probe.

Knowledge Base

Knowledge Base: Which OPC UA data types does the OPC UA Custom sensor support?

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 #x Scale Factor

If you want to scale the received data, enter an integer or a floating-point number. If you want to scale up, enter a value over one. If you want to scale down, enter a value below one. Use the default scale factor, 1, to not change the data.

Channel #1 – #10 NodeID

Enter the NodeID from which you want to receive numeric data.

A NodeID looks like this, for example: ns=1;i=1234, ns=2;s=test_one, or 'ns=1;s=test_one'[4]. The sensor supports string identifiers, numeric identifiers, and array syntaxes.

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 Message NodeID

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

A NodeID looks like this, for example: ns=1;i=1234, ns=2;s=test_one, or 'ns=1;s=test_one'[4]. The sensor supports string identifiers, numeric identifiers, and array syntaxes.

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 NodeID

The NodeID from which the sensor receives numeric data.

A NodeID looks like this, for example: ns=1;i=1234, ns=2;s=test_one, or 'ns=1;s=test_one'[4]. The sensor supports string identifiers, numeric identifiers, and array syntaxes.

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.

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

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.

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