API Suite Health Monitoring

API Suite Health Monitoring enables administrators to monitor selected API Suites in API Gateway and receive alerts from Health Service when configured error thresholds are exceeded.

API Suite Health Monitoring is a proactive monitoring capability that helps you track the health and performance of API Suites in real time. By integrating API Gateway with the Health Service application, administrators can monitor selected API Suites and receive automated alerts when specific error conditions occur.

Instead of manually reviewing logs or waiting for users to report problems, you can configure monitoring rules that track 4xx and 5xx errors on both the proxy and target sides of API calls. When thresholds are exceeded, notifications are delivered so that issues can be investigated and resolved before they escalate.

This feature is intended for users with the IONAPI-Administrator role who manage API Gateway configurations, monitor API Suite performance, respond to service disruptions, and maintain reliable API delivery.

Note: This feature is not available in Infor Government Solutions (IGS).

Business benefits

API Suite Health Monitoring provides proactive visibility into API health and performance.

  • Proactive issue detection: Identify API errors before they impact users or business operations.
  • Reduced downtime: Receive immediate notifications when thresholds are exceeded to support faster investigation and resolution.
  • Selective monitoring: Monitor specific API Suites and specific error types.
  • Customizable alerting: Configure thresholds and exclude specific status codes to align with service objectives.
  • Improved visibility: Analyze error patterns and trends to support infrastructure planning and optimization.

Monitoring rules and error types

Monitoring rules allow you to track specific API error categories.

  • Target 4xx errors: Client errors returned by backend target servers, such as 400 (Bad Request) or 404 (Not Found).
  • Target 5xx errors: Server errors returned by backend target servers, such as 500 (Internal Server Error) or 503 (Service Unavailable).
  • Proxy 4xx errors: Client errors that occur within API Gateway before the request reaches the backend target server.

Target errors versus proxy errors

Target errors occur when API Gateway forwards a client request to a backend target server and the target server returns an error response.

Proxy errors occur when API Gateway returns an error response before the request reaches the backend target server.

Threshold configuration and status code filtering

Health Service evaluates monitoring data against configurable thresholds.

  • Occurrence:
    • Default threshold: 500 occurrences in the last 5 minutes.
    • Minimum threshold: 100 occurrences.
  • Configurable time period, for example 15 minutes.

Status code not in: You can exclude specific status codes from threshold evaluation. For example, excluding status codes 415, 404, or 429 prevents those errors from contributing to the occurrence count.

Notification delivery timing

Alerts are triggered when the configured threshold is reached within the defined time period.

Email notifications and Notification Center alerts are delivered when thresholds are exceeded. Delivery typically occurs within 30 seconds of threshold evaluation.

Monitoring data flow and service behavior

API Gateway continuously collects error data for monitored API Suites and sends monitoring data to Health Service in near real time.

Health Service evaluates collected data against configured thresholds and generates alerts when conditions are met.

Service disruption scenarios

If Health Service is temporarily unavailable, monitoring data may be queued for a limited time.

Extended outages may result in data loss, and some errors may not trigger alerts.

Monitoring resumes automatically when Health Service becomes available.

Access points and prerequisites

To use API Suite Health Monitoring, ensure that these requirements are met:

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

Health monitoring features are accessed from:

  • API Gateway > Monitoring > Health Monitoring Rules
  • Health Service
  • User Settings > Health Notifications

Configuration persistence and data retention

When monitoring is disabled system-wide, monitoring rules in API Gateway and monitoring resources in Health Service are permanently removed.

Threshold configurations and status code exclusions are deleted.

Historical alert data remains accessible in notification history even after monitoring is disabled.

Best practices for API Suite Health Monitoring

Coordinate monitoring responsibilities within your team to ensure that alerts are reviewed and acted upon.

  • Designate primary and backup administrators for critical API Suites.
  • Document monitoring ownership and escalation procedures.
  • Review thresholds periodically to align with traffic volume.
  • Use status code exclusions to reduce unnecessary alerts.
  • Ensure at least one administrator has notifications enabled for critical API Suites.