Configure metrics monitoring

Configuring metrics monitoring requires enabling monitoring, specifying allowed IP addresses, and setting a metrics collection interval.

Before you begin

Verify that monitoring servers exist and are ready for use, which typically includes:

  • A metrics monitoring server such Prometheus is configured and ready to receive metrics telemetry.
  • A fully qualified domain.tld/port combination for the monitoring server exists and is reachable from Access Gateway.
  • The port for the monitoring server is open and not blocked by any firewall.
  • If TLS is required between Access Gateway and the monitoring server, the servers client certificate is available for upload during configuration.

Configure metrics monitoring

Configuring metrics monitoring involves these tasks:

Navigate to the monitoring open telemetry sub-menu:

  1. Connect to the admin instance Access Gateway Management console.
    ssh oag-mgmt@[admin.tld]
  2. Select 4 - Monitoring
  3. Select 6 - Configure Open Telemetry

The Configure Open Telemetry API sub-menu will be display and resemble:

Configure Open Telemetry  ...

Status: Disabled[|Enabled on port 8889]
Collection interval(In seconds): 5
Allowed IPs : Configured [|not configured]

1: Enable/disable OpenTelemetry monitoring service
2: Set interval
3: Manage allowed IPs

x: Exit

The main menu displays:

  • Status: Current status of Open Telemetry, enabled or disabled.
  • Collection interval: Interval, in seconds, representing how often new metrics will be collected from the instance.
  • Allowed IPs: Either configured or not configured and representing the set of IP addresses which are allowed to interact with Open Telemetry.

Enter one of the sub functions to modify the current configuration or x to exit the sub menu.

Metrics monitoring configuration is instance specific. You must configure monitoring on each instance in a multi-instance environment.

Enable monitoring

Open Telemetry monitoring is disabled by default.
To enable or disable the Open Telemetry monitoring service:

  1. Press 1 to enable or disable the monitoring REST API.

    The enable or disable menu will display showing the current state and resembles:

    Configure OpenTelemetry . . .  
    ...
    Monitoring Service Status:[Enabled/Disabled]
    1: [Disable|Enable] OpenTelemetry monitoring service
    . . .	
    x: Exit
    
    A confirmation dialog will display.
    Note: If not allowed IPs are configured, you will be prompted to enter a set of allowed IP addresses in order to enable OpenTelemetry monitoring.
  2. Enter a set of allowed IPs, if required, or confirm to enable or disable.

Configure allowed IP addresses

Open Telemetry monitoring only allows client requests from known predefined IP addresses. Addresses can be added or deleted and changes must be committed to take effect.
To add, delete, or commit IP address changes:

  1. Enter a to add a new entry.
    The Enter IP address dialog will display and resemble
      Enter an IP address/CIDR of Prometheus instance:
    1. At the prompt enter a fully qualified IPV4 address or a CIDR address, followed by the return key.
      For example:192.168.1.19 [cr]
      The newly entered address will be added to the display.
      Configure Open Telemetry ...
      
      192.168.1.19
      . . .	
      Up - move up
      Down - move down
      d - Delete an IP Address/CIDR
      a - Add an IP Address/CIDR
      c- commit changes 
      x - exit
    2. Repeat as required to add additional IP/CIDR addresses.
  2. Enter d to delete an existing entry.
    1. Using the arrow keys, select an entry to delete and press enter.
    2. Confirm the delete.
  3. Enter c to commit changes.
    Any pending additions or deletions are then committed.
  4. Press x to return the prior menu.

Specify metrics gathering interval

Open Telemetry monitoring queries the system for metrics based on a specific interval which may be changed. The default interval value is 5 seconds.
To change the interval value:

  1. Enter 2 to specify a new monitoring interval. The new interval sub menu will display and resemble:
    Configure OpenTelemetry ...  
    
    Configure OpenTelementry Client Scheduler service interval
    
    Current client scheduler interval (in seconds): 5
    
    1: Set client scheduler interval
    . . .	
    x: Exit
    
  2. Enter 1 to update the interval.
    Enter x to exit and return the prior menu.
    1. In the confirmation dialog enter a value between 5 and 600 seconds, inclusive.
    2. Press y to confirm.

The entered value will be saved and the new interval displayed.