PRTG Manual: NATS Server Overview Sensor

The NATS Server Overview sensor monitors the status and traffic of a NATS server.

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

Sensor in Other Languages

Dutch: NATS Server Overview
French: NATS Server Overview
German: NATS-Server Übersicht
Japanese: NATS Server Overview
Portuguese: NATS Server Overview
Russian: NATS Server Overview
Simplified Chinese: NATS Server Overview
Spanish: Resumen servidor NATS

Remarks

Consider the following remarks and requirements for this sensor:

Requirement	Description
Credentials	This sensor requires credentials for NATS in the settings of the parent device.
IPv6	This sensor supports IPv6.
Limits	This sensor has predefined limits for several metrics.
Scanning interval	This sensor has a fixed minimum scanning interval for performance reasons. You cannot use a shorter scanning interval. Consequently, shorter scanning intervals in the Monitoring settings are not available for this sensor. The minimum scanning interval of this sensor is 1 minute. The recommended scanning interval of this sensor is 1 minute.
Performance impact	This sensor has a very low performance impact.
Multi-platform probe	You can add this sensor to a multi-platform probe. For more information on how to set up a NATS server to use with the multi-platform probe, see the manual: Multi-Platform Probe for PRTG (PDF).

Basic Sensor Settings

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

nats
natsroundtrip
roundtrip

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

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

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.

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.

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

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.

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.

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 under the corresponding setting name to disable the inheritance and to display its options.

For more information, see section Inheritance of Settings.

Channel List

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

Channel	Description
Bytes Received	The number of bytes received
Bytes Sent	The number of bytes sent
Connections	The number of connections
CPU Usage	The CPU usage This channel has default limits: Upper error limit: 90% Upper warning limit: 80%
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.
JetStream Memory Reserved	The memory that NATS JetStream reserves This channel has default limits: Upper error limit: 90% Upper warning limit: 80% This channel value is computed based on the value defined in the max_mem parameter in the NATS server configuration.
JetStream Memory Used	The total memory that NATS JetStream uses This channel has default limits: Upper error limit: 90% Upper warning limit: 80% This channel value is computed based on the value defined in the max_mem parameter in the NATS server configuration.
JetStream Storage Reserved	The storage that NATS JetStream reserves This channel has default limits: Upper error limit: 90% Upper warning limit: 80% This channel value is computed based on the value defined in the max_file parameter in the NATS server configuration.
JetStream Storage Used	The total storage that NATS JetStream uses This channel has default limits: Upper error limit: 90% Upper warning limit: 80% This channel value is computed based on the value defined in the max_file parameter in the NATS server configuration.
Memory Used	The memory that the NATS server uses
Messages Received	The number of messages received per second
Messages Sent	The number of messages sent per second
Round Trip Time	The round trip time (RTT) of the message (after both the publisher and subscriber connect) This channel is the primary channel by default.
Slow Consumers	The number of slow consumers This channel has a default limit: Upper warning limit: 0
Subscriptions	The number of subscriptions