Page History

Table of contents 

...

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 documentBlueriq 14.8 introduced the possibility to consume trace events that are pushed on a queue by the Trace Event Publisher Component and then store them in a database in an asynchronous way. See consume trace events.

Requirements

This component persists data in a database, that must be provided. See platform support for the supported databases.

Optional: the consumer functionality needs to be able to access a queue. Currently only RabbitMQ is supported. For setting this up see Configuration of RabbitMQ for Customerdata service and Trace Event Publisher.

Installation

...

In order to use this component,

...

the

This component will only write trace message to the database and not timeline messages. See Timeline SQL Store component for writing timeline messages to a separate database.

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

The datasource name is trace-sql-store.

Consume trace events

The Trace SQL Store component can store trace messages directly in the database, but it is also possible to decouple the storage of trace messages using the Trace Event Publisher Component to publish trace events to a queue and then consume them using this component.

To be able to consume event messages, the event channel needs to be configured in the

The queue configuration can be configured using a default queue (using blueriq.default.rabbitmq.* in the application.properties). When it is needed, it can be overruled using the configuration below.

Also the trace events exchange has a default, and can be overruled by configuration when needed.

# RabbitMQ configuration
blueriq.trace.event.listener.amqp.rabbitmq.host=localhost
blueriq.trace.event.listener.amqp.rabbitmq.port=5672
blueriq.trace.event.listener.amqp.rabbitmq.virtualHost=/
blueriq.trace.event.listener.amqp.rabbitmq.username=guest
blueriq.trace.event.listener.amqp.rabbitmq.password=guest
blueriq.trace.event.listener.amqp.rabbitmq.queueNames=dcmTraceEvents

blueriq.trace.event.listener.amqp.concurrency.max-concurrent-consumers=1
blueriq.trace.event.listener.amqp.concurrency.concurrent-consumers=1

# Enable consumer functionality
blueriq.trace.event.listener.amqp.enabled=true

For more information on concurrent consumers see Configuring RabbitMQ.

Enable TLS connection

To enable a secure (TLS) AMQP connection to the queue, set the property "blueriq.trace.event.listener.amqp.rabbitmq.ssl.enabled" to "true".
The default for AQMP port with TLS on RabbitMQ is '5671', it needs to be explicitly enabled though, see https://www.rabbitmq.com/ssl.html for more information.

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)

...

Use the following steps to configure the datasource:

...

1. Using JDBC datasource : this can be configured in the  application-externaldatasources.properties file. When configuring external datasources, the externaldatasources profile should be enabled.

   Code Block
   language powershell title application-externaldatasources.properties
   blueriq.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

2. Using JNDI datasource : this can be configured in the  application-jndidatasources.properties file When configuring JNDI datasources the jndidatasources profile should be enabled.

   Code Block
   language powershell title application-jndidatasources.properties
   blueriq.datasource.trace-sql-store.jndiName=java:/comp/env/jdbc/main blueriq.hibernate.trace-sql-store.hbm2ddl.auto=validate blueriq.hibernate.trace-sql-store.dialect=org.hibernate.dialect.SQLServer2012Dialect

...

Supported dialects:

• org.hibernate.dialect.SQLServer2012Dialect (for SQL Server)
• org.hibernate.dialect.Oracle10gDialect (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.