Logging framework in Bash Scripting - Time & Space Complexity

Time Complexity: Logging framework

O(n)

Understanding Time Complexity

When using a logging framework in bash scripts, it's important to understand how the time to write logs grows as the number of log messages increases.

We want to know how the script's running time changes when it writes many log entries.

Scenario Under Consideration

Analyze the time complexity of the following bash logging function used repeatedly.

log_message() {
  local level="$1"
  local message="$2"
  echo "$(date '+%Y-%m-%d %H:%M:%S') [$level] $message" >> script.log
}

for i in $(seq 1 $n); do
  log_message "INFO" "Processing item $i"
done
    

This code writes a timestamped log message to a file for each item processed in a loop.

Identify Repeating Operations

• Primary operation: Writing a log message to the file inside the loop.
• How many times: The loop runs n times, so the log write happens n times.

How Execution Grows With Input

Each new log message adds one write operation, so the total work grows directly with the number of messages.

Input Size (n)	Approx. Operations
10	10 log writes
100	100 log writes
1000	1000 log writes

Pattern observation: Doubling the number of log messages doubles the total time spent writing logs.

Final Time Complexity

Time Complexity: O(n)

This means the time to write logs grows linearly with the number of log messages.

Common Mistake

[X] Wrong: "Writing logs is instant and does not affect script speed regardless of how many messages are logged."

[OK] Correct: Each log write takes time, so more messages mean more time spent writing, which slows down the script.

Interview Connect

Understanding how logging affects script performance shows you can write efficient scripts and manage resources well, a useful skill in real projects.

Self-Check

What if we buffered all log messages and wrote them to the file once at the end? How would the time complexity change?

Practice

1. What is the main purpose of a logging framework in a bash script?

easy

A. To record important messages during script execution

B. To speed up the script execution

C. To change file permissions automatically

D. To delete temporary files after running

Solution

1. Step 1: Understand logging role

   Logging records messages that help track what the script does while running.

2. Step 2: Compare options

   Only To record important messages during script execution describes recording messages; others describe unrelated tasks.

3. Final Answer:

   To record important messages during script execution -> Option A

4. Quick Check:

   Logging = record messages [OK]

Hint: Logging means saving messages about script actions [OK]

Common Mistakes:

• Confusing logging with script speed optimization
• Thinking logging changes file permissions
• Assuming logging deletes files automatically

2. Which of the following is the correct syntax to define a simple logging function in bash that prints a message with a timestamp?

easy

A. log() echo "$(date) - $1"

B. log = echo "$(date) - $1"

C. function log echo "$(date) - $1"

D. log() { echo "$(date) - $1"; }

Solution

1. Step 1: Review bash function syntax

   Functions use the format: name() { commands; }.

2. Step 2: Check each option

   log() { echo "$(date) - $1"; } correctly defines a function with braces and echo command. Others have syntax errors.

3. Final Answer:

   log() { echo "$(date) - $1"; } -> Option D

4. Quick Check:

   Function syntax with braces = log() { echo "$(date) - $1"; } [OK]

Hint: Bash functions need () and braces { } [OK]

Common Mistakes:

• Using spaces around = in function definition
• Omitting braces {} for function body
• Writing function without parentheses ()

3. Given the bash function:

log() { echo "$(date +'%Y-%m-%d %H:%M:%S') [$1] $2"; }

What is the output of log INFO "Script started"?

medium

A. Script started [INFO]

B. [INFO] Script started

C. 2024-06-01 12:00:00 [INFO] Script started

D. INFO Script started

Solution

1. Step 1: Understand function parameters

   $1 is the log level (INFO), $2 is the message (Script started).

2. Step 2: Understand echo format

   It prints date, then [$1], then $2, so output is timestamp + [INFO] + message.

3. Final Answer:

   2024-06-01 12:00:00 [INFO] Script started -> Option C

4. Quick Check:

   Format = timestamp + [level] + message [OK]

Hint: First param is level, second is message in log() [OK]

Common Mistakes:

• Mixing order of parameters
• Ignoring timestamp format
• Missing brackets around log level

4. You have this logging function:

log() { echo "$(date +'%Y-%m-%d %H:%M:%S') [$1] $2"; }

But when you run log ERROR it prints:
2024-06-01 12:00:00 [ERROR]
What is the problem?

medium

A. Missing second argument for the message

B. Date command syntax is wrong

C. Function name 'log' is reserved

D. Brackets around $1 cause error

Solution

1. Step 1: Check function usage

   Function expects two arguments: level and message.

2. Step 2: Analyze output

   Only level is given, so message ($2) is empty, causing missing text after [ERROR].

3. Final Answer:

   Missing second argument for the message -> Option A

4. Quick Check:

   Two args needed: level and message [OK]

Hint: Always provide both level and message to log() [OK]

Common Mistakes:

• Passing only one argument to log()
• Assuming date syntax is incorrect
• Thinking function name conflicts cause this

5. You want to improve your bash logging function to write logs to a file and include log levels only if they are WARNING or ERROR. Which code snippet correctly implements this?

hard

A. log() { if [ "$1" = "INFO" ]; then echo "$(date) [$1] $2" >> script.log; fi; }

B. log() { if [[ "$1" == "WARNING" || "$1" == "ERROR" ]]; then echo "$(date) [$1] $2" >> script.log; fi; }

C. log() { echo "$(date) [$1] $2" >> script.log; }

D. log() { echo "$2" >> script.log; }

Solution

1. Step 1: Understand requirement

   Logs should be saved to a file and include level only if WARNING or ERROR.

2. Step 2: Check each option

   log() { if [[ "$1" == "WARNING" || "$1" == "ERROR" ]]; then echo "$(date) [$1] $2" >> script.log; fi; } writes to file and filters levels correctly. log() { echo "$(date) [$1] $2" >> script.log; } writes all levels. log() { if [ "$1" = "INFO" ]; then echo "$(date) [$1] $2" >> script.log; fi; } only logs INFO. log() { echo "$2" >> script.log; } logs message without level.

3. Final Answer:

   log() { if [[ "$1" == "WARNING" || "$1" == "ERROR" ]]; then echo "$(date) [$1] $2" >> script.log; fi; } -> Option B

4. Quick Check:

   Filter levels and append to file = log() { if [[ "$1" == "WARNING" || "$1" == "ERROR" ]]; then echo "$(date) [$1] $2" >> script.log; fi; } [OK]

Hint: Use if condition to filter levels before logging to file [OK]

Common Mistakes:

• Logging all levels without filtering
• Not appending logs to file
• Logging message without level info