Skip to content
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

♻️ Simple readable agent logs (⚠️ devops) #3599

Merged
merged 4 commits into from
Nov 25, 2022
Merged

♻️ Simple readable agent logs (⚠️ devops) #3599

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fbfb339
extending logs
Nov 24, 2022
cf69159
Merge branch 'master' into pr-osparc-agent-better-logging
GitHK Nov 24, 2022
02ccc24
refactor
Nov 24, 2022
0c7e3c3
Merge branch 'master' into pr-osparc-agent-better-logging
GitHK Nov 25, 2022
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
43 changes: 38 additions & 5 deletions services/agent/src/simcore_service_agent/modules/volumes_cleanup/_s3.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import logging
from asyncio.streams import StreamReader
from pathlib import Path
from textwrap import dedent
from typing import Final

from settings_library.r_clone import S3Provider
Expand Down Expand Up @@ -82,6 +83,37 @@ def _get_r_clone_str_command(command: list[str], exclude_files: list[str]) -> st
return str_command


def _log_expected_operation(
dyv_volume_labels: dict[str, str],
s3_path: Path,
r_clone_ls_output: str,
volume_name: str,
) -> None:
"""
This message will be logged as warning if any files will be synced
"""
log_level = logging.INFO if r_clone_ls_output.strip() == "" else logging.WARNING

formatted_message = dedent(
f"""
---
Volume data
---
volume_name {volume_name}
destination_path {s3_path}
study_id: {dyv_volume_labels['study_id']}
node_id: {dyv_volume_labels['node_uuid']}
user_id: {dyv_volume_labels['user_id']}
run_id: {dyv_volume_labels['run_id']}
---
Files to sync by rclone
---\n{r_clone_ls_output.rstrip()}
---
"""
)
logger.log(log_level, formatted_message)


async def store_to_s3( # pylint:disable=too-many-locals,too-many-arguments
volume_name: str,
dyv_volume: dict,
Expand Down Expand Up @@ -120,10 +152,11 @@ async def store_to_s3( # pylint:disable=too-many-locals,too-many-arguments
stderr=asyncio.subprocess.STDOUT,
)

output = await _read_stream(process.stdout)
r_clone_ls_output = await _read_stream(process.stdout)
await process.wait()
log_level = logging.INFO if output.strip() == "" else logging.WARNING
logger.log(log_level, "Files to be synced:\n%s", output)
_log_expected_operation(
dyv_volume["Labels"], s3_path, r_clone_ls_output, volume_name
)

# sync files via rclone
r_clone_sync = [
Expand Down Expand Up @@ -152,9 +185,9 @@ async def store_to_s3( # pylint:disable=too-many-locals,too-many-arguments
stderr=asyncio.subprocess.STDOUT,
)

output = await _read_stream(process.stdout)
r_clone_sync_output = await _read_stream(process.stdout)
await process.wait()
logger.info("Sync result:\n%s", output)
logger.info("Sync result:\n%s", r_clone_sync_output)

if process.returncode != 0:
raise RuntimeError(
Expand Down