Conversions API Gateway System Health Information
System Health Information is log data you can choose to send us periodically from your Conversions API Gateway server. System Health Information can help improve the setup onboarding flow, facilitate live troubleshooting and issue identification, and improve the product overall.
How System Health Information Works
System Health Information is an optional feature you can enable during installation by choosing ‘Yes’ in the SystemHealthInformation dropdown list as shown below.
After installation, System Health Information can be enabled or disabled by using the Conversions API Gateway shell interface:
- Go to the Conversions API Gateway shell interface by opening the URL:
https://<YOUR_CAPIG_HOST_NAME>/hub/shell
- Type in the following command to enable System Health Information:
config write SolutionsHub /SHOULD_USE_ACTIVE_TELEMETRY true
Replace true with false to disable.
Types of System Health Information Data
System Health Information data includes information about your Conversions API Gateway setup such as:
- System status: Information about the Conversions API Gateway server statuses such as CPU and memory usages, SSL certificate status, and automatic update status.
- Installation: Information about the Conversions API Gateway setup such as the launch time, software version, and domain name.
- Event status: Information about the processing of events within the Conversions API Gateway such as event statistics and active pixels.
- Error logs: Information about errors and failures when running, such as installation errors and event errors.
- Feedback: Feedback you report may be used to help improve the Conversions API Gateway.
