You are viewing the documentation for Blueriq 13. Documentation for other versions is available in our documentation directory.
Table of contents
Description
This Trace SQL Store Component contains a Trace DAO implementation that can be used by the trace engine to store trace messages in a database.
The configuration options are found below in this document.
Requirements
This component persists data in a database, that must be provided. See platform support for the supported databases.
Installation
In order to use this component, the trace-sql-store profile must be active. More information on how to configure the application using Spring Profiles can be found here : Component configuration with Spring Profiles.
Add the artifact with groupId "com.blueriq"
and artifactId "blueriq-component-trace-sql-store"
as a dependency to your Blueriq runtime POM file if you want to depend on it.
Configuration
Database
Scripts to create the required database content are provided for the following databases:
- SQL Server
- Oracle
- H2 (we do not recommend using a H2 database in production environments)
For customers that are upgrading an existing version of Blueriq, database upgrade scripts are provided in the Upgrade instructions when applicable.
Please make sure the trace-sql-store has a separate datasource. Using the same datasource for other components is known to cause errors.
Use the following steps to configure the datasource:
- If necessary, create a new datasource. See Configuring JDBC database drivers for information on how to do this.
- Trace SQL Store component is using the trace-sql-store datasource to store data. The trace-sql-store datasource can be configured using JDBC or JNDI.
Using JDBC datasource : this can be configured in the
application-externaldatasources.properties
file. When configuring external datasources, theexternaldatasources
profile should be enabled.application-externaldatasources.propertiesblueriq.datasource.trace-sql-store.url=jdbc:sqlserver://<database_url>:<port>;databaseName=bq_comments;instance=SQL_EXPRESS blueriq.datasource.trace-sql-store.username=<username> blueriq.datasource.trace-sql-store.password=<password> blueriq.datasource.trace-sql-store.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver blueriq.hibernate.trace-sql-store.hbm2ddl.auto=validate blueriq.hibernate.trace-sql-store.dialect=org.hibernate.dialect.SQLServer2012Dialect
Using JNDI datasource : this can be configured in the
application-jndidatasources.properties
file When configuring JNDI datasources thejndidatasources
profile should be enabled.application-jndidatasources.propertiesblueriq.datasource.trace-sql-store.jndiName=java:/comp/env/jdbc/blueriqTrace blueriq.hibernate.trace-sql-store.hbm2ddl.auto=validate blueriq.hibernate.trace-sql-store.dialect=org.hibernate.dialect.SQLServer2012Dialect
- Configuring the datasource from the Development Dashboard
Go to Settings Widget → Datasources tab → On the left side menu : selecttrace-sql-store
datasource. The same properties are available for configuration as from the properties file. Make sure the corresponding profile is enabled (externaldatasources or jndidatasources) - Hibernate settings
These settings are done for each datasource type in the corresponding properties file, as in the examples above.
Supported dialects:
- org.hibernate.dialect.SQLServer2012Dialect (for SQL Server)
- org.hibernate.dialect.Oracle12cDialect (for Oracle)
- org.hibernate.dialect.H2Dialect (for H2) (we do not recommend using a H2 database in production environments)
Supported hbm2ddl.auto values:
- none
- validate
Performance
The performance impact of the Trace SQL Store is minimal when used normally: to write trace messages to the database.
It is also possible to use the Trace SQL Store to query the trace engine database, like the timeline container does. The Trace SQL Store offers good performance as long as the result set is limited. For large scale analysis, when summaries or aggregates are desired, the Trace SQL Store is not recommended because it is primarily designed to return a list of trace entries. For these scenarios it is recommended to use SQL (or HQL) to query the database.
1 Comment
Steffie de Roover
Is there documentation about the data that is stored in the Trace-tables? I would expect some overview of what the table looks like and then for each column an explanation as on how it is filled.