Skip to main content
Version: 8.1

Gateway Network Connection Details

Gateway Network Connection Details

Ignition's Gateway Network system shares information across Gateways using threads to send and receive information. For example, if you have a Remote Tag Provider configured between Gateway A and Gateway B, messages containing live tag information will be sent between these two Gateways using threads to send and receive live tag data. Similarly, a Remote Historical Tag Provider will send/receive messages with historical tag data between Gateway A and Gateway B using this same set of threads. Each Ignition sub system that uses the Gateway Network will utilize these threads in some way.

Ignition's Gateway Network also has a queue associated with each Ignition subsystem. These queues allow for Ignition to have a way to prioritize which sub system should have access to a send or receive thread. Prioritization here is especially important because if all send threads are in use, messages cannot be sent between two Gateways. The Gateway Network page includes additional information that will help better monitor Gateway interactions.

Gateway Webpage - Gateway Network

The image above shows the basic Gateway Network Connection Status page where we can see there is an outgoing Gateway Network connection from Gateway A to Gateway B. Pressing the Details button will bring up detailed information about this connection as below:

Gateway Webpage - Gateway Network Properties

AttributeDescription
StatusCurrent state of the Gateway Network Connection.
Average Outgoing BytesAverage bytes of data going from the Local Gateway to the Remote Gateway per second.
Average Incoming BytesAverage bytes of data going from the Remote Gateway to the Local Gateway per second.
Ping TimeReaction time of Gateway connection. How fast you get a response after you've sent out a request.
ActiveNumber of messages being actively processed by the Gateway network connection.
Send ThreadsA thread that is used by the Gateway Network to upload messages from one Gateway to another.
Receive ThreadsA thread that is used by the Gateway Network to download messages from one Gateway to another.
Local IdId of the local Gateway.
Remote IdId of the remote Gateway.
Remote GatewayName of the Gateway on the Gateway network.
Network AddressPhysical address used to communicate with all devices on the Gateway network.
Redundant RoleThe redundancy role of the Gateway. Can either be Independent, Backup, or Master.
DirectionThe direction of the Gateway Network connection. Can either be Incoming or Outgoing.
Session IdGateway connection session Id number. Connected Gateways use the same session Id on both Gateways.
Last CommThe time of the last communication with the Gateway.
Fault CountNumber of times the connection has faulted since the Gateway has been started.
Connection EventsDisplays a list of recent connection events.

Active Outgoing and Incoming Tasks List

AttributeDescription
Task NameName of the task that is using a thread.
Source QueueThe Ignition sub system queue that dispatched this task.
Duration SecsThis is how long in seconds it takes for a task to be performed.

Gateway Network Statistics

In addition to showing live thread and task information, users can also keep track of Gateway Network Statistics. By clicking on the Details button below, the Gateway Network Statistics Page appears for Gateway B:

Gateway Network Statistics

Outgoing Queues

The Gateway Network Statistics page has three sections associated with it. First, the Outgoing Queues section. The Outgoing Queues section shows tasks that are both in a pending and active state. A pending task is a task that has not yet been dispatched to the Gateway Network thread pool. An active task is a task that is being processed by the Gateway Network thread pool and should show up under the Gateway Network Connection Status page as either an outgoing or incoming task.

Outgoing Queues

AttributeDescription
NameName of the queue.
PriorityLevel of priority for a queue.
Inserts/SecRate of task inserts per second for a queue
PendingNumber of pending tasks in a queue that have not yet been dispatched to a Send/Receive thread.
ActiveNumber of messages being actively processed by the Gateway Network connection.
Avg Pending SecsAverage number of seconds that a task has been pending in a queue.
TotalTotal number of tasks executed from this queue.
ActionsSet of actions associated with a queue. Users can both Pause and Clear a queue.

Temporary Queue Actions

The Gateway Network Statistics page has controls for pausing and clearing a queue. To pause a queue means no new tasks will be allowed to be inserted into the paused queue. To clear a queue means that all pending tasks will be purged. These actions are designed to help the user deal with a possibly overloaded Gateway Network connection due to a specific sub system flooding the queue with more tasks than the connection can handle. Note that neither of these actions will have any effect on active tasks, as they have already been dispatched to the Gateway Network connection and cannot be cancelled.

Temporary Queue Actions

Outgoing and Incoming Tasks Statistics

The Outgoing and Incoming Task Statistics section shows individual tasks that have been processed by the Gateway Network Connection.

Outgoing and Incoming Tasks Statistics

Outgoing and Incoming Tasks AttributesDescription
NameName of a task.
DescriptionDescription for a task.
QueueQueue invoking a task (For Outgoing Tasks only)
Invocation/SecRate at which a task is invoked per second.
Avg Duration SecsAverage duration in seconds of the time it takes for this task to execute.
TotalNumber of times the task has been executed in total.