Ignition 8.1
Ignition 7.9
Ignition 7.8
Sepasoft - MES Modules
Cirrus Link - MQTT Modules
Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples
You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.
The Gateway Network Status page is designed to give a quick overview of the status of all Gateways within the Gateway Network. If a Gateway connection is faulted, the status message in red can be selected to see the error that pertains to why it is faulted. Any Gateway connections with a status of 'Connected' can be drilled into by clicking the Details button to the right. On the Details page, metrics for the selected Gateway connection are displayed, giving an idea of the rate of data transfer between the two Gateways, as well as a list of recent connection events.
The main Gateway Network page displays a list of all current Gateway Network connections both incoming and outgoing, as well a list of all Remote Gateways that the Local Gateway can see both from its Gateway Network connections and through proxy connections. Each list has some basic information along with the ability to see more details on a specific Gateway Network connection or a Remote Gateway.
| Attribute | Description |
|---|---|
| Gateway Network Connections | |
| Remote Gateway | Name of the Remote Gateway connection. |
| Direction | The direction of the Gateway Network connection. Can either be Incoming or Outgoing. |
| Redundancy Role | The redundancy role of the Gateway. Can either be Independent, Backup, or Master. |
| Last Comm | The time of the last communication with the Gateway. |
| Ping Time | Reaction time of Gateway connection. How fast you get a response after you've sent out a request. |
| Status | Current state of the Gateway Network Connection. |
| Fault Count | Number of times the connection has faulted since the Gateway has been started. |
| Remote Gateways | |
| Gateway Name | Name of the Remote Gateway. |
Outgoing Msg/Sec | The number of outgoing messages per second. |
| Incoming Msg/Sec | The number of incoming messages per second. |
| Pending | Number of messages pending in a queue that are waiting to be dispatched to the Gateway Network connection. |
| Connected Through | How the Gateway is connected to the Remote Gateway. |
| Status | Current state of the Remote Gateway Connection. |
Significant updates have been made to the Gateway Network starting in release 8.0.14. Use the links below to view the Gateway Network information for the version of Ignition that you are using.
From the Gateway Network Status page, clicking on the Details button to the right of a Gateway Network connection gives more details about that specific connection.
Below, we can see the connection details for a gateway network connection to Gateway B:
| Attribute | Description |
|---|---|
| Status | Current state of the Gateway Network Connection. |
| Average Outgoing Bytes | Average bytes of data going from the Local Gateway to the Remote Gateway per second. |
| Average Incoming Bytes | Average bytes of data going from the Remote Gateway to the Local Gateway per second. |
| Ping Time | Reaction time of Gateway connection. How fast you get a response after you've sent out a request. |
| Pending Uploads |
This feature was removed from Ignition in version 8.0.13
The number of uploads pending from the Gateway Network connection. |
| Send Threads |
The following feature is new in Ignition version 8.0.13
Click here to check out the other new features
A thread that is used by the Gateway Network to process outgoing messages from one Gateway to another. |
| Pending Downloads |
This feature was removed from Ignition in version 8.0.13
The number of downloads pending from the Gateway Network connection. |
| Receive Threads |
The following feature is new in Ignition version 8.0.13
Click here to check out the other new features
A thread that is used by the Gateway Network to process incoming messages sent from one Gateway to another. |
| Local Id | Id of the local Gateway. |
| Remote Id | Id of the remote Gateway. |
| Remote Gateway | Name of the Gateway on the Gateway network. |
| Network Address | Physical address used to communicate with all devices on the Gateway network. |
| Redundant Role | The redundancy role of the Gateway. Can either be Independent, Backup, or Master. |
| Direction | The direction of the Gateway Network connection. Can either be Incoming or Outgoing. |
| Session Id | Gateway connection session Id number. |
| Last Comm | The time of the last communication with the Gateway. |
| Fault Count | Number of errors. |
| Connection Events | Displays a list of recent connection events. |
Users can also see Remote Gateway Details by clicking on the Details button of the Remote Gateway of interest as below:
The Remote Gateway Details page offers information regarding outgoing message queues. Ignition's Gateway Network system shares information across Gateways using threads to send and receive information. This information is distributed via messages that can be tracked via the queue statistics below.
| Attributes | Description |
|---|---|
| Outgoing Queues | |
| Name | The name of the queue. |
| Priority | The priority the queue takes among other queues. |
| Enter Rate | The rate at which messages enter the queue. |
| Exit Rate | The rate at which messages exit the queue. |
| Pending | The number of pending messages in that queue. |
| Total Sent | The number of messages sent out through that queue. |
| Incoming Service Invocations | |
| Name | The name of the incoming invocation. |
| Description | A description of what the invocation is asking of the local Gateway. |
| Invocations/Sec | The number of that type of invocation per second. |
| Total | The total number of that type of invocations. |
Click on the Details button to the right of a Outgoing Queue to bring up details on the messages being sent from that queue. It lists out each message type, as well as the number of each message type per second that is being sent, as well as the total number of that message being sent.
The Sent and Queued Messages screens lists out each message type, the number of each message type per second that is being sent, and the total number of that message being sent.
| Attributes | Description |
|---|---|
| Message Type | The name and type of message. |
| Inserts/Sec | The number of messages per second. |
| Total | The rate at which messages enter the queue. |
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. As of 8.0.15, the Gateway Network page has been expanded to include additional information that will help better monitor Gateway interactions.
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:
| Attribute | Description |
|---|---|
| Status | Current state of the Gateway Network Connection. |
| Average Outgoing Bytes | Average bytes of data going from the Local Gateway to the Remote Gateway per second. |
| Average Incoming Bytes | Average bytes of data going from the Remote Gateway to the Local Gateway per second. |
| Ping Time | Reaction time of Gateway connection. How fast you get a response after you've sent out a request. |
| Active | Number of messages being actively processed by the gateway network connection. |
| Send Threads |
The following feature is new in Ignition version 8.0.13
Click here to check out the other new features
A thread that is used by the Gateway Network to upload messages from one gateway to another. |
| Receive Threads |
The following feature is new in Ignition version 8.0.13
Click here to check out the other new features
A thread that is used by the Gateway Network to download messages from one gateway to another. |
| Local Id | Id of the local Gateway. |
| Remote Id | Id of the remote Gateway. |
| Remote Gateway | Name of the Gateway on the Gateway network. |
| Network Address | Physical address used to communicate with all devices on the Gateway network. |
| Redundant Role | The redundancy role of the Gateway. Can either be Independent, Backup, or Master. |
| Direction | The direction of the Gateway Network connection. Can either be Incoming or Outgoing. |
| Session Id | Gateway connection session Id number. Connected gateways use the same session Id on both gateways. |
| Last Comm | The time of the last communication with the Gateway. |
| Fault Count | Number of times the connection has faulted since the Gateway has been started. |
| Connection Events | Displays a list of recent connection events. |
| Attribute | Description |
|---|---|
| Task Name | Name of the task that is using a thread. |
| Source Queue | The Ignition sub system queue that dispatched this task. |
| Duration Secs | This is how long in seconds it takes for a task to be performed. |
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:
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.
| Attribute | Description |
|---|---|
| Name | Name of the queue. |
| Priority | Level of priority for a queue. |
| Inserts/Sec | Rate of task inserts per second for a queue |
| Pending | Number of pending tasks in a queue that have not yet been dispatched to a Send/Receive thread. |
| Active | Number of messages being actively processed by the gateway network connection. |
| Avg Pending Secs | Average number of seconds that a task has been pending in a queue. |
| Total | Total number of tasks executed from this queue. |
| Actions | Set of actions associated with a queue. Users can both Pause and Clear a queue. |
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.
The Outgoing and Incoming Task Statistics section shows individual tasks that have been processed by the Gateway Network Connection.
| Outgoing and Incoming Tasks Attributes | Description |
|---|---|
| Name | Name of a task. |
| Description | Description for a task. |
| Queue | Queue invoking a task (For Outgoing Tasks only) |
| Invocation/Sec | Rate at which a task is invoked per second. |
| Avg Duration Secs | Average duration in seconds of the time it takes for this task to execute. |
| Total | Number of times the task has been executed in total. |
Related Topics ...