Monitor

The Monitor menu allows you to view the Access Gateway logs, and configure and manage the monitoring API.

Select 4 to open the Monitoring submenu.

Monitor commands

  1. Monitor logs: Display the monitor log.
  2. Enable debug: Enable debug for all services.
  3. Disable debug: Disable debug for all services.
  4. Show Memory statistics: Display current memory use statistics.
  5. Configure REST API: Manage the monitoring REST API.
  6. Exit: Exit the monitor submenu.

Enabling debug on a running Access Gateway system elevates the logging level from INFO to DEBUG and causes a considerable rise in the number of log messages generated.

Only enable debug monitoring when debugging applications and services. Failing to disable debug monitoring can cause out of disk errors and system degradation. Always return the debug state to disabled (INFO) after diagnosing system or application errors.

Monitor logs

  1. Select 1 to display monitoring messages.

  2. Enter Ctrl + c to exit Monitor Logs.

Enable debug

  1. Select 2 to enable debug.

Disable debug

  1. Select 3 to disable debug.

Show Memory statistics

  1. Select 4 to display current memory statistics including total, used, free, shared, cache in use and available.

Configure REST API

Monitoring REST API management supports three functions:

To go to the monitoring submenu where you can enable REST APIs, edit the monitoring endpoint name, and configure allowed IP addresses:

  1. Connect to the admin instance Access Gateway Management console.

    ssh oag-mgmt@[admin.tld]

  2. Select 4 - Monitoring
  3. Select 5 - Configure REST APIs

Enable or Disable monitoring

The monitoring REST APIs are disabled by default.

To enable the monitoring REST APIs:

  1. Enter 1 to change the status of the monitoring REST APIs. A confirmation message confirms the change.
  2. Press any key to continue.

Configure basic status API name

You can change the monitoring REST API endpoint name by doing the following:

  1. Enter 2 to change the endpoint name.
  2. Enter m to enter a new endpoint name.
  3. Enter the new endpoint location (for example, /mystatusendpoint).
  4. Enter c to commit the endpoint name change.
  5. Enter x to return to the previous menu.

Configure allowed IPs

The monitoring REST API only allows client requests from known predefined IP addresses. You can add and remove addresses from the list of known addresses. Commit your changes for them to take effect.

To add an IP address:

  1. Enter 3 from the Configure REST APIs menu to manage allowed IPs.
  2. Enter a to add an address.
  3. Enter a fully qualified IPv4 address or CIDR address (for example, 192.168.1.0/24).

To delete an IP address:

  1. Enter 3 from the Configure REST APIs menu to manage allowed IPs.
  2. Enter d to delete an entry.
  3. Enter the index of the address to delete.

To commit your IP address changes:

  1. Enter c to commit your changes, which include any pending additions or deletions.
  2. Enter x to return to the previous menu.