#!/bin/bash # # weekly_maintenance.sh – perform routine Perforce cleanup and notifications. # # This script performs a series of maintenance tasks against a Helix Core # installation using the SDP environment. It logs all output to a file # and emails the results to the configured MAILTO address. If a large # number of clients are queued for unloading, it alerts the administrator # instead of attempting the unload. # Fail fast on errors, unset variables and pipeline failures. set -euo pipefail # Determine the SDP instance either from the first positional parameter or # the environment. Require it to be set to avoid accidental misuse. P4INSTANCE="${1:-${P4INSTANCE:-}}" if [[ -z "$P4INSTANCE" ]]; then echo "Instance parameter not supplied." echo "You must supply the Perforce instance as a parameter to this script or set \$P4INSTANCE in the environment." exit 1 fi # Source SDP environment variables and ensure we can talk to Perforce. if ! source "/p4/common/bin/p4_vars" "$P4INSTANCE"; then echo "Unable to source p4_vars for instance $P4INSTANCE" >&2 exit 1 fi # Authenticate using the SDP helper. Suppress output but do not fail the script if login fails. /p4/common/bin/p4login >/dev/null 2>&1 || true # Prepare our log file and client names. Use the hostname and server name for uniqueness. LOG="/p4/sdp/Maintenance/${HOSTNAME}_${P4SERVER}_log.txt" P4CLIENT="${HOSTNAME}_unload" # Ensure the maintenance working directory exists and change into it for relative paths. MAINT_DIR="/p4/sdp/Maintenance" if [[ ! -d "$MAINT_DIR" ]]; then echo "Maintenance directory $MAINT_DIR does not exist." >&2 exit 1 fi cd "$MAINT_DIR" # Helper function to timestamp and append a message to the log. log_msg() { local msg="${1:-}" printf '%s %s\n' "$(date '+%Y-%m-%d %H:%M:%S')" "$msg" >>"$LOG" } # Start logging. log_msg "--- Weekly maintenance started for instance $P4INSTANCE ---" # Remove any leftover server lock files. This can prevent DB replays from # succeeding if the previous run terminated uncleanly. log_msg "Removing server lock files from /p4/${P4INSTANCE}/root/server.locks" rm -rf "/p4/${P4INSTANCE}/root/server.locks" >>"$LOG" 2>&1 || true # Generate lists of inactive clients. accessdates.py produces clients.txt # based on the configured number of weeks. log_msg "Generating client inactivity report via accessdates.py" accessdates.py "$P4INSTANCE" >>"$LOG" 2>&1 || true # Count the number of clients to be unloaded and decide what to do. Use # wc -l with a redirection to avoid counting the filename itself. Fall back # to zero if the file is missing. client_count=0 if [[ -f clients.txt ]]; then client_count=$(wc -l < clients.txt || echo 0) fi log_msg "Inactive client count: $client_count" # If there are fewer than 200 clients queued, unload them. Otherwise alert # the administrator by emailing the list of clients rather than unloading # them, as processing a very large set may impact server performance. if (( client_count > 0 )); then if (( client_count < 200 )); then log_msg "Unloading $client_count clients via unload_clients.py" unload_clients.py >>"$LOG" 2>&1 || true else log_msg "Too many clients ($client_count) to unload automatically; sending alert email instead." if [[ -n "${MAILTO:-}" ]]; then mail -s "${HOSTNAME} ${P4SERVER} client unload threshold exceeded" "$MAILTO" < clients.txt || true fi fi fi # Notify users about pending client deletions. This script emails owners of # workspaces that will be removed soon. Only run once per maintenance window. log_msg "Running email_pending_client_deletes.py" email_pending_client_deletes.py "$P4INSTANCE" >>"$LOG" 2>&1 || true # Remove empty pending changelists. These accumulate over time and can slow # down server operations. log_msg "Removing empty pending changelists via remove_empty_pending_changes.py" remove_empty_pending_changes.py "$P4INSTANCE" >>"$LOG" 2>&1 || true # Finish logging and send the report. log_msg "--- Weekly maintenance completed ---" if [[ -n "${MAILTO:-}" ]]; then mail -s "${HOSTNAME} ${P4SERVER} Weekly maintenance log" "$MAILTO" <"$LOG" || true fi
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#9 | 31836 | Russell C. Jackson (Rusty) | Added limit on the number of clients to unload | ||
#8 | 30939 | Russell C. Jackson (Rusty) | Added delete_unload_clients.py to maintenance | ||
#7 | 29737 | Russell C. Jackson (Rusty) | Redirect empty changes output to null | ||
#6 | 29392 | Russell C. Jackson (Rusty) | Disabled delusers since Perforce doesn't update user access time on the commit server. | ||
#5 | 29342 | Russell C. Jackson (Rusty) | Turning off unload_labels.py to avoid issues with dates not being updated from edge servers. | ||
#4 | 26867 | Russell C. Jackson (Rusty) | Corrected issue with using a instance other than 1. | ||
#3 | 24675 | Russell C. Jackson (Rusty) |
Fixed bugs in sdputils.py and scripts using it. Converted to standard 2 space spacing, removed copyright stuff. |
||
#2 | 24075 | Russell C. Jackson (Rusty) | Added maintenance and edge_maintenance to crontab, created edge_maintenance and updated maintenance. | ||
#1 | 22693 | Russell C. Jackson (Rusty) |
Branched a Unix only version of the SDP. Removed extra items to create a cleaner tree. Moved a few items around to make more sense without Windows in the mix. |
||
//guest/perforce_software/sdp/dev/Maintenance/maintenance | |||||
#6 | 16638 | C. Thomas Tyler |
Routine merge down to dev from main using: p4 merge -b perforce_software-sdp-dev |
||
#5 | 16029 | C. Thomas Tyler |
Routine merge to dev from main using: p4 merge -b perforce_software-sdp-dev |
||
#4 | 13906 | C. Thomas Tyler |
Normalized P4INSTANCE to SDP_INSTANCE to get Unix/Windows implementations in sync. Reasons: 1. Things that interact with SDP in both Unix and Windows environments shoudn't have to account for this obscure SDP difference between Unix and Windows. (I came across this doing CBD work). 2. The Windows and Unix scripts have different variable names for defining the same concept, the SDP instance. Unix uses P4INSTANCE, while Windows uses SDP_INSTANCE. 3. This instance tag, a data set identifier, is an SDP concept. I prefer the SDP_INSTANCE name over P4INSTANCE, so I prpose to normalize to SDP_INSTANCE. 4. The P4INSTANCE name makes it look like a setting that might be recognized by the p4d itself, which it is not. (There are other such things such as P4SERVER that could perhaps be renamed as a separate task; but I'm not sure we want to totally disallow the P4 prefix for variable names. It looks too right to be wrong in same cases, like P4BIN and P4DBIN. That's a discussion for another day, outside the scope of this task). Meanwhile: * Fixed a bug in the Windows 2013.3 upgrade script that was referencing undefined P4INSTANCE, as the Windows environment defined only SDP_INSTANCE. * Had P4INSTANCE been removed completely, this change would likely cause trouble for users doing updates for existing SDP installations. So, though it involves slight technical debt, I opted to keep a redundant definition of P4INSTANCE in p4_vars.template, with comments indicating SDP_INSTANCE should be used in favor of P4INSTANCE, with a warning that P4INSTANCE may go away in a future release. This should avoid unnecessary upgrade pain. * In mkdirs.sh, the varialbe name was INSTANCE rather than SDP_INSTANCE. I changed that as well. That required manual change rather than sub/replace to avoid corrupting other similar varialbe names (e.g. MASTERINSTANCE). This is a trivial change technically (a substitute/replace, plus tweaks in p4_vars.template), but impacts many files. |
||
#3 | 11477 | Russell C. Jackson (Rusty) |
Updated to use /usr/bin/env python Added workshop header. Changed cfg to config. |
||
#2 | 11464 | Russell C. Jackson (Rusty) | Current maintenance scripts. | ||
#1 | 10638 | C. Thomas Tyler | Populate perforce_software-sdp-dev. | ||
//guest/perforce_software/sdp/main/Maintenance/maintenance | |||||
#2 | 10464 | Russell C. Jackson (Rusty) | Corrected typos and added import sys. | ||
#1 | 10148 | C. Thomas Tyler | Promoted the Perforce Server Deployment Package to The Workshop. |