cis-2.3.1-project-cloud-logging-buckets.sh

#!/bin/bash

source functions.inc

declare SEPARATOR="---------------------------------------------------------------------------------";
declare PROJECT_IDS="";
declare DEBUG="False";
declare CSV="False";
declare ICH="False";
declare HELP=$(cat << EOL
	$0 [-p, --project PROJECT] [-c, --csv] [-i, --include-column-headers] [-d, --debug] [-h, --help]	
EOL
);

for arg in "$@"; do
  shift
  case "$arg" in
    "--help") 			set -- "$@" "-h" ;;
    "--debug") 			set -- "$@" "-d" ;;
    "--csv") 			set -- "$@" "-c" ;;
    "--include-column-headers") set -- "$@" "-i" ;;
    "--project")   		set -- "$@" "-p" ;;
    *)        			set -- "$@" "$arg"
  esac
done

while getopts "hdcip:" option
do 
    case "${option}"
        in
        p)
        	PROJECT_IDS=${OPTARG};;
        d)
        	DEBUG="True";;
        c)
        	CSV="True";;
	i)
		ICH="True";;
        h)
        	echo $HELP; 
        	exit 0;;
    esac;
done;

if [[ $PROJECT_IDS == "" ]]; then
    declare PROJECT_IDS=$(gcloud projects list --format="flattened(PROJECT_ID)" | grep project_id | cut -d " " -f 2);
fi;

if [[ $DEBUG == "True" ]]; then
	echo "Projects: $PROJECT_IDS";
fi;

if [[ $ICH == "True" ]]; then
	echo "\"PROJECT_ID\", \"PROJECT_NAME\", \"PROJECT_OWNER\", \"PROJECT_APPLICATION\", \"BUCKET_NAME_SHORT\", \"BUCKET_NAME_LOCATION\", \"BUCKET_LIFECYCLE_STATE\", \"BUCKET_RETENTION_DAYS\", \"BUCKET_DESCRIPTION\", \"BUCKET_RETENTION_WARNING\"";
fi;

for PROJECT_ID in $PROJECT_IDS; do

	gcloud config set project $PROJECT_ID 2>/dev/null;

	if ! api_enabled logging.googleapis.com; then
		if [[ $CSV != "True" ]]; then
			echo "WARNING: Logging API is not enabled";
		fi;
		continue;
	fi;

	declare BUCKETS=$(gcloud logging buckets list --format json --project="$PROJECT_ID");
	
	if [[ $DEBUG == "True" ]]; then
		echo "Buckets (JSON): $BUCKETS";
	fi;

	if [[ $CSV != "True" ]]; then
		echo $SEPARATOR;
		echo "Log buckets for Project $PROJECT_ID";
		echo $SEPARATOR;
	fi;
	
	if [[ $BUCKETS != "[]" ]]; then

		PROJECT_DETAILS=$(gcloud projects describe $PROJECT_ID --format="json");
		PROJECT_NAME=$(echo $PROJECT_DETAILS | jq -rc '.name');
		PROJECT_APPLICATION=$(echo $PROJECT_DETAILS | jq -rc '.labels.app');
		PROJECT_OWNER=$(echo $PROJECT_DETAILS | jq -rc '.labels.adid');
	
		echo $BUCKETS | jq -rc '.[]' | while IFS='' read -r BUCKET;do
		
			if [[ $DEBUG == "True" ]]; then
				echo "Project Name: $PROJECT_NAME";
				echo "Project Application: $PROJECT_APPLICATION";
				echo "Project Owner: $PROJECT_OWNER";			
				echo "Log Bucket (JSON): $BUCKET";
				echo "";
			fi;

			BUCKET_NAME=$(echo $BUCKET | jq -rc '.name');
			BUCKET_NAME_SHORT="$(echo $BUCKET_NAME | cut -d/ -f6)";
			BUCKET_LOCATION="$(echo $BUCKET_NAME | cut -d/ -f4)";
			BUCKET_DESCRIPTION=$(echo $BUCKET | jq -rc '.description');
			BUCKET_LIFECYCLE_STATE=$(echo $BUCKET | jq -rc '.lifecycleState');
			BUCKET_RETENTION_DAYS=$(echo $BUCKET | jq -rc '.retentionDays');
			BUCKET_RETENTION_WARNING="";

			if [[ $BUCKET_NAME_SHORT == "_Default" && $BUCKET_RETENTION_DAYS > 30 ]]; then
				BUCKET_RETENTION_WARNING="WARNING: _Default bucket retention policy exceeds 30 days. Costs may increase.";
			fi;

			# Print the results gathered above
			if [[ $CSV != "True" ]]; then
				echo "Project ID: $PROJECT_ID";
				echo "Project Name: $PROJECT_NAME";
				echo "Project Application: $PROJECT_APPLICATION";
				echo "Project Owner: $PROJECT_OWNER";
				echo "Log Bucket Name: $BUCKET_NAME_SHORT";
				echo "Log Bucket Location: $BUCKET_LOCATION";
				echo "Log Bucket Lifecycle State: $BUCKET_LIFECYCLE_STATE";
				echo "Log Bucket Retention Days: $BUCKET_RETENTION_DAYS";
				echo "Log Bucket Description: $BUCKET_DESCRIPTION";
				echo "Log Bucket Retention Information: $BUCKET_RETENTION_WARNING";
				echo "";
			else
				echo "\"$PROJECT_ID\", \"$PROJECT_NAME\", \"$PROJECT_OWNER\", \"$PROJECT_APPLICATION\", \"$BUCKET_NAME_SHORT\", \"$BUCKET_NAME_LOCATION\", \"$BUCKET_LIFECYCLE_STATE\", \"$BUCKET_RETENTION_DAYS\", \"$BUCKET_DESCRIPTION\", \"$BUCKET_RETENTION_WARNING\"";
			fi;		

		done;

	else
		if [[ $CSV != "True" ]]; then
			echo "No log buckets found for project $PROJECT_ID";
			echo "";
		fi;
	fi;
	sleep 0.5;
done;