Skip to main content

Set the Debug Logs for a user

Evgenii Azimzhanov
Evgenii Azimzhanov

Sets a debug log for 12 hours for a specific user

Usage:​

log_dev.sh [-o arg] [-u arg] -z -h
-o target org to set debug log
-u Name of an entity to set debug log

Examples:​

sh log_dev.sh -o a_ea -u Azimzhanov -z
sh log_dev.sh -o a_ea -u Azimzhanov
sh log_dev.sh -o a_ea -u "Evgenii Azimzhanov"
sh log_dev.sh -o a_ea -u "Evgenii Azi"

Script

#!/bin/bash

log_debug() {
[[ $DEBUG_MODE == true ]] && { separator; echo "${@}"; }
}

log_simple() {
echo "${@}"
}

separator() {
echo "-----------------------------------"
}

parse_params() {
while getopts 'u:o:hz' opt; do
case "$opt" in
u) TRACING_ENTITY_NAME="$OPTARG" ;;
o) IN_ORG_ALIAS="$OPTARG" ;;
z) DEBUG_MODE=true ;;
?|h) show_usage; exit 1 ;;
esac
done
shift "$(($OPTIND -1))"

if [[ $DEBUG_MODE == true ]]; then
log_debug "Received Params: "
echo "TRACING_ENTITY_NAME: $TRACING_ENTITY_NAME"
echo "IN_ORG_ALIAS: $IN_ORG_ALIAS"
echo "DEBUG_MODE: $DEBUG_MODE"
fi
}

show_usage() {
cat << EOF

Sets a debug log for 12 hours

USAGE:
$(basename $0) [-o arg] [-u arg] -z -h
-o target org to set debug log
-u Name of an entity to set debug log

EXAMPLES:
sh log_dev.sh -o a_ea -u Azimzhanov -z

EOF
}

check_and_handle_debug_level() {
local debug_level_query="SELECT Id FROM DebugLevel WHERE DeveloperName = '$DEBUG_LEVEL_NAME'"
local debug_level_result=$(sf data query -o "$IN_ORG_ALIAS" -q "$debug_level_query" -t --json)
DEBUG_LEVEL_ID=$(jq -r '.result.records[0].Id' <<< "$debug_level_result")

log_debug "Debug level Found $DEBUG_LEVEL_ID"

if [[ -z $DEBUG_LEVEL_ID || $DEBUG_LEVEL_ID == "null" ]]; then
log_simple "Debug Level doesn't exist"
DEBUG_LEVEL_ID=$(sf data record create -o "$IN_ORG_ALIAS" -s DebugLevel -t -v "ApexCode=FINEST ApexProfiling=INFO Callout=INFO Database=INFO System=INFO Validation=INFO Visualforce=INFO Workflow=INFO MasterLabel='$DEBUG_LEVEL_NAME' DeveloperName='$DEBUG_LEVEL_NAME'" | jq -r '.result.id')
log_simple "Successfully created Debug Level with ID: $DEBUG_LEVEL_ID"
else
log_simple "Debug Level exists"
sf data record update -o "$IN_ORG_ALIAS" -i "$DEBUG_LEVEL_ID" -s DebugLevel -t -v "ApexCode=FINEST ApexProfiling=INFO Callout=INFO Database=INFO System=INFO Validation=INFO Visualforce=INFO Workflow=INFO"
log_simple "Successfully updated Debug Level record: $DEBUG_LEVEL_ID."
fi
}

check_and_handle_trace_flag() {
local trace_flag_query="SELECT Id, DebugLevelId FROM TraceFlag WHERE TracedEntity.Name LIKE '%$TRACING_ENTITY_NAME%'"
local trace_flag_result=$(sf data query -o "$IN_ORG_ALIAS" -q "$trace_flag_query" -t -r json)
local traced_entity_ids=$(jq -r '.result.records[].Id' <<< "$trace_flag_result")
local traced_entity_debug_level_id=$(jq -r '.result.records[0].DebugLevelId' <<< "$trace_flag_result")

local start_date=$(date -u '+%Y-%m-%dT%H:%M:%S')
local expiration_date=$(date -u -v +12H '+%Y-%m-%dT%H:%M:%S')

for traced_entity_id in $traced_entity_ids
do
if [[ -n $traced_entity_id && $traced_entity_id != "null" ]]; then
sf data record delete -o "$IN_ORG_ALIAS" -t -s TraceFlag -i "$traced_entity_id"
log_simple "Deleted existing TraceFlag record with ID: $traced_entity_id"
fi
done

local user_query_result=$(sf data query -o "$IN_ORG_ALIAS" -t --json -q "SELECT Id, Name FROM User WHERE Name LIKE '%$TRACING_ENTITY_NAME%' LIMIT 1")
local user_to_trace_id=$(jq -r '.result.records[0].Id' <<< "$user_query_result")

if [[ -z $user_to_trace_id || $user_to_trace_id == "null" ]]; then
log_simple "Error: User to trace not found."
exit 1
fi

log_debug "Found User to Trace, Id: $user_to_trace_id"
local create_trace_flag_result=$(sf data record create -o "$IN_ORG_ALIAS" -t -s TraceFlag -v "TracedEntityId=$user_to_trace_id LogType=USER_DEBUG DebugLevelId=$DEBUG_LEVEL_ID StartDate=$start_date ExpirationDate=$expiration_date" --json)
local create_trace_flag_success=$(jq -r '.status' <<< "$create_trace_flag_result")

if [[ $create_trace_flag_success == "0" ]]; then
log_simple "Creating record for TraceFlag... Success"
else
log_simple "Creating record for TraceFlag... Error"
log_simple "Error: $(jq -r '.message' <<< "$create_trace_flag_result")"
exit 1
fi
}

delete_excessive_logs() {
local log_query="SELECT Id FROM ApexLog ORDER BY SystemModstamp DESC LIMIT 1000"
local log_result=$(sf data query -o "$IN_ORG_ALIAS" -q "$log_query" -t --json)

if [[ -z $log_result || $log_result == "null" ]]; then
log_simple "No logs found to delete."
return
fi

local log_ids=$(jq -r '.result.records[].Id' <<< "$log_result")

# Create a CSV file with the log IDs
echo "Id" > log_ids.csv
for log_id in $log_ids
do
echo "$log_id" >> log_ids.csv
done

# Delete logs in bulk using the CSV file
sf data delete bulk -o "$IN_ORG_ALIAS" -s ApexLog -f log_ids.csv

# Remove the CSV file
rm log_ids.csv
}

IN_ORG_ALIAS=""
TRACING_ENTITY_NAME=""
DEBUG_MODE=false
START_DATE=$(date '+%Y-%m-%dT%H:%M:%S')
EXPIRATION_DATE=$(date -v +12H '+%Y-%m-%dT%H:%M:%S')
DEBUG_LEVEL_NAME="Debugger_Custom"

parse_params "$@"
log_debug "Debug Mode is enabled"
log_debug "Input Parameters:" "\n" "Target org is: $IN_ORG_ALIAS" "\n" "Tracing Entity Name is: $TRACING_ENTITY_NAME"
check_and_handle_debug_level
check_and_handle_trace_flag
# delete_excessive_logs