Advanced settings for Private eazyBI

Private eazyBI

You can specify eazyBI advanced settings in the config/eazybi.toml configuration file. The configuration file uses TOML format. Please see the comments and commented examples for each section in this file.

Performance optimization and tuning

Increase query timeout

By default, there is 60 seconds query timeout, after which report queries will be canceled. The purpose of this timeout is to avoid too-long execution of too complex ad-hoc queries (when you join too many dimensions in rows or columns).

If you still would like to increase this timeout value, then change the default 60 to a different value:

[mondrian]
"mondrian.rolap.queryTimeout" = 120

If you import data from a SQL source, you can increase the timeout with the following settings:

[source_application.sql]
connect_timeout = 20
read_timeout = 600
query_timeout = 600

Increase concurrent report queries

The default number of max concurrent eazyBI report queries is 10. If more MDX queries are made simultaneously, then new queries will wait until the previous will finish.

If you have a powerful server with many CPU cores and you would like to allow more concurrent MDX queries, then you can increase the max queries value in eazyBI advanced settings with:

[mondrian]
"mondrian.rolap.maxQueryThreads" = 20

If you change several Mondrian settings, then use just one [mondrian] section.

Enable Mondrian debug logging

If you would like to debug Mondrian MDX queries that are generated by eazyBI or to see all executed SQL statements, then you can enable Mondrian MDX and SQL logging with

[mondrian.log]
"mondrian" = "ERROR"
"mondrian.mdx" = "DEBUG"
"mondrian.sql" = "DEBUG"

You can see the Mondrian debug log in the log/eazybi-mondrian.log file.

Enable Mondrian request profiling

If you want to investigate Mondrian MDX queries and executed SQL statements for individual reports, then you can enable Mondrian request profiling with

[mondrian.profiling]
enable = "system_admin"

You can specify which user role will be able to perform request profiling: system_admin (only system admins), owner (only account owners and system admins), report_admin (only account report admins and system admins), user (any user who can create reports).

Then, go to the Analyze tab and Enable profiling in the other report actions dropdown. After that, every next request execution will be profiled and you can view the last profiling result with Show profiling result.

Please send the report definition and profiling result to eazyBI support if you need help with report performance optimization.

Enable Comic Style charts

If you want to enable users to switch to funny comic-style charts, then enable them with:

[ui.comic_style]
enable = true
# If needed, uncomment to make it default for all users.
# default = true

SSRF protection

SSRF (Server Side Request Forgery) protection allows preventing eazyBI REST API and SQL import from other hosts in the same local network where the eazyBI server is running. By default, SSRF protection is disabled.

Enable SSRF protection with:

[ssrf_filter]
enable = true

If you would like to allow REST API import or SQL import access to some IP addresses in the same local network, then specify the allowed_ip_addresses setting. In addition, you can specify restricted_ip_addresses to specify additional IP addresses (which are not in the local network) from which REST API import and SQL import should be restricted.

[ssrf_filter]
enable = true
allowed_ip_addresses = ["192.168.1.1", "192.168.8.1"]
restricted_ip_addresses = ["8.8.8.8", "8.8.4.4"]

In addition to this, you can use your own external proxy and then allow/restrict IP addresses in the proxy configuration. The proxy will only work for REST API import, not for SQL import.

[ssrf_filter]
enable = true
proxy = "127.0.0.1:3128"