Skip to content

[refactor] Move Logging from init.d to Agent #229

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
shwetd19 wants to merge 7 commits into
base: master
Choose a base branch
from
Open

[refactor] Move Logging from init.d to Agent #229

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c8a778a
[change] Moved log messages from init.d to agent
shwetd19 Feb 13, 2025
bcb1dbe
[refactor] modified the log_message function
shwetd19 Feb 14, 2025
18fbb4d
[refactor] Move logging from init.d to agent
shwetd19 Feb 22, 2025
46325b5
[refactor] Move logging from init.d to agent
shwetd19 Feb 28, 2025
6d1c03d
[refactor] Move logging from init.d to agent
shwetd19 Feb 28, 2025
4beafe2
[refactor] Move logging from init.d to agent
shwetd19 Feb 28, 2025
deb625f
[refactor] Move logging from init.d to agent
shwetd19 Feb 28, 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
16 changes: 16 additions & 0 deletions openwisp-config/files/openwisp.agent
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,10 @@ while [ -n "$1" ]; do
export CHECKSUM_RETRY_DELAY="$2"
shift
;;
--log-message)
log_message "$2"
exit 0
;;
-*)
echo "Invalid option: $1"
exit 1
Expand Down Expand Up @@ -971,3 +975,15 @@ while true; do
# ignore SIGUSR1 signals again
trap "" USR1
done

# Logging function
log_message() {
local level="$1"
local message="${2:-}" # Default to an empty string if the second argument is not provided
Copy link
Member

@okraits okraits Feb 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would make the message mandatory. For the level I would fall back to daemon.info if none is provided.


if [ -z "$message" ]; then
Copy link
Member

@okraits okraits Feb 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need this if statement. You can provide a default value in the assignment of the message variable.

Copy link
Author

@shwetd19 shwetd19 Feb 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is the if [ -z "$message" ] check unnecessary when we already have local message="${2:-}"? Could you clarify the reasoning?

Copy link
Member

@devkapilbansal devkapilbansal Feb 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @shwetd19
If you see the above comment, Oliver suggested a fall back when message is not provided. In that case, this check will be unnecessary

logger -t openwisp -p "$level" "No message provided"
else
logger -t openwisp -p "$level" "$message"
fi
}
4 changes: 2 additions & 2 deletions openwisp-config/files/openwisp.init
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ start_service() {
config_foreach parse_config controller
procd_set_param respawn "${respawn_threshold:-3600}" "${respawn_timeout:-5}" "${respawn_retry:-5}"
procd_close_instance
logger -s "$PROG_NAME started" -t openwisp -p daemon.info
/usr/sbin/openwisp-config --log-message "$PROG_NAME started"
}

service_triggers() {
Expand All @@ -87,7 +87,7 @@ stop_service() {
}

reload_service() {
logger -s "$PROG_NAME received reload trigger" -t openwisp -p daemon.info
/usr/sbin/openwisp-config --log-message "$PROG_NAME received reload trigger"
# avoid reloading while configuration is being applied
# will wait for a maximum of 30 seconds
for _ in $(seq 1 30); do
Expand Down
3 changes: 2 additions & 1 deletion openwisp-config/files/sbin/openwisp-reload-config
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ if [ -f $MD5FILE ]; then
logger_msg="Service $service has been reloaded via init.d script"
fi
# log which service has been reloaded and how
logger "$logger_msg" -t openwisp -p daemon.info
/usr/sbin/openwisp-config --log-message "$logger_msg"

done
fi
md5sum /var/run/config.check/* >$MD5FILE
Expand Down
Loading