Skip to content

Add Dynamic Configuration Changes for Diagnostics [DEX-212] #1730

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add Dynamic Configuration Changes for Diagnostics [DEX-212] #1730

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
703e370
Add dynamic changes.
emreyigit Jun 16, 2025
c6023c4
Improve the docs
emreyigit Jun 23, 2025
95bdb60
Merge branch 'main' into diagnostics-docs
emreyigit Jun 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion docs/modules/maintain-cluster/pages/monitoring.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1251,7 +1251,7 @@ want to specify the port in the monitor

Hazelcast offers an extended set of diagnostics plugins for both Hazelcast members and clients.
A dedicated log file is used to write the diagnostics content, and a rolling file approach is used to
prevent taking up too much disk space.
prevent taking up too much disk space. Also, the diagnostics can be configured dynamically via Management Center or Operator over cluster if it is not configured statically as shown below.

=== Enabling Diagnostics Logging

Expand Down Expand Up @@ -1331,6 +1331,17 @@ java -Dhazelcast.diagnostics.enabled=true
JAVA_OPTS="-Dhazelcast.diagnostics.enabled=true -Dhazelcast.diagnostics.metric.level=info -Dhazelcast.diagnostics.invocation.sample.period.seconds=30 -Dhazelcast.diagnostics.pending.invocations.period.seconds=30 -Dhazelcast.diagnostics.slowoperations.period.seconds=30 -Dhazelcast.diagnostics.storeLatency.period.seconds=60"
----
--
Dynamic Configuration::
+
--
Diagnostics can be enabled dynamically via Management Center or Operator over cluster. In order to configure dynamically, the diagnostics should not be enabled or disabled explicitly via properties. Any configuration made via properties will override dynamic configuration.

For example, if you set the `hazelcast.diagnostics.enabled` property to `true`, diagnostics cannot be disabled dynamically via Management Center or Operator. Similarly, if you set the `hazelcast.diagnostics.enabled` property to `false`, diagnostics cannot be enabled dynamically via Management Center or Operator. It also applies for other properties.

Please refer to Operator or Management Center documentation for more information on how to enable diagnostics dynamically. #TODO: link to Operator and Management Center documentation

Another improvement in dynamic diagnostics configuration is auto-off. On dynamic configuration, the diagnostics can be turned off automatically after a certain period of time. This can be configured through the Management Center or Operator.
--
====

On the Java client side, it is enough to set the following properties:
Expand Down Expand Up @@ -1869,6 +1880,8 @@ It shows statistics including the count of methods for each store (`load`, `load
latency distributions for each store. The following is an example output snippet as part of
the diagnostics log file for Hazelcast MapStore:

!NOTE: This plugin cannot be enabled dynamically due to its design restrictions.

```
17-9-2019 13:12:34 MapStoreLatency[
map[
Expand Down