How to enable query and query execution time in debug info files and HAR file?

When working with Bold BI, you may find it necessary to enable query metrics in your debug information files. This can be particularly useful for performance tuning or troubleshooting issues related to query execution times. To achieve this, you will need to modify certain properties in the application’s configuration file.

Windows and Linux:

Steps to Enable Query Metrics:

1. Navigate to the configuration file located at:

Windows: {{Bold BI Installed Location}}:\BoldServices\bi\dataservice\appsettings.json

Linux: /var/www/bold-services/application/bi/dataservice\appsettings.json

2. Open the appsettings.json file with a text editor of your choice, such as Notepad etc.
3. Locate the properties related to query metrics. You will need to enable one of the following properties based on your specific needs:

EnableQueryMetricsInDebugFiles: This property allows you to enable the logging of query metrics without the actual query text.

EnableQueryMetricsWithQueryInDebugFiles: This property enables the logging of both query metrics and the query text itself.

EnableQueryMetricsWithQueryInHAR: This property allows you to enable the widget query in the network tab of Inspect element and HAR file. Supported version: 7.8.18 and above

4. Set the value of the chosen property to true to enable it. For example:

"EnableQueryMetricsInDebugFiles": true

or

"EnableQueryMetricsWithQueryInDebugFiles": true 

5. To activate the query function in the network tab of Inspect element and HAR file, change the selected property value to true. For instance:

"EnableQueryMetricsWithQueryInHAR": true 

Note: We enabled the grid summary row query and query execution time in debug info files and HAR files.

Note: To view a query in Inspect Elements, you must right-click on the dashboard page and select Inspect. Then, click on the network tab.

6. Save the changes to the appsettings.json file.
7. Refresh the Bold BI application for changes to take effect.

Kubernetes and Docker:

You can enable environment variables for enabling query metrics in debug-info files and showing the query in HAR file:

Please note that the paths and property names mentioned are specific to Bold BI Data Service.

Additional Resources:

• Kubernetes documentation for environment variable
• Docker documentation for environment variable
• Summary Row documentation