Conversions API Gateway - Troubleshooting Tools

Businesses have control and are responsible for the operational aspect of the Conversions API Gateway infrastructure and software maintenance (including monitoring, scalability, Conversions API Gateway updates, Operating system patches, AWS account management and billing).

Troubleshooting Tools

Here are the main tools to use to monitor and troubleshoot Conversions API Gateway:

Conversions API Gateway Admin UI:

https://<Conversions API Gateway Endpoint>/hub/capig
  • Modify which events are shared from the AWS instance to Facebook’s servers via the Conversions API
  • Monitor statuses of events transiting through Conversions API Gateway

Conversions API Gateway Health-Check Endpoint:

https://<Conversions API Gateway Endpoint>/hub/health
  • Monitor the server instance status

Conversions API Gateway Shell:

https://<Conversions API Gateway Endpoint>/hub/shell
  • View the server logs and check configurations

Events Manager

  • Monitor events as received by Facebook (from both the Pixel and server connections)
  • Monitor the Conversions API Gateway integration
  • Monitor warnings and errors reported by Facebook, as well as recommended resolutions

Enabling Conversions API Gateway Logs

Enable “DEBUG” level logging from shell:

config write LogLevel /ROOT_LEVEL "DEBUG"

Wait for a few hours or a day to track logs in the system.

There are different ways to check the logs of the system.

From the Conversions API Gateway Admin UI

  • Go to Settings -> Updates
  • Click on the Download Logs button on bottom right

From AWS

  • Go to your instance and click on Cloudwatch
  • Download the group logs from there:
    1. Click on Logs Insights
    2. Select the log group of Conversions-API-Gateway
    3. Select the timeframe for at least 1 day (since DEBUG was activated would be the best case)
    4. Click on Run Query
    5. Export the results -> Download Table