Overview
Multiple methods are available for modifying the logging settings within the GLU.Engine:
- All settings can be set through the console when building through the GLU.Engine Settings.
- A subset of settings can be configured in the applicationSettings.yml file.
- A further subset can be set through the GLU.Engine APIs.
It is important to note that changes to log levels within the GLU.Engine can have a significant impact on system performance. As such, it is recommended to only run the GLU.Engine in DEBUG mode during periods of low traffic, or to increase system resource allocations to compensate for the increased logging output. The utilisation of the DEBUG mode will result in the generation of substantial log files, which can rapidly consume the allotted log storage space. Given these considerations, it is not advisable to operate the GLU.Engine in a production environment under heavy load for extended durations.
Log file Settings
The GLU.Engine generates a single log file, with historical data being transferred to older log files. The attributes of the file, including the naming convention, can be regulated.
The dynamic name, can be customised in the Application Settings file.
The log file is capable of being processed by any log management tool that can handle text-based log files. GLU has ratified the consumption of GLU.Ware logs through the use of the Elastic Stack, Dynatrace, and AWS Cloudwatch.
See GLU.Analytics Deployment Guidelines for an example of how to integrate to Elastic Stack.
The integration screens provide the capability to configure response payloads to be displayed in the logs as a single line. This enhances the readability of the text-based log files.
See Masking Sensitive Data/Parameters in Logs section for detail on how to hide any sensitive data from your Logs.
ISO8583 – Q2 Logs
GLU uses the Q2 component to generate ISO8583 logs to provide more detailed information about the processing of ISO8583 messages than is available in the standard GLU.Engine logs. The Q2 logs contain information such as the message type, message format, message fields, and any errors that occurred during processing.
Q2 logs are useful for troubleshooting issues with ISO8583 integrations using the Q2 protocol. They can be used to identify errors in message construction, data formatting, or other issues that may be causing problems with the integration.
The appSettings.yml file
It is possible to configure the various settings in a file which is include with the GLU.Engine.
The file can be found here:
../engine/config/applicationSettings.yml
If this is changed then this will require the GLU.Engine to be restarted for settings to be applied. The table below describes the parameters which can be changed in the file.
Console Dialogue label | Description | appSettings.yml parameter name | Sample Value |
---|---|---|---|
Path | Path to the log file | logging.path | /var/log |
File | Name of the log file, “.log”will be concatenated to the end of the log file. | logging.file | gluware |
Level | The Logging level. for changing the logging levels see GLU.Engine Logging Levels | logging.level.global.glu | INFO |
Management Endpoint Shutdown Enabled | It is possible to change the logging levels in real time, with out starting and stopping the GLU.Engine. To allow this to happen this field must be set too false. See GLU.Engine Logging Levels to change the settings. | management.security.enabled | false |
Max File Size | As the log file grows when its size exceeds this value (in MB), it will save this file with a unique identity and create a new file to write the logs to. | Not in appSettings.yml file. | 1000 |
Max History | In the directory/folder which the logs are being written to, there can only be this number of log files. If the number is exceeded then the oldest file will be deleted. | Not in appSettings.yml file. | 30 |
Total Size Cap | For the directory/folder which the logs are being written to, the size of the directory/folder can not exceed this value (in MB), if it does then the oldest file will be deleted. | Not in appSettings.yml file. | 50000 |
FileName Pattern | Format of mask which will be concatenated to the log file name. i.e. gluware.2021-07-29.1.log, where gluware is the file, 2021-07-29 is the FileName Pattern, 1 is the sequence number given by GLU and .log the extension. | Not in appSettings.yml file. | yyyy-MM-dd |
Pattern File | This is the header which is written on each log line. | Not in appSettings.yml file. | %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} – %msg%n |
Log file Detail
The GLU.Engines produce 1 types of log file.
Type | Log Name | Description |
---|---|---|
GLU | gluware.log | (logging.level.global.glu) |
GLUware.log
The Initial lines in the log file will contain the information in the table below. Once the GLU.Engine is running it is also possible to pull the same information through a GLU API request see Engine Info.
# | Name | Example | Description |
---|---|---|---|
1 | Process settings | 2018-12-12 08:48:47 [main] INFO global.glu.ware.GluWareApplication -Starting GluWareApplication v1.0-SNAPSHOT on ip-172-31-13-254 with PID 17022 (/home/ec2-user/test/TestApp-1.0-SNAPSHOT/engine/TestApp-1.0 | Datetimestamp LOG Level and GLU DetailsStarting Application NameInternal IP Application starts onProcess ID Application running under (PID)Path the Application on the server the process runs from. |
2 | Profile | 2018-12-12 08:48:47 [main] INFO global.glu.ware.GluWareApplication -No active profile set, falling back to default profiles: default | Datetimestamp LOG Level and GLU DetailsDetails of the profile which is used to run the engine |
3 | StartingTomcat | 2018-12-12 08:48:55 [main] INFO o.a.catalina.core.StandardService -Starting service [Tomcat] | Process ID Application running under (PID)Warning Tomcat Starting for Engine |
4 | Starting Servlet | 2018-12-12 08:48:55 [main] INFO o.a.catalina.core.StandardEngine -Starting Servlet Engine: Apache Tomcat/8.5.31 | Process ID Application running under (PID)Warning Servlet starting |
5 | Initializing Spring | 2018-12-12 08:48:56 [localhost-startStop-1] INFO o.a.c.c.C.[Tomcat].[localhost].[/] -Initializing Spring embedded WebApplicationContext | Process ID Application running under (PID)Warning Spring starting |
6 | Route Policy | 2018-12-12 08:48:57 [main] INFO o.a.c.s.boot.CamelAutoConfiguration -Using custom RoutePolicyFactory with id: metricsRoutePolicyFactory and implementation: org.apache.camel.component.metrics.routepolicy.MetricsRoutePolicyFactory@75e91545 | Process ID Application running under (PID)Route Policy |
7 | Type converters | 2018-12-12 08:48:58 [main] INFO o.a.c.i.c.DefaultTypeConverter -Type converters loaded (core: 193, classpath: 30) | Process ID Application running under (PID)Details on the Type converters. |
8 | Integration Path | 2018-12-12 08:48:58 [main] INFO g.glu.ware.platform.utils.GluLogging -Integration Config Path :/home/ec2-user/test/TestApp-1.0-SNAPSHOT/engine/config/flows.json | Process ID Application running under (PID)Path to flows.json file with configuration of the engine defined. |
9 | Application | 2018-12-12 08:48:58 [main] INFO g.glu.ware.platform.utils.GluLogging -Application :FlashApp | Process ID Application running under (PID)Application name. |
10 | Code | 2018-12-12 08:48:58 [main] INFO g.glu.ware.platform.utils.GluLogging -Client :Flash CODE : [17194] | Process ID Application running under (PID)GLU Client Name Unique Code reference. |
11 | Version | 2018-12-12 08:48:58 [main] INFO g.glu.ware.platform.utils.GluLogging -Version :1.0-SNAPSHOT | Process ID Application running under (PID)Version of the Application being run. |
12 | Spec | 2018-12-12 08:48:58 [main] INFO g.glu.ware.platform.utils.GluLogging -Integeration Spec Name :Integration Spec.[V.1.0] | Process ID Application running under (PID)Name of the Integration being run. |
13 | Menu builder details | 2018-12-12 08:48:58 [main] INFO g.glu.ware.platform.utils.GluLogging -Menu :There is NO Menu Builder | Process ID Application running under (PID)Name of the Menu Builder if it is included in the Application. |
14 | Build Date & Time | 2018-12-12 08:48:58 [main] INFO g.glu.ware.platform.utils.GluLogging -Date built / Release :Wed, 12 Dec 2018 10:45:31 +0200 | Process ID Application running under (PID)Date the Application was built. |
15 | Build EnvironmentConnector details | 2018-12-12 08:48:58 [main] INFO g.glu.ware.platform.utils.GluLogging -Build Environment :GLUEN3 Conn To STUBSENV | Process ID Application running under (PID)the environment the Build was triggered from. |
Log Levels
See the GLU.Engine Log Levels page for details.