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.

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

Enhance Backup Upload Functionality: Return URL, File Size, and Timestamp after Upload to Cloud Storage #47

Open
5 tasks
denisakp opened this issue Nov 18, 2024 · 0 comments
Assignees
Labels
cli enhancement New feature or request priority:medium important features but less urgent
Milestone

Comments

@denisakp
Copy link
Owner

Description

Currently, when a backup is uploaded to cloud storage (e.g., S3, Google Cloud Storage, Azure Blobs), the system only prints a success message. This enhancement aims to extend the functionality by providing additional information after a successful upload, including:

  • URL of the uploaded file.
  • File size (in bytes).
  • Timestamp of when the backup was completed.

These changes are crucial for improving traceability, automation, and error handling.

Why This Change is Necessary 💡

  1. Traceability:

Returning the URL of the uploaded file helps users quickly locate the backup in the cloud storage. In case of any future data recovery or audits, knowing the exact location of the backup file is essential.

  1. Automation:

Many CI/CD pipelines and automated systems rely on accurate metadata to trigger subsequent tasks. By providing the file size and timestamp, we enable better integration with monitoring tools, scripts, or third-party applications that might need this information for further processing.

  1. Error Handling & Debugging:

In case of issues or discrepancies during the backup process, having access to the file URL, size, and timestamp can help in diagnosing problems faster. For instance, if a backup file is missing or corrupted, these details can quickly verify whether the upload was completed correctly.

📝 Acceptance Criteria

After a successful upload to cloud storage, the system should return:

  • Full URL to the uploaded backup file.
  • Size of the file in bytes.
  • Timestamp of when the backup was uploaded.

The new output format should look like this:

Backup uploaded successfully!
URL: https://mybucket.s3.amazonaws.com/backups/mybackup.tar.gz
File size: 50MB
Timestamp: 2024-11-18T10:30:00Z

Tasks 🛠️

  • Update S3 upload handler to return URL, file size, and timestamp.
  • Implement similar updates for Google Cloud Storage and Azure Blob Storage handlers.
  • Update unit tests to validate the output format.
  • Update the documentation to reflect the new output.
  • Perform end-to-end testing to verify the functionality in real cloud environments.
@denisakp denisakp added enhancement New feature or request priority:medium important features but less urgent cli labels Nov 18, 2024
@denisakp denisakp added this to the v1.0 milestone Nov 18, 2024
@denisakp denisakp self-assigned this Nov 18, 2024
@denisakp denisakp moved this to Idea in Sentinel Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli enhancement New feature or request priority:medium important features but less urgent
Projects
Status: In Progress
Development

No branches or pull requests

1 participant