Last updated 11th May 2021
Objective
Web PaaS supports Tideways APM for PHP. This functionality is only available on PHP 7.0 and later.
The upstream now maintains two versions for Tideways, and both plugins are available on Web PaaS: tideways_xhprof: The open source version, therefore no licensing is required (On the downside, less integration services are available). You can use it in combination with xhprof UI. tideways: The bundle proprietary full version of the product and plugins, which the rest of the guide is mostly aimed to cover.
Get Started
1. Get your license key
Sign up at https://tideways.com and get your license key.
2. Add your license key
Add your Tideways license key as a project level variable:
webpaas variable:create --visible-build false php:tideways.api_key --value '<your-license-key>'
3. Enable the Tideways extension
Enable the Tideways extension in your .platform.app.yaml as follows:
runtime:
extensions:
- tideways
Enabling the extension will also activate the Tideways background process.
Push the changes to your Web PaaS environment to enable Tideways as follows:
git add .platform.app.yaml
git commit -m "Enable Tideways."
git push
Tideways should now be enabled. Give it a few hours to a day to get a decent set of data before checking your Tideways dashboard.
Deployment Integration
Tideways integrates with Web PaaS deployment hooks and provides performance comparisons before and after deployments were released. You can find the Web PaaS CLI command to register this hook for your application in Tideways "Application Settings" screen under the section "Exports & Integrations". Here is an example:
webpaas integration:add --type=webhook --url="https://app.tideways.io/api/events/external/1234/abcdefghijklmnopqrstuvwxyz1234567890"
Did you find this guide useful?
Please feel free to give any suggestions in order to improve this documentation.
Whether your feedback is about images, content, or structure, please share it, so that we can improve it together.
Your support requests will not be processed via this form. To do this, please use the "Create a ticket" form.
Thank you. Your feedback has been received.