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

chore(server): add logging to copier #1351

Merged
merged 2 commits into from
Jan 15, 2025

Conversation

nourbalaha
Copy link
Contributor

@nourbalaha nourbalaha commented Jan 15, 2025

Overview

This PR adds logging to copier

Summary by CodeRabbit

  • Logging Enhancements
    • Added detailed logging for task runner operations
    • Improved logging in the model copying process, including progress updates and contextual information
    • Enhanced runtime information for debugging and monitoring, facilitating better traceability during execution

Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

The pull request focuses on enhancing logging capabilities in two key components: the GCP TaskRunner and the Model interactor. The changes introduce detailed log statements in the Run, runCloudBuild, and copy methods of the TaskRunner, as well as in the Copy method of the Model struct. These modifications aim to improve runtime visibility and traceability by adding contextual logging information during various operational stages, without altering the core functionality or control flow of the existing code.

Changes

File Change Summary
server/internal/infrastructure/gcp/taskrunner.go Added log entries in Run, runCloudBuild, and copy methods to track cloud build process stages and provide runtime information.
server/internal/usecase/interactor/model.go Introduced logging statements in Copy method to track model, schema, and item copying operations; modified error handling syntax for clarity.

Suggested reviewers

  • rot1024
  • yk-eukarya

Poem

🐰 Logging Leaps of Insight
Rabbit hops through code's domain,
Tracing paths with log's refrain,
Breadcrumbs left for debug's delight,
Revealing secrets, making clear the plight,
A digital trail, now bright and light! 🔍


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 922a5f6 and a65e3d1.

📒 Files selected for processing (2)
  • server/internal/infrastructure/gcp/taskrunner.go (5 hunks)
  • server/internal/usecase/interactor/model.go (8 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • server/internal/infrastructure/gcp/taskrunner.go
  • server/internal/usecase/interactor/model.go

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@nourbalaha nourbalaha self-assigned this Jan 15, 2025
Copy link

netlify bot commented Jan 15, 2025

Deploy Preview for reearth-cms canceled.

Name Link
🔨 Latest commit a65e3d1
🔍 Latest deploy log https://app.netlify.com/sites/reearth-cms/deploys/6787b638dbc5f600086dabc3

@nourbalaha nourbalaha marked this pull request as ready for review January 15, 2025 13:12
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🔭 Outside diff range comments (2)
server/internal/infrastructure/gcp/taskrunner.go (1)

Line range hint 153-203: Improve logging implementation in copy function.

Several improvements can be made to the logging implementation:

  1. Add error context to log messages
  2. Consolidate redundant log messages
  3. Include more context in log messages
-log.Info("copy: copy event running")
+log.Info("copy: initiating copy operation", log.Fields{"collection": p.Copy.Collection})

-log.Infof("copy: project %v, region %v", project, region)
+log.Info("copy: configuring build", log.Fields{
+    "project": project,
+    "region": region,
+    "disk_size_gb": defaultDiskSizeGb,
+})

-log.Info("copy: call build with region!")
-log.Info("copy: call build without region!")
+log.Info("copy: submitting build", log.Fields{
+    "with_region": region != "",
+    "project": project,
+})

 if err != nil {
+    log.Error("copy: build submission failed", log.Fields{"error": err})
     return rerror.ErrInternalBy(err)
 }

-log.Info("copy: cloud build done!")
+log.Info("copy: build submitted successfully", log.Fields{
+    "project": project,
+    "region": region,
+})
server/internal/usecase/interactor/model.go (1)

Line range hint 457-472: Fix format specifiers and standardize logging.

There are several issues with the logging implementation:

  1. Incorrect format specifiers ('s%' instead of '%s')
  2. Inconsistent use of Info/Infof
  3. String formatting should be replaced with structured logging
-log.Infof("copy: copy event triggered. collection: s%, filter: s%, changes: s%", collection, filter, changes)
+log.Info("copy: triggering copy event", log.Fields{
+    "collection": collection,
+    "filter": filter,
+    "changes": changes,
+})

-log.Infof("copy: task payload created: %v", taskPayload)
+log.Info("copy: created task payload", log.Fields{
+    "payload": taskPayload,
+})

-log.Infof("model: successfully triggered copy event for collection %s, filter: %s, changes: %s", collection, filter, changes)
+log.Info("model: copy event triggered successfully", log.Fields{
+    "collection": collection,
+    "filter": filter,
+    "changes": changes,
+})
🧹 Nitpick comments (3)
server/internal/infrastructure/gcp/taskrunner.go (2)

40-40: Enhance log message with structured fields.

Consider using structured logging fields to improve log searchability and consistency:

-log.Info("copy: run cloud build!")
+log.Info("copy: running cloud build", log.Fields{"operation": "cloud_build"})

78-78: Enhance log message with structured fields.

Consider using structured logging fields for better observability:

-log.Info("copy: run copy!")
+log.Info("copy: running copy operation", log.Fields{"operation": "copy"})
server/internal/usecase/interactor/model.go (1)

Line range hint 368-387: Replace string formatting with structured logging.

Use structured logging instead of string formatting for better log management:

-log.Infof("copy: old model with id %v found", oldModel.ID().String())
+log.Info("copy: found source model", log.Fields{
+    "model_id": oldModel.ID(),
+    "name": oldModel.Name(),
+    "project": oldModel.Project(),
+})

-log.Infof("copy: new model with id %v created", newModel.ID().String())
+log.Info("copy: created target model", log.Fields{
+    "model_id": newModel.ID(),
+    "name": newModel.Name(),
+    "project": newModel.Project(),
+})
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7015005 and 922a5f6.

📒 Files selected for processing (2)
  • server/internal/infrastructure/gcp/taskrunner.go (5 hunks)
  • server/internal/usecase/interactor/model.go (8 hunks)

server/internal/usecase/interactor/model.go Outdated Show resolved Hide resolved
server/internal/usecase/interactor/model.go Outdated Show resolved Hide resolved
@nourbalaha nourbalaha merged commit 02d5f54 into main Jan 15, 2025
24 checks passed
@nourbalaha nourbalaha deleted the chore-server/add-logging-to-copier branch January 15, 2025 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants