Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt

Logfiles

The Database Connector uses SLF4J with logback, which is the same logging infrastructure used in  .

Log MDC entries for configuration path, the querySet name, the query name, correlation.id, tenant id, subject.id. These will be captured when processing client requests.

Code Block
11:37:25.394 |-WARN  [http-nio-8082-exec-8] [c.f.c.d.s.MetaDataService] [mycompany ] [26d27ffe-1213-4c82-890b-cdc1a2e00e87 ] [  ] - Could not find retrieve operation for query STUDENT/addStudent. Skipping ...
11:37:27.186 |-ERROR [http-nio-8082-exec-8] [    c.f.c.d.QueryResource] [mycompany ] [26d27ffe-1213-4c82-890b-cdc1a2e00e87 ] [  ] - Error processing request for querySet STUDENT

It is very often useful to know the database and database driver name and version that is being used.  This information can be found in the logfile. An example is shown below:

Code Block
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DriverName: Microsoft JDBC Driver 6.3 for SQL Server
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DriverVersion: 6.3.1.0
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DriverMajorVersion: 6
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DriverMinorVersion: 3
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DatabaseProductName: Microsoft SQL Server
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DatabaseProductVersion: 14.00.900
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DatabaseMajorVersion: 14
2017-09-15 15:50:01.554  INFO   28614 --- [ost-startStop-1] c.f.c.d.service.ConfigurationService     : DatabaseMinorVersion: 0

Exceptions are properly logged with their stacktraces. This makes it easier to diagnose errors, which sometimes are frevvo/DBConnector specific and sometimes database specific.

All JDBC statements are logged in the DEBUG logging level. This includes the actual SQL statement used, the actual arguments, the number or rows returned and whether it was successful.

There are different logfiles for the Standalone and tomcat bundle installations.

Standalone mode

  1. Three logfiles are created in the \database\database-connector-2.5.3\logs directory:
    1. DbConnector.err.log - there is no content in this log at this time
    2. DbConnector.out.log - database connector standard out file. You can see the version of the database connector that is running in this file.
    3. DbConnector.wrapper.log - Date/Times of connector starts/stops when the Database Connector is running as a service.
  2. database-connector.YYYY-MM-DD.log - This is the main logfile for the Database Connector. You can see the results of the queryset/queries validation and output error messages in this file.

Turning on DEBUG level logging in Standalone Mode:

Log levels are controlled by the logging.level.com.frevvo.connectors.database property. Add this property to the <db-home>\database-connector-2.5.3\config\dbconnector.properties file. Restart the connector.

Create the Database Connector log in JSON format

The spring.profiles.include=logging-json property creates the logfile in JSON format. Add this property to the <db-home>\database-connector-2.5.3\config\dbconnector.properties file. Restart the connector.

Tomcat bundle

When debugging database queries refer to output error messages in <frevvo-home>\tomcat\logs\database-connector.YYYY-MM-DD.log

Turning on DEBUG level logging

Log levels are controlled by the logging.level.com.frevvo.connectors.database property.

To change the log level to DEBUG when using the tomcat bundle, follow these steps:

  1. Stop if it is running.
  2. Navigate to the <frevvo-home>\tomcat\conf directory
  3. Create/Edit the frevvo-config.properties file
  4. Add the logging.level.com.frevvo.connectors.database property with a value of DEBUG as shown

    Code Block
     logging.level.com.frevvo.connectors.database=DEBUG
  5. Save the file
  6. Restart
Create the Database Connector log in JSON format

If you want to create the connector logs in JSON format, add the spring.profiles.include=logging-json property to the frevvo-config.properties file and restart . This will create JSON logfiles for all of the frevvo spring boot based connectors - Database, Box, Filesystem, Google and SharePoint. Support for the frevvo.log file will be added in a future release.

Code Block
titlefrevvo-config.properties - This property will create logs in JSON format for all connector logs
spring.profiles.include=logging-json 

...

Emails with information about the failure will be sent when certain database operations fail. Some situations where the tenant/flow admin might receive a Doc Action failure email are:

...

Live Forms tomcat running on non-default port

...

Check the reported path. Verify that the configuration.xml is present in the same directory as the database.war file or in the C:\database\database-connector-2.5.2x\config directory for a Standalone installation. If you are running the connector in the tomcat bundle, verify that the value of the  "frevvo.connectors.database.configuration parameter in the <frevvo-home>\tomcat\conf\dbconnectorfrevvo-config.properties file reflects the correct location of the configuration.xml. An example of this property is shown below:

Code Block
<Parameter name="frevvo.connectors.database.configuration" value="c:\<frevvo-home>\frevvo\dbconfig\configuration.xml" override="false"/>=file:///C:/<path to configuration.xml>

The format of your test query URL is invalid

...