Skip to content

Further improve logging #320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 31, 2025
Merged

Further improve logging #320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53d59f2
Mitigate race conditions when committing into the repository
JohT Jan 31, 2025
8245e7e
Improve log groups introduced with 7d97d654
JohT Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/internal-cypher-reference-documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ jobs:
# And only run when the generated document changed to avoid an empty commit or an error while committing.
if: github.event_name == 'push' && env.generated_document_changed
run: |
set -x
git config --global user.name '${{ env.CI_COMMIT_AUTHOR }}'
git config --global user.email "[email protected]"
git fetch origin
Expand All @@ -62,4 +63,8 @@ jobs:
git status
git rebase --strategy-option=theirs origin/main --verbose
git status
git add ./cypher/CYPHER.md
git status
git commit --amend --no-edit
git status
git push --verbose
7 changes: 6 additions & 1 deletion .github/workflows/internal-environment-variables-reference-documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ jobs:
# And only run when the generated document changed to avoid an empty commit or an error while committing.
if: github.event_name == 'push' && env.generated_document_changed
run: |
set -x
git config --global user.name '${{ env.CI_COMMIT_AUTHOR }}'
git config --global user.email "[email protected]"
git fetch origin
Expand All @@ -62,4 +63,8 @@ jobs:
git status
git rebase --strategy-option=theirs origin/main --verbose
git status
git push --verbose
git add ./scripts/ENVIRONMENT_VARIABLES.md
git status
git commit --amend --no-edit
git status
git push --verbose
7 changes: 6 additions & 1 deletion .github/workflows/internal-scripts-reference-documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ jobs:
# And only run when the generated document changed to avoid an empty commit or an error while committing.
if: github.event_name == 'push' && env.generated_document_changed
run: |
set -x
git config --global user.name '${{ env.CI_COMMIT_AUTHOR }}'
git config --global user.email "[email protected]"
git fetch origin
Expand All @@ -62,4 +63,8 @@ jobs:
git status
git rebase --strategy-option=theirs origin/main --verbose
git status
git push --verbose
git add ./scripts/SCRIPTS.md
git status
git commit --amend --no-edit
git status
git push --verbose
19 changes: 10 additions & 9 deletions scripts/analysis/analyze.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ if [ ! -d "${ARTIFACTS_DIRECTORY}" ] && [ ! -d "${SOURCE_DIRECTORY}" ] ; then
exit 1
fi

echo "${LOG_GROUP_START}Start Analysis"
echo "analyze: analysisReportCompilation=${analysisReportCompilation}"
echo "analyze: settingsProfile=${settingsProfile}"
echo "analyze: exploreMode=${exploreMode}"
Expand Down Expand Up @@ -127,23 +128,24 @@ fi
# Execute the settings profile script that sets all the necessary settings variables (overrideable by environment variables).
echo "analyze: Using analysis settings profile script ${SETTINGS_PROFILE_SCRIPT}"
source "${SETTINGS_PROFILE_SCRIPT}"
echo "${LOG_GROUP_END}"

# Setup Tools
echo "${LOG_GROUP_START}Setup Tools";
echo "${LOG_GROUP_START}Setup Tools"
source "${SCRIPTS_DIR}/setupNeo4j.sh"
source "${SCRIPTS_DIR}/setupJQAssistant.sh"
source "${SCRIPTS_DIR}/startNeo4j.sh"
echo "${LOG_GROUP_END}";
echo "${LOG_GROUP_END}"

# Scan and analyze artifacts when they were changed
echo "${LOG_GROUP_START}Scan and Analyze Changed Artifacts";
echo "${LOG_GROUP_START}Scan and Analyze Changed Artifacts"
source "${SCRIPTS_DIR}/resetAndScanChanged.sh"
echo "${LOG_GROUP_END}";
echo "${LOG_GROUP_END}"

# Prepare and validate graph database before analyzing and creating reports
echo "${LOG_GROUP_START}Prepare Analysis";
echo "${LOG_GROUP_START}Prepare Analysis"
source "${SCRIPTS_DIR}/prepareAnalysis.sh"
echo "${LOG_GROUP_END}";
echo "${LOG_GROUP_END}"

