Detailed logging

Detailed logging captures complete request and response payloads for selected user-created non-Infor API suites at key points in the API Gateway transaction flow.

Overview

Detailed logging captures the full request and response payloads for user-created API suites, such as non-Infor, non-provisioned, and third-party suites. Payloads are recorded at four points in the transaction flow:

  • Inbound request: client to API Gateway
  • Outbound request: API Gateway to target API
  • Inbound response: target API to API Gateway
  • Outbound response: API Gateway to client

You can use detailed logging to review the exact data exchanged so you can diagnose issues, confirm transformations, and validate headers applied by policies.

Key benefits

  • Accelerated troubleshooting in custom API integrations
  • Improved reliability through validation of payload transformations and headers
  • Support for compliance and auditing with traceable transactions
  • Incident investigation using captured intermittent failures, timeout conditions, or malformed JSON or XML payloads

User roles

The IONAPI-Admin role is required to enable and use detailed logging.

Feature limits and guardrails

  • Session window: Detailed logging can be enabled for 10 minutes at a time.
  • Rate cap: Ten requests per minute; only the first ten requests in each minute are captured in detail.
  • Maximum file size: 40 MB for each downloadable log file.
  • Security retention: Files expire 24 hours after creation and are no longer available for download.
  • Scope: Only user-created suites, such as non-provisioned Infor suites and third-party or non-Infor suites, can be tracked with detailed logging.
  • Data handling: Payloads are stored temporarily in an S3 bucket and deleted automatically after 24 hours.
Note: Payloads may contain sensitive information. Use a redaction or sanitization practice before sharing logs outside the administrator or development team.

How to enable and use detailed logging

Use detailed logging when you need to capture traffic for a specific investigation window.

  1. Turn on detailed logging:

    In Infor OS, open API Gateway and select Monitoring.
  2. Select ION API Monitoring.
  3. Select Enable Detailed Logging and click Yes to confirm.
  4. Select Transaction Detail to unlock suite selection.
  5. Select the user-created API suites that you want to monitor and enable detailed logging.
  6. Save the configuration.

  1. Inspect transactions:

    Search Monitoring with an appropriate time window and API endpoint for the issue under investigation.
  2. Use the Basic / Detailed filter to show only transactions that include detailed logging.
  3. Click Download to export captured transactions for offline review. The maximum file size is 40 MB, and the download option expires after 24 hours.

Best practices

Use these best practices when working with detailed logging:

  • Plan the capture window by reproducing the issue before enabling logging, ensuring the 10-minute window captures meaningful traffic.
  • Minimize data exposure by limiting suite selection to relevant suites and deleting local copies of downloaded logs after the investigation.
  • Redact sensitive or regulated data, such as tokens, API keys, or personal information, before sharing payloads outside the immediate team.

Troubleshooting

Follow these troubleshooting tips if logs do not appear as expected:

  • No transactions appear: Confirm that Transaction Detail and detailed logging are enabled and that traffic reaches the selected suites during the 10-minute window.
  • Download fails: Verify that the file size is under 40 MB and that the file has not expired after 24 hours.
  • Expected payloads are missing: Confirm that detailed logging is enabled for the correct suite and that requests are within the ten-requests-per-minute quota.