Skip to content

Use parent STDOUT for logging output #172

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

Merged
frenck merged 2 commits into from
Sep 23, 2025
Merged

Use parent STDOUT for logging output #172

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d998311
Use parent STDOUT for logging output
PaulSD Sep 21, 2025
c8982c2
Switch from `echo -e` to the safer `printf '%b\n'` in log functions
PaulSD Sep 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
24 changes: 16 additions & 8 deletions lib/log.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@
# to be included in add-on scripts to reduce code duplication across add-ons.
# ==============================================================================

# Unless $LOG_FD is already set to a valid fd
if ! [[ "$LOG_FD" =~ ^[0-9]+$ ]] || ! { true >&"$LOG_FD" ; } 2>/dev/null ; then
# Preserve the original STDOUT on a free fd (stored in $LOG_FD) so that we can
# log to it without interfering with the STDOUT of subshells whose output we
# want to capture for other purposes.
exec {LOG_FD}>&1
fi

# ------------------------------------------------------------------------------
# Log a message to output.
#
Expand All @@ -15,7 +23,7 @@
# ------------------------------------------------------------------------------
bashio::log() {
local message=$*
echo -e "${message}"
printf '%b\n' "${message}" >&"$LOG_FD"
return "${__BASHIO_EXIT_OK}"
}

Expand All @@ -27,7 +35,7 @@ bashio::log() {
# ------------------------------------------------------------------------------
bashio::log.red() {
local message=$*
echo -e "${__BASHIO_COLORS_RED}${message}${__BASHIO_COLORS_RESET}"
printf '%b\n' "${__BASHIO_COLORS_RED}${message}${__BASHIO_COLORS_RESET}" >&"$LOG_FD"
return "${__BASHIO_EXIT_OK}"
}

Expand All @@ -39,7 +47,7 @@ bashio::log.red() {
# ------------------------------------------------------------------------------
bashio::log.green() {
local message=$*
echo -e "${__BASHIO_COLORS_GREEN}${message}${__BASHIO_COLORS_RESET}"
printf '%b\n' "${__BASHIO_COLORS_GREEN}${message}${__BASHIO_COLORS_RESET}" >&"$LOG_FD"
return "${__BASHIO_EXIT_OK}"
}

Expand All @@ -51,7 +59,7 @@ bashio::log.green() {
# ------------------------------------------------------------------------------
bashio::log.yellow() {
local message=$*
echo -e "${__BASHIO_COLORS_YELLOW}${message}${__BASHIO_COLORS_RESET}"
printf '%b\n' "${__BASHIO_COLORS_YELLOW}${message}${__BASHIO_COLORS_RESET}" >&"$LOG_FD"
return "${__BASHIO_EXIT_OK}"
}

Expand All @@ -63,7 +71,7 @@ bashio::log.yellow() {
# ------------------------------------------------------------------------------
bashio::log.blue() {
local message=$*
echo -e "${__BASHIO_COLORS_BLUE}${message}${__BASHIO_COLORS_RESET}"
printf '%b\n' "${__BASHIO_COLORS_BLUE}${message}${__BASHIO_COLORS_RESET}" >&"$LOG_FD"
return "${__BASHIO_EXIT_OK}"
}

Expand All @@ -75,7 +83,7 @@ bashio::log.blue() {
# ------------------------------------------------------------------------------
bashio::log.magenta() {
local message=$*
echo -e "${__BASHIO_COLORS_MAGENTA}${message}${__BASHIO_COLORS_RESET}"
printf '%b\n' "${__BASHIO_COLORS_MAGENTA}${message}${__BASHIO_COLORS_RESET}" >&"$LOG_FD"
return "${__BASHIO_EXIT_OK}"
}

Expand All @@ -87,7 +95,7 @@ bashio::log.magenta() {
# ------------------------------------------------------------------------------
bashio::log.cyan() {
local message=$*
echo -e "${__BASHIO_COLORS_CYAN}${message}${__BASHIO_COLORS_RESET}"
printf '%b\n' "${__BASHIO_COLORS_CYAN}${message}${__BASHIO_COLORS_RESET}" >&"$LOG_FD"
return "${__BASHIO_EXIT_OK}"
}

Expand Down Expand Up @@ -115,7 +123,7 @@ function bashio::log.log() {
output="${output//\{MESSAGE\}/"${message}"}"
output="${output//\{LEVEL\}/"${__BASHIO_LOG_LEVELS[$level]}"}"

echo -e "${output}"
printf '%b\n' "${output}" >&"$LOG_FD"

return "${__BASHIO_EXIT_OK}"
}
Expand Down
Loading