if ${exploreMode}; then
echo "analyze: Explore mode activated. Report generation will be skipped. Neo4j keeps running."
Expand All @@ -153,10 +155,9 @@ fi
#########################
# Create Reports
#########################
echo "analyze: Creating Reports with ${REPORT_COMPILATION_SCRIPT} ..."
source "${REPORT_COMPILATION_SCRIPT}"

# Stop Neo4j at the end
echo "${LOG_GROUP_START}Finishing Analysis";
echo "${LOG_GROUP_START}Finishing Analysis"
source "${SCRIPTS_DIR}/stopNeo4j.sh"
echo "${LOG_GROUP_END}";
echo "${LOG_GROUP_END}"
7 changes: 4 additions & 3 deletions scripts/reports/compilations/CsvReports.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,10 @@ echo "CsvReports: REPORTS_SCRIPT_DIR=${REPORTS_SCRIPT_DIR}"

# Run all report scripts
for report_script_file in "${REPORTS_SCRIPT_DIR}"/*Csv.sh; do
report_script_filename=$(basename -- "${report_script_file}")

echo "${LOG_GROUP_START}${report_script_file}";
report_script_filename=$(basename -- "${report_script_file}");
report_script_filename="${report_script_filename%.*}" # Remove file extension

echo "${LOG_GROUP_START}Create CSV Report ${report_script_filename}";
echo "CsvReports: $(date +'%Y-%m-%dT%H:%M:%S%z') Starting ${report_script_filename}...";

source "${report_script_file}"
Expand Down
7 changes: 4 additions & 3 deletions scripts/reports/compilations/JupyterReports.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,13 @@ echo "JupyterReports: JUPYTER_NOTEBOOK_DIRECTORY=${JUPYTER_NOTEBOOK_DIRECTORY}"
# Run all jupiter notebooks
for jupyter_notebook_file in "${JUPYTER_NOTEBOOK_DIRECTORY}"/*.ipynb; do
jupyter_notebook_filename=$(basename -- "${jupyter_notebook_file}")
jupyter_notebook_filename_without_extension="${jupyter_notebook_filename%.*}" # Remove file extension

echo "${LOG_GROUP_START}${jupyter_notebook_filename}";
echo "JupyterReports: $(date +'%Y-%m-%dT%H:%M:%S%z') Starting ${jupyter_notebook_filename}...";
echo "${LOG_GROUP_START}Create Jupyter Notebook Report ${jupyter_notebook_filename_without_extension}";
echo "JupyterReports: $(date +'%Y-%m-%dT%H:%M:%S%z') Starting ${jupyter_notebook_filename_without_extension}...";

source "${SCRIPTS_DIR}/executeJupyterNotebookReport.sh" --jupyterNotebook "${jupyter_notebook_filename}"

echo "JupyterReports: $(date +'%Y-%m-%dT%H:%M:%S%z') Finished ${jupyter_notebook_filename}";
echo "JupyterReports: $(date +'%Y-%m-%dT%H:%M:%S%z') Finished ${jupyter_notebook_filename_without_extension}";
echo "${LOG_GROUP_END}";
done
5 changes: 3 additions & 2 deletions scripts/reports/compilations/VisualizationReports.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ echo "VisualizationReports: REPORTS_SCRIPT_DIR=${REPORTS_SCRIPT_DIR}"
# Run all visualization scripts
for visualization_script_file in "${REPORTS_SCRIPT_DIR}"/*Visualization.sh; do
visualization_script_filename=$(basename -- "${visualization_script_file}")

echo "${LOG_GROUP_START}${visualization_script_filename}";
visualization_script_filename="${visualization_script_filename%.*}" # Remove file extension

echo "${LOG_GROUP_START}Create Visualization Report ${visualization_script_filename}";
echo "VisualizationReports: $(date +'%Y-%m-%dT%H:%M:%S%z') Starting ${visualization_script_filename}...";

source "${visualization_script_file}"
Expand Down
Loading