Quality assurance and monitoring
It is essential to ensure that all your data is as correct as possible. Significant errors, such as undetected
deviations between imported platform data and data within the platforms itself, might seriously harm your marketing
efforts. You should therefore establish sound monitoring and alerting processes.
Logging
Various console-commands and background tasks (importing, merging etc.) write their logs to
aom-tasks.log. All other logs (visitor requests, requests to this plugin's API endpoints, Piwik UI
interactions etc.) are written to aom.log. All log files are stored in Piwik's main directory.
You can filter aom-tasks.log for specific console-commands and background tasks by searching for strings
like {"platform":"AdWords","task":"import"} or WARNING.
It might be a good idea to rotate these log files on a daily basis.
Monitoring
...
Monitoring API endpoints
By monitoring the API endpoint AOM.getStatus you can easily validate
- that Piwik gathers tracking data like visits and orders,
- that the marketing data imports are working and
- that the matching of visits and marketing data is working.
The API endpoint AOM.getReprocessedVisitsStatus enables you to easily validate
- the reprocessed visits data overall,
- the reprocessed visits data overall (by appending &groupByChannel=true),
- the marketing costs (per platform) when comparing to the the platform data (manually).
Monitoring database contents
...
Monitoring log files
You should monitor aom-tasks.log automatically. Some checks that might be useful:
- Search for errors during AdWords' import:
grep "ERROR" aom-tasks.log | grep "AdWords" | grep "import"
- ...
Manual monitoring efforts
...
Alerting
Based on the monitoring possibilities described above, you should setup alerting processes that inform those who are
responsible as soon as possible after an error is being detected.
Support
If you need need assistance in ensuring data quality, please feel free to get in touch.
