Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added rabbitmq cluster documentation

Installation

The audit consumer can be installed using the installerRuntime zip. After installationunpacking the Runtime zip, the configuration of the audit consumer can be found in the <blueriq installation home>\Services\blueriq-audit-consumer \conf folderfolder. The audit consumer is runnable by executing the jar file with java.

Alternatively, you can install the audit consumer on of the supported platforms of Blueriq. The supported platforms for the audit consumer match the ones for the Runtime. The installation procedure also resembles the ones for the Runtime, basically it is deploying the WAR, configure a config location and the suitable JDBC driver. See Installing Runtime for details on each specific platform.

Although it is possible to deploy the Audit Consumer in the same JVM as the Blueriq Runtime, we recommend, at least for acceptance and production environments, to deploy it on its own JVM or depending on the throughput of the application, on its own server.

System requirements

Minimal

2 CPU cores
256 MB Heap

2 CPU cores
512 MB Heap

Panel

Table of contents

Table of Contents
maxLevel3

Configuration

The audit consumer is required by the Audit component, so when this component is used the following needs to be configured first.

External config location

For supplying configuration from an external location you need to configure the spring.config.additional-location for the application. See the Config location section for your application platform on the page Installing Runtime

Create database

Scripts to create the required database content are provided for the following databases:

  • Oracle

Use the appropriate scripts to create the tables on your database.

Datasource configuration

. In the documentation below, the <service> is audit, the <datasource-name> is audit-sql-store and the configuration YAML is application.yml.

Include Page
_DatasourceConfigurationYaml
_DatasourceConfigurationYaml

JNDI

If you would like to use JNDI to configure your datasource, replace the blueriq.audit.consumer.datasource section in the application.yml described above with the following:For the audit consumer to work, a datasource needs to be configured in application.yml. This file is placed in the following folder by the installer: <Blueriq installation folder>\Services\audit-consumer\conf.

Code Block
languagetext
titledatasource
blueriq:
  audit:
    consumer:
      datasource:
        audit-sql-store:
                url: ---
          username: ---
          password: ---
          driver-class-name: oracle.jdbc.driver.OracleDriver

For additional datasource configuration please see the #DATASOURCE section in the Spring property documentation We recommend setting a validation query so that when a database connection is lost due to a network failure for instance, it can be recovered once the network is restored. The validation query is database specific, the query below works with SQL Server (and H2), for Oracle use SELECT 1 FROM DUAL. For more information on configuring datasources, see How to configure BasicDataSource Configuration Parameters.

Database drivers

Depending on the underlying database, a specific driver needs to be installed on the application server as described on Configuring JDBC database drivers.

Rabbit mq
  
			jndi-name: java:jboss/datasources/auditConsumerSqlStoreJndiName

RabbitMQ configuration

For the audit consumer to work, rabbit mq needs to be configured in blueriq-audit-consumer.yml. This file is placed in the location the following configuration folder by the installer: <Blueriq installation folder>\Services\audit-consumer\confwhere you install the audit consumer.

Code Block
languagetext
titlerabbitmq
blueriq:
  audit:
    consumer:
      rabbitmq:
        host: ---
        port: ---
        virtualHost: ---
        username: ---
        password: ---
        ssl:
          enabled: ---
        queueNames: ---
		errorExchange: ---	
		# From blueriq version 16.9 it is possible to declare multiple hosts (RabbitMQ Cluster)
        addresses: localhost:30012,otherhost:25102               

The configured queue should be bound to the exchange where the Audit component writes its messages to.