hazelcast / hazelcast/hz-docs

Docs: Feedback for Configuring Logging

Open
#1,109 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
11
Forks
112
Avg merge
20h 29m
Merged PRs (30d)
19

Description

Hi, I have some feedback about [this page](https://github.com/hazelcast/hz-docs/edit/main/docs/modules/maintain-cluster/pages/logging.adoc)

Doc says that the default value for the logging.type is **jdk: JDK logging (default)**. It is correct if you are running Hazelcast in embedded mode or if you using HazelcastServerCommandLine.

But in the provided official start **hz** start script, the default is actually configured as **log4j2**.

```
if [ -z "$LOGGING_CONFIG" ]; then
# Use the default log4j2 file
LOGGING_CONFIG="file:$HAZELCAST_HOME/config/log4j2.properties"
else
if [ -f "$LOGGING_CONFIG" ]; then
# Try if the file exists - either absolute or relative path
LOGGING_CONFIG="file:$LOGGING_CONFIG"
elif [ -f "$HAZELCAST_HOME/config/$LOGGING_CONFIG" ]; then
# Try file in the config directory
LOGGING_CONFIG="file:$HAZELCAST_HOME/config/$LOGGING_CONFIG"
else
echo "Could not find specified LOGGING_CONFIG file."
exit 1
fi
fi
```

We can update the doc to cover both scenario.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review docs/modules/maintain-cluster/pages/logging.adoc and compare its logging.type default with the provided official hz start script. Update the page to distinguish embedded mode and HazelcastServerCommandLine from the hz script scenario, then verify that both logging defaults are accurately documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.