-
Notifications
You must be signed in to change notification settings - Fork 629
Add Logging Helpers for Improved Traceability #464
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.
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
joel
wants to merge
6
commits into
basecamp:master
Choose a base branch
from
joel:add-logs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e37a42b
Add logs
joel 24264dc
Merge branch 'master' into add-logs
joel 3670677
Delete install-optional-apps.sh
joel dbd118c
Delete app-chrome-beta.sh
joel a78a4d2
Update install.sh
joel c231415
Fix helpers path to use OMAKUB_PATH instead of OMAKUB_ROOT
joel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,15 @@ | ||
#!/bin/bash | ||
|
||
HELPERS_PATH="${OMAKUB_PATH}/shared/helpers.sh" | ||
|
||
# Source helper functions | ||
if [ -f "$HELPERS_PATH" ]; then | ||
source "$HELPERS_PATH" | ||
else | ||
echo "Error: Helper functions not found at $HELPERS_PATH" | ||
echo "Please ensure the shared directory is properly set up." | ||
sleep 5 | ||
fi | ||
|
||
source $OMAKUB_PATH/bin/omakub-sub/header.sh | ||
source $OMAKUB_PATH/bin/omakub-sub/menu.sh |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
#!/usr/bin/env bash | ||
|
||
# Shared helper functions for Omakub installation scripts | ||
# This file contains common utilities used across multiple scripts | ||
|
||
# Define colors for output | ||
GREEN="\033[0;32m" | ||
RED="\033[0;31m" | ||
YELLOW="\033[0;33m" | ||
BLUE="\033[0;34m" | ||
BOLD="\033[1m" | ||
RESET="\033[0m" | ||
|
||
# Setup logging for scripts | ||
# Usage: setup_log "app-name" | ||
setup_log() { | ||
local app_name="$1" | ||
local timestamp=$(date '+%Y%m%d_%H%M%S') | ||
local log_dir="${HOME}/.local/share/omakub/logs" | ||
|
||
# Create logs directory if it doesn't exist | ||
mkdir -p "$log_dir" | ||
|
||
# Create log file with timestamp | ||
local log_file="${log_dir}/${app_name}_install_${timestamp}.log" | ||
|
||
# Return the log file path | ||
echo "$log_file" | ||
} | ||
|
||
# Print a formatted message with timestamp | ||
# Usage: log_message "INFO" "Message to log" "$log_file" | ||
log_message() { | ||
local level="$1" | ||
local message="$2" | ||
local log_file="$3" | ||
local timestamp=$(date '+%Y-%m-%d %H:%M:%S') | ||
|
||
case "$level" in | ||
"INFO") | ||
level_color="$BLUE" | ||
;; | ||
"SUCCESS") | ||
level_color="$GREEN" | ||
;; | ||
"WARNING") | ||
level_color="$YELLOW" | ||
;; | ||
"ERROR") | ||
level_color="$RED" | ||
;; | ||
*) | ||
level_color="$RESET" | ||
;; | ||
esac | ||
|
||
# Print to console with color | ||
echo -e "${level_color}${timestamp} [${level}]${RESET} ${message}" | ||
|
||
# Print to log file without color codes | ||
echo "${timestamp} [${level}] ${message}" >> "$log_file" | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Once you have added the
shared
folder and the helpers file, you don't need to do this check.It makes sense to assume it's there.