Configure Tideways Globally via php.ini
If you have only one application running on your server, then a global installation via php.ini is the most simple approach to get Tideways up and running. The different package installers for Tideways usually create an additional ini file that is automatically included from the central php.ini by the way of a conf.d or php.d extra directory. This file is usually automatically called 40-tideways.ini and you can open and modify it to make your necessary changes:
The API Key is only required configuration to make Tideways work. You can find the unique application API key inside the Tideways UI by opening up the Dropdown in the top right when inside the application, then click on "Application Settings". In the following screen scroll down to "API Key" section where you find an input field to copy the API Key from.
The following additional INI Settings can be configured:
|INI Setting||Default Value||Description|
|tideways.service||web|| You can define different services in your application to group the monitoring traffic into independent groups with their own performance, error-rate and transaction data.
See the dedicated Services configuration page for more information.
|tideways.sample_rate||25|| The percentage of how many requests are executed with the Timeline Profiler activated ("being sampled"). All other requests are still monitored for their performance and potential errors/exceptions.
See the dedicated Sampling configuration page for more information.
|tideways.enable_cli||0||By default the sample rate does not affect CLI scripts, because they are often running as very long running cronjobs and perform non-transactional high intensity tasks. If you want to enable tracing in the CLI based on the sample rate, then set this variable to 1.|
|tideways.framework||all|| Which frameworks should Tideways automatically detect for tracing details and automatic transaction naming.
The current extension at version 5 and higher can automatically detect any framework without the necessity to configure this setting.
This variable was required in the old Tideways extension until version 4 to get framework support. If you configure this setting, it might decrease profiling overhead by a very tiny amount (non measurable) on version 5.
Here is a list of supported frameworks: