Table of Contents

style	none

Managing Log Levels in Swarm Cluster Using a Shell Script

...

Adjust the log level of a Swarm cluster permanently or temporarily.
Monitor log file growth after setting a higher log level for diagnostics.
Revert the log level to its original setting automatically after a defined period.

Script

...

Usage

Code Block

language	bash

#!/bin/bash

# Function to display usage information
usage() {
    echo "Usage: $0./log_level_script.sh -d swarmSWARM_ipIP -p adminADMIN:passwordPASSWORD -i newLOG_log_levelLEVEL [-t duration_in_seconds]"
    echo "  -d, DURATION]

Parameters:
- -d / --swarm_ip

...

- : Specifies the IP address of the Swarm API endpoint. (Required)
- -p / --credentials: Administrator credentials in admin:password format. (Required)
- -i / --log.level: Desired log level to apply. (Required)
- -t / --time: Duration in seconds to keep the new log level before reverting to the previous setting. If omitted, the change is permanent. (Optional)

Prerequistites

Access to the Swarm storage nodes and valid credentials
Verify network access to the Swarm storage nodes from the machine where the script runs.

Instruction for Use

Setting the Log Level Permanently To make a permanent change, omit the -t parameter:
Code Block
bash
Copy code
./log_level_script.sh -d 192.168.1.100 -p admin:password -i 3
This sets the log level to 3 permanently until you manually change it.
Setting the Log Level Temporarily Specify a duration (in seconds) with the -t parameter to revert automatically after a defined period:
Code Block
bash
Copy code
./log_level_script.sh -d 192.168.1.100 -p admin:password -i 3 -t 600
In this example, the log level is set to 3 and reverts to the original level after 600 seconds (10 minutes).
Monitoring Log File Size
- The script identifies the log file (castor.log) in either /var/log/caringo/ or /var/log/datacore/.
- Initial file size is shown before setting the new log level.
- Final file size and size difference are displayed after the temporary duration ends, indicating logs generated during this period.
Output Details
- The script displays Swarm IP, log file location, initial and final log file sizes, and the cluster name.
- For temporary log levels, a countdown timer displays time remaining before reverting.
- Once completed, it provides the approximate amount of logs generated, duration, and confirms reversion to the original log level.

Example Output

Code Block

Swarm IP: 192.168.1.100
Credentials: [hidden for security]
Cluster Name: Cluster_01
Log file located at: /var/log/datacore/castor.log
Initial log file size: 10.5MB
New log level: 3
Current log level is 2.
Updating log level to 3...
Log level changed successfully from 2 → 3.
Keeping log level at 3 for 600 second(s)...
Approximate 1.2MB new logs were generated at log level 3. Current castor.log size is 11.7MB after 00:10:00.
Log level reverted successfully back to 2.

Error Handling

Missing Parameters: Missing parameters prompt a usage message.
Invalid Duration: If a non-numeric duration is provided, you’re prompted to enter a valid duration in seconds.
Connection Issues: If unable to connect to the Swarm API, check the IP, credentials, and network access.

Notes

Credentials are masked in the output for security.
Log file sizes are shown in human-readable format (GB, MB, KB, B).

This script provides administrators with an effective way to adjust and monitor Swarm logging, supporting both temporary and permanent log level changes for troubleshooting and performance monitoring.

Script Source Code

Code Block

language	bash

#!/bin/bash

# Function to display usage information
usage() {
    local duration=$1
    local hours=$((duration / 3600))
    local minutes=$(( (duration % 3600) / 60 ))
    local seconds=$((duration % 60))
    printf "%02d:%02d:%02d" $hours $minutes $seconds
}

# Parse input arguments
while [[ "$#" -gt 0 ]]; do
    case $1 in
echo "Usage: $0 -d swarm_ip -p admin:password -i new_log_level [-t duration_in_seconds]"
    echo "  -d, --swarm_ip           IP address of the Swarm API endpoint"
    echo "  -p, --credentials        -d|--swarm_ip) swarm_ip="$2"; shift ;;
Credentials in the format admin:password"
    echo "  -p|--credentials) credentials="$2"; shift ;;i, --log.level          New -i|--log.level) new_log_level="$2"; shiftto ;;set"
    echo  "  -t|, --time)               Duration in seconds to ifkeep [[the -n "$2" && "$2" != -* ]]; then
          new log level (optional)"
    exit 1
}

# Function to format file size
format_size() {
    local duration="$2"size=$1
    if (( size >= 1073741824 )); then
       shift echo "$(awk "BEGIN {printf \"%.1fGB\", $size/1073741824}")"
    elif (( elsesize >= 1048576 )); then
        echo "$(awk "BEGIN  read -p "Enter duration in seconds: " duration
     {printf \"%.1fMB\", $size/1048576}")"
    elif (( size >= 1024 )); then
      fi  echo "$(awk "BEGIN {printf \"%.1fKB\", $size/1024}")"
    else
;;         *) usage ;;echo "${size}B"
    esacfi
}

# Function shiftto doneformat duration
# Check if required arguments are provided
if [[ -z "$swarm_ip" || -z "$credentials" || -z "$new_log_level" ]]; then
    usage
fi

# Retrieve the cluster name
clusterName=$(curl -u admin:caringo -sS "http://$swarm_ip:91/api/storage/clusters" | grep -oP '"name":\s*"\K[^"]+')
if [[ -z "$clusterName" ]]; then
    echo "Failed to retrieve the cluster name. Please check your inputs."
    exit 1
fi

# Convert duration to an integer if it is set
if [[ -n "$duration" ]]; then
    if ! [[ "$duration" =~ ^[0-9]+$ ]]; then
format_duration() {
    local duration=$1
    local hours=$((duration / 3600))
    local minutes=$(( (duration % 3600) / 60 ))
    local seconds=$((duration % 60))
    printf "%02d:%02d:%02d" $hours $minutes $seconds
}

# Parse input arguments
while [[ "$#" -gt 0 ]]; do
    case $1 in
        -d|--swarm_ip) swarm_ip="$2"; shift ;;
        -p|--credentials) credentials="$2"; shift ;;
        -i|--log.level) new_log_level="$2"; shift ;;
       echo "Error: Duration must be a positive integer value in seconds." -t|--time)
            if [[ -n "$2" && exit 1
    fi
fi

# Display input parameters
echo "Swarm IP: $swarm_ip"
echo "Credentials: [hidden for security]"
echo "Cluster Name: $clusterName"

# Identify the log file location
log_file=""
if [[ -f "/var/log/caringo/castor.log" ]]; then
    log_file="/var/log/caringo/castor.log"
elif [[ -f "/var/log/datacore/castor.log" ]]; then
    log_file="/var/log/datacore/castor.log"
fi

# Display log file information and truncate
if [[ -n "$log_file" ]]; then
    echo "Log file located at: $log_file"

    # Capture initial file size
    initial_size=$(stat -c%s "$log_file")
    initial_size_formatted=$(format_size "$initial_size")
    echo "Initial log file size: $initial_size_formatted"

else
    echo "Warning: Log file not found in expected directories."
fi

# Get the current log level
echo ""
echo "Retrieving the current log level..."
current_log_level"$2" != -* ]]; then
                duration="$2"
                shift
            else
                read -p "Enter duration in seconds: " duration
            fi
            ;;
        *) usage ;;
    esac
    shift
done

# Check if required arguments are provided
if [[ -z "$swarm_ip" || -z "$credentials" || -z "$new_log_level" ]]; then
    usage
fi

# Retrieve the cluster name
clusterName=$(curl -u "$credentials"admin:caringo -sS "http://$swarm_ip:91/api/storage/clusters/$clusterName/settings/log.level" | grep -oP '"valuename":\s*"\K[0-9]+')

# Check if the current log level was retrieved successfully^"]+')
if [[ -z "$current_log_level$clusterName" ]]; then
    echo "Failed to retrieve the currentcluster log levelname. Please check your inputs."
    exit 1
fi
echo "New log level: $new_log_level"
echo "Current log level is $current_log_level."

# Check if the new log level is the same as the current log levelConvert duration to an integer if it is set
if [[ "$current_log_level" -eqn "$new_log_level$duration" ]]; then
    if ! echo[[ "$duration" =~    echo "Log level is already set to $new_log_level. No changes made."
    exit 0
fi

# Update the log level using PUT
echo "Updating log level to $new_log_level..."
response=$(curl -u "$credentials" -sS -X PUT -H "Content-Type: application/json" \
    "http://$swarm_ip:91/api/storage/clusters/$clusterName/settings/log.level" \
    -d "{\"value\": $new_log_level}")

# Verify if the log level was updated
updated_log_level=$(echo "$response" | grep -oP '"value":\s*\K[0-9]+')
if [[ "$updated_log_level" -eq "$new_log_level^[0-9]+$ ]]; then
        echo "Error: Duration must be a positive integer value in seconds."
        exit 1
    fi
fi

# Display input parameters
echo "Swarm IP: $swarm_ip"
echo "Credentials: [hidden for security]"
echo "Cluster Name: $clusterName"

# Identify the log file location
log_file=""
if [[ -f "/var/log/caringo/castor.log" ]]; then
    echo "Log level changed successfully from $current_log_level → $new_log_level."
else
log_file="/var/log/caringo/castor.log"
elif [[ -f "/var/log/datacore/castor.log" ]]; then
   echo "Failed to update log level. Response: $response"
    exit 1
fi

# If duration is specified, wait and revert after the specified timelog_file="/var/log/datacore/castor.log"
fi

# Display log file information and truncate
if [[ -n "$duration" && "$duration" -gt 0$log_file" ]]; then
    echo "Keeping log level at $new_log_level for $duration second(s)..."
    echo "Log file located at: $log_file"

    # Capture Countdowninitial loopfile size
   for initial_size=$((i=duration; i>0; i--)); do
   stat -c%s "$log_file")
    initial_size_formatted=$(format_size "$initial_size")
    echo "Initial log file size: $initial_size_formatted"

else
    #echo Calculate hours, minutes, and seconds
        hours=$((i / 3600))
        minutes=$(( (i % 3600) / 60 ))
        seconds=$((i % 60))

        # Format countdown in hh:mm:ss
        printf -v countdown "%02d:%02d:%02d" $hours $minutes $seconds
        echo -ne "Countdown: $countdown remaining...\r"
        sleep 1
    done
    echo -e "\n\nTime's up! Reverting log level back to $current_log_level..."

    # Check log file size before reverting
    final_size=$(stat -c%s "$log_file")
    final_size_formatted=$(format_size "$final_size")

    # Calculate size difference
    size_diff=$(( final_size - initial_size ))
    size_diff_formatted=$(format_size "$size_diff")

    # Display size difference and final log size
    # echo "Approximate $size_diff_formatted new logs was genreated at log level $new_log_level. Current castor.log size is $final_size_formatted."
    # Format the duration for display
    duration_formatted=$(format_duration "$duration")

    # Updated message with duration in hh:mm:ss format
    echo "Approximate $size_diff_formatted new logs was generated at log level $new_log_level. Current castor.log size is $final_size_formatted after $duration_formatted.""Warning: Log file not found in expected directories."
fi

# Get the current log level
echo ""
echo "Retrieving the current log level..."
current_log_level=$(curl -u "$credentials" -sS "http://$swarm_ip:91/api/storage/clusters/$clusterName/settings/log.level" | grep -oP '"value":\s*\K[0-9]+')

# Check if the current log level was retrieved successfully
if [[ -z "$current_log_level" ]]; then
    echo "Failed to retrieve the current log level. Please check your inputs."
    exit 1
fi
echo "New log level: $new_log_level"
echo "Current log level is $current_log_level."

# Check if the new log level is the same as the current log level
if [[ "$current_log_level" -eq "$new_log_level" ]]; then
    echo ""
    echo "Log level is already set to $new_log_level. No changes made."
    exit 0
fi

# Update the log level using PUT
echo "Updating log level to $new_log_level..."
response=$(curl -u "$credentials" -sS -X PUT -H "Content-Type: application/json" \
    "http://$swarm_ip:91/api/storage/clusters/$clusterName/settings/log.level" \
    -d "{\"value\": $new_log_level}")

# Verify if the log level was updated
updated_log_level=$(echo "$response" | grep -oP '"value":\s*\K[0-9]+')
if [[ "$updated_log_level" -eq "$new_log_level" ]]; then
    echo ""Log level changed successfully from $current_log_level # Revert to original log level
→ $new_log_level."
else
   response=$(curl -u echo "$credentials"Failed -sSto -Xupdate PUTlog -H "Content-Type: application/json" \
        "http://$swarm_ip:91/api/storage/clusters/$clusterName/settings/log.level" \
        -d "{\"value\": $current_log_level}")

    reverted_log_level=$(echo "$response" | grep -oP '"value":\s*\K[0-9]+')
    if [[ "$reverted_log_level" -eq "$current_log_level" ]]; then
level. Response: $response"
    exit 1
fi

# If duration is specified, wait and revert after the specified time
if [[ -n "$duration" && "$duration" -gt 0 ]]; then
    echo "Keeping log level at $new_log_level for $duration second(s)..."
    echo ""

    # Countdown loop
    for ((i=duration; i>0; i--)); do
       echo "Log# levelCalculate revertedhours, successfullyminutes, backand to $current_log_level."seconds
     else   hours=$((i / 3600))
   echo "Failed to revert log level. Response: $response"
    minutes=$(( (i % 3600) / 60 ))
    exit 1   seconds=$((i % fi60))
else
    echo "Log level change is# permanentFormat untilcountdown manually modified."
fi

Script Usage

Code Block
./log_level_script.sh -d SWARM_IP -p ADMIN:PASSWORD -i LOG_LEVEL [-t DURATION]

Parameters:
- -d / --swarm_ip: Specifies the IP address of the Swarm API endpoint. (Required)
- -p / --credentials: Administrator credentials in admin:password format. (Required)
- -i / --log.level: Desired log level to apply. (Required)
- -t / --time: Duration in seconds to keep the new log level before reverting to the previous setting. If omitted, the change is permanent. (Optional)

Prerequistites

Access to the Swarm storage nodes and valid credentials
Verify network access to the Swarm storage nodes from the machine where the script runs.

Instruction for Use

Setting the Log Level Permanently To make a permanent change, omit the -t parameter:
Code Block
bash
Copy code
./log_level_script.sh -d 192.168.1.100 -p admin:password -i 3
This sets the log level to 3 permanently until you manually change it.
Setting the Log Level Temporarily Specify a duration (in seconds) with the -t parameter to revert automatically after a defined period:
Code Block
bash
Copy code
./log_level_script.sh -d 192.168.1.100 -p admin:password -i 3 -t 600
In this example, the log level is set to 3 and reverts to the original level after 600 seconds (10 minutes).
Monitoring Log File Size
- The script identifies the log file (castor.log) in either /var/log/caringo/ or /var/log/datacore/.
- Initial file size is shown before setting the new log level.
- Final file size and size difference are displayed after the temporary duration ends, indicating logs generated during this period.
Output Details
- The script displays Swarm IP, log file location, initial and final log file sizes, and the cluster name.
- For temporary log levels, a countdown timer displays time remaining before reverting.
- Once completed, it provides the approximate amount of logs generated, duration, and confirms reversion to the original log level.

Example Output

Code Block

Swarm IP: 192.168.1.100
Credentials: [hidden for security]
Cluster Name: Cluster_01
Log file located at: /var/log/datacore/castor.log
Initial log file size: 10.5MB
New log level: 3
Current log level is 2.
Updating log level to 3...
Log level changed successfully from 2 → 3.
Keeping log level at 3 for 600 second(s)...
Approximate 1.2MB new logs were generated at log level 3. Current castor.log size is 11.7MB after 00:10:00.
Log level reverted successfully back to 2.

Error Handling

Missing Parameters: Missing parameters prompt a usage message.
Invalid Duration: If a non-numeric duration is provided, you’re prompted to enter a valid duration in seconds.
Connection Issues: If unable to connect to the Swarm API, check the IP, credentials, and network access.

Notes

Credentials are masked in the output for security.
Log file sizes are shown in human-readable format (GB, MB, KB, B).

...

in hh:mm:ss
        printf -v countdown "%02d:%02d:%02d" $hours $minutes $seconds
        echo -ne "Countdown: $countdown remaining...\r"
        sleep 1
    done
    echo -e "\n\nTime's up! Reverting log level back to $current_log_level..."

    # Check log file size before reverting
    final_size=$(stat -c%s "$log_file")
    final_size_formatted=$(format_size "$final_size")

    # Calculate size difference
    size_diff=$(( final_size - initial_size ))
    size_diff_formatted=$(format_size "$size_diff")

    # Display size difference and final log size
    # echo "Approximate $size_diff_formatted new logs was genreated at log level $new_log_level. Current castor.log size is $final_size_formatted."
    # Format the duration for display
    duration_formatted=$(format_duration "$duration")

    # Updated message with duration in hh:mm:ss format
    echo "Approximate $size_diff_formatted new logs was generated at log level $new_log_level. Current castor.log size is $final_size_formatted after $duration_formatted."
    echo ""

    # Revert to original log level
    response=$(curl -u "$credentials" -sS -X PUT -H "Content-Type: application/json" \
        "http://$swarm_ip:91/api/storage/clusters/$clusterName/settings/log.level" \
        -d "{\"value\": $current_log_level}")

    reverted_log_level=$(echo "$response" | grep -oP '"value":\s*\K[0-9]+')
    if [[ "$reverted_log_level" -eq "$current_log_level" ]]; then
        echo "Log level reverted successfully back to $current_log_level."
    else
        echo "Failed to revert log level. Response: $response"
        exit 1
    fi
else
    echo "Log level change is permanent until manually modified."
fi

Version	Old Version 3	New Version 4
Changes made by	Milton Suen	Milton Suen
Saved on	Oct 26, 2024	Oct 26, 2024

Versions Compared

Key

Managing Log Levels in Swarm Cluster Using a Shell Script

Script

Usage

Prerequistites

Instruction for Use

Example Output

Error Handling

Notes

Script Source Code

Script Usage

Prerequistites

Instruction for Use

Example Output

Error Handling

Notes

Page Comparison

Versions Compared

Key

Managing Log Levels in Swarm Cluster Using a Shell Script

Script

Usage

Prerequistites

Instruction for Use

Example Output

Error Handling

Notes

Script Source Code

Script Usage

Prerequistites

Instruction for Use

Example Output

Error Handling

Notes