Configuring API Suite Health Monitoring

Use this topic to configure API Suite Health Monitoring for selected API Suites in API Gateway and to configure alert thresholds and notifications in Health Service and Infor OS.

API Suite Health Monitoring requires configuration in three separate applications:

  • API Gateway: Enable monitoring rules and select error types (Target 4xx, Target 5xx, Proxy 4xx).
  • Health Service: Configure occurrence thresholds, time periods, and status code exclusions.
  • Infor OS User Settings: Enable email and Notification Center alerts in Health Notifications.

All three configuration areas must be completed for monitoring to function correctly. Enabling monitoring rules in API Gateway without configuring thresholds in Health Service does not generate alerts. Configuring thresholds without enabling personal notifications does not deliver alerts.

Quick start summary:

  1. Verify that API Suite Health Monitoring is enabled in API Gateway.
  2. Select an API Suite and enable the error types to monitor.
  3. Configure alert thresholds and optional exclusions in Health Service.
  4. Enable email and Notification Center notifications in User Settings.

Prerequisites:

  • IONAPI-Administrator role in Infor OS.
  • Access to API Gateway and Health Service.
  • At least one API Suite deployed in API Gateway.
  • A valid email address in your user profile.

Configuring monitoring rules in API Gateway

Enable monitoring and select error types for each API Suite.

  1. Select API Gateway > Monitoring > Health Monitoring Rules.
  2. Enable the Enable API Suite Health Monitoring toggle.

    When enabled, the API Suite selector and monitoring rule options become available.

  3. Select the API Suite using the selector or search field, and enable one or more error types (Target 4xx, Target 5xx, Proxy 4xx).
  4. Select Save.

Monitoring resources are created automatically in Health Service after you save. It may take up to one minute for new resources to appear.

Configuring thresholds and exclusions in Health Service

Configure alert thresholds for each monitoring resource created by API Gateway.

Monitoring resources are organized by:

  • Resource name: The API Suite name.
  • Event: API Target 5xx Errors, API Target 4xx Errors, or API Proxy 4xx Errors.
  • Module: API Gateway Target Errors or API Gateway Proxy Errors.

The minimum occurrence count is 100. This requirement prevents excessive alerting for low-volume error conditions.

Default configuration: An alert is triggered when 500 or more errors occur within the last 5 minutes.

Health Service does not accept occurrence counts below 100. For low-traffic API Suites, reaching 100 errors may take time. Plan threshold strategies accordingly.

  1. Select Health Service.
  2. Locate the monitoring resource for the API Suite and error type.
  3. Specify threshold values and optional exclusions:
    Occurrence count
    Minimum 100. Default 500.
    Time period
    Default last 5 minutes. Adjust as needed.
    StatusCode is not in
    Optional. Enter comma-separated status codes such as 415, 404, or 429 to exclude them from the threshold count.
  4. Select Save.

Enabling personal notifications

Enable notifications to receive API Suite Health Monitoring alerts.

Notifications are user-specific. Individual administrators can disable notifications for their own accounts. Coordinate within your team to ensure that at least one administrator has notifications enabled for critical API Suites.

  1. Select Health Notifications from the Infor OS user menu.
  2. Select API Gateway.
  3. Enable Send Email and Notification Center.
  4. Select Save.

Responding to alerts and investigating errors

Email notifications include:

  • Alert message indicating the configured threshold was exceeded.
  • Error count details.
  • The time period during which errors were detected.
  • A link to the Health Service monitoring resource.

Email notifications and Notification Center alerts are delivered when thresholds are exceeded. Delivery may be delayed briefly, typically under 30 seconds.

  1. Open the Health Service monitoring resource and review error trends and patterns.
  2. Select Monitoring > API Transactions Search in API Gateway to review detailed error messages and affected endpoints.
  3. Investigate backend servers for Target errors or API Gateway configuration for Proxy errors.
  4. Implement corrective actions as required.
  5. Create a support case if the issue persists. Include API Suite name, error type and count, time period, and actions taken.

Disabling monitoring for all API Suites

Disabling system-wide monitoring permanently deletes all monitoring rule configurations in API Gateway and all monitoring resources, thresholds, and exclusions in Health Service.

  1. Select API Gateway > Monitoring > Health Monitoring Rules.
  2. Disable the Enable API Suite Health Monitoring toggle.
  3. Confirm the action when prompted.

Disabling monitoring for an individual API Suite

Disabling monitoring for an individual API Suite removes only that Suite’s configurations. Other monitored Suites remain unaffected.

  1. Select API Gateway > Monitoring > Health Monitoring Rules.
  2. Select the API Suite.
  3. Disable the selected error type toggle.
  4. Select Save.

Troubleshooting API Suite Health Monitoring

Common issues and resolutions:

Monitoring resource not appearing in Health Service

  • If the resource does not appear within 2 minutes, refresh the Health Service page.
  • Verify that you selected Save in API Gateway.
  • Verify that Health Service is accessible.

Not receiving alerts

  • Verify monitoring rules are enabled and saved in API Gateway.
  • Verify thresholds are configured and saved in Health Service.
  • Verify notifications are enabled for API Gateway in Health Notifications.
  • Verify the error count reached the configured threshold.
  • Verify the email address in your user profile.
  • Check spam or junk folders for email notifications.

Threshold configuration not saving

  • Verify that the occurrence count is at least 100.
  • Verify that you have the required permissions in Health Service.
  • Check for error messages on the page.

Too many alerts or alert fatigue

  • Add status code exclusions for expected status codes.
  • Increase the occurrence count.
  • Extend the time period.
  • Disable monitoring for noncritical API Suites.