Skip to content

Commit

Permalink
Merge pull request #7261 from OpenLiberty/7240-Enable-verbose-garbage…
Browse files Browse the repository at this point in the history
…-collection-by-default-on-IBM-Java-Semeru

7240 enable verbose garbage collection by default on ibm java semeru-3
  • Loading branch information
ramkumar-k-9286 committed Feb 29, 2024
2 parents a8fc537 + b196880 commit 0fceb31
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions modules/ROOT/pages/log-trace-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,17 @@ Open Liberty has a unified logging component that handles messages that are writ
A server has the following four primary log files:

- `console.log` - This file is created by the `server start` command. It contains the redirected standard output and standard error streams from the underlying JVM process. This console output is formatted for human readability and it lacks some information that is useful for automated log analysis. The `console.log` file is reset when the server is restarted.
- `messages.log` - This file contains all messages that are written or captured by the logging component. All messages that are written to this file contain additional information such as the message timestamp and the ID of the thread that wrote the message. This file is suitable for automated log analysis. This file does not contain messages that are written directly by the JVM process.
- `trace.log` - This file is created only if you enable trace. It contains all the content of the `messages.log` file plus any enabled trace. This file does not contain messages that are written directly by the JVM process.
- `verbosegc.XXX.log` - This file contains the verbose garbage collection output from the JVM, generated by running IBM Java and IBM Semeru Runtimes. Upto `10` rolling log files are maintained, with each file's log number denoted by `XXX`.
- `verbosegc.XXX.log` - This file contains verbose garbage collection output from the JVM, used specifically with IBM Java and IBM Semeru Runtimes. It supports up to 10 rolling logs in the logs directory, where `XXX` represents the sequence number of the log file. Enabled by default in IBM Java, these verbose GC logs are crucial for identifying performance bottlenecks and `OutOfMemory` errors, with a negligible impact on performance of less than 1%. Although default settings apply unless altered, custom configurations can be specified to modify verbose GC behavior. To turn off verbose GC logging, add `VERBOSEGC=false` to the `server.env` file. For more information, see the https://www.ibm.com/docs/en/sdk-java-technology/8?topic=gc-verbose-logs[Verbose garbage collection logs].
The following sections provide more information about configuring your Open Liberty logs:

* <<#configuaration,Logging configuration>>
* <<#storage,Log file storage management>>
* <<#verbosegc,Verbose garbage collection logging>>
* <<#log_formats,Log formats>>
* <<#json,JSON logging>>
** <<#names,Configurable JSON field names>>
Expand Down Expand Up @@ -58,12 +60,6 @@ com.ibm.ws.logging.console.log.level=OFF
com.ibm.ws.logging.copy.system.streams=false
----

[#verbosegc]
== Verbose garbage collection logging
If you are using IBM Java, verbose garbage collection logging is enabled by default. This feature generates up to `10` rotating log files within the logs directory. The logging feature is valuable for diagnosing performance problems and `OutOfMemory` errors. Keep the logging feature active in production environments, as it impacts performance by less than 1%. If you set up your own verbose garbage collection configurations, those settings take precedence over the default ones. To turn off verbose garbage collection logging, add `VERBOSEGC=false` to your `server.env` file.

For more information, see the https://www.ibm.com/docs/en/sdk-java-technology/8?topic=gc-verbose-logs[Verbose garbage collection logs].

[#log_formats]
== Log formats

Expand Down

0 comments on commit 0fceb31

Please sign in to comment.