Skip to main content

Internal Monitoring (Pull)

To enable internal monitoring of the 1Gateway instance...

Internal Monitoring (Pull)

To enable internal monitoring of the 1Gateway instance, you must set it up within your existing enterprise monitoring tool (e.g., Ceeview).

Steps:

  1. Execute the HTTP GET requests below at regular intervals (not less than 1 minute).
  2. Take appropriate action based on the HTTP response.

Available URLs for Anomaly Detection​

  • For warning messages – GET request syntax: 
    https://<1gateway-instance>/api/v3/plugin/status?running=true&CurrentState=warning

  • For error messages – GET request syntax:
https://<1gateway-instance>/api/v3/plugin/status?notCurrentState=active&CurrentState=errors
  • For expired license or inactive plugins – GET request syntax:
https://<1gateway-instance>/api/v3/plugin/status?DesiredState=active&notCurrentState=active

This happens when the license has expired and the plugins are not started automatically by the monitor plugin anymore.

HTTP - Get Response​

  • Normal response. A normal response returns an empty JSON body:
{}
  • Unexpected response. A JSON body with content other than {} indicates an issue.

Example response may look like this:

{
  "giniTo": {
    "CurrentTraffic": 2.9924192046814735,
    "Product": "Groovy",
    "pluginKey": "plugin-groovy-sender",
    "Severity": 3,
    "Queued": 0,
    "Errors": [
      "2024-07-19 06:21:26 Startup done.",
      "2024-07-19 06:24:38 Shutting down.",
      "2024-07-19 06:24:40 Shutdown complete.",
      "2024-07-19 06:25:56 Error Connect to service-nom.com:443"
    ]
  },
  "endpoint": "...",
  "DesiredState": "active",
  "CurrentState": "warning",
  "LastMessageTimestamp": 172139401601,
  "Running": true,
  "QueueName": "...",
  "Plugin": "..."
}

Where you can see the error displayed "2024-07-19 06:25:56 Error Connect to service-nom.com:443"

Analyze – Unexpected Status​

  • Plugin Log:

    1. Select the plugin with the unexpected status.

    2. Open the right-side menu for that plugin.

    3. Select Plugin Log.

  • 1Gateway Log:

    1. Open the menu using the left menu icon.

    2. Select Log.

Clear – Unexpected Status​

You must activate the affected plugin. This clears the status in 1Gateway and ensures the next HTTP request returns a good status.

Steps:

  1. Select the plugin with the unexpected status.
  2. In the right-side menu, select Activate.
  3. The plugin status should now be cleared.
  4. The indicator will change to green.