Refactor LoggingPlanner for better debugging

[wdbaruni]

This PR refactors the LoggingPlanner to provide more structured and comprehensive debugging information while keeping the code maintainable.

Summary by CodeRabbit

• New Features

  • Enhanced logging capabilities for job state transitions and execution lifecycle
  • Added detailed logging for job events, executions, and evaluations

• Improvements

  • Refined log message structure to provide more context about job states and revisions
  • Introduced configurable log levels for better debugging and tracing

[coderabbitai]

Walkthrough

The pull request enhances the logging functionality in the LoggingPlanner within the orchestrator package. A new constant defaultLogLevel is introduced, and several methods are added to improve logging granularity for job state transitions, executions, and evaluations. The changes focus on providing more detailed and structured logging information, with methods that conditionally log events based on the global log level and capture important state changes and execution details.

Changes

File	Change Summary
pkg/orchestrator/planner/logging_planner.go	- Added defaultLogLevel constant set to zerolog.TraceLevel - Enhanced type documentation for LoggingPlanner - Added new logging methods: logNewExecutions(), logExecutionUpdates(), logEvaluations() - Refactored Process method to improve logging structure and conditionals

Possibly related PRs

• more human readable logging pattern #4763: Enhances logging functionality and adjusts verbosity based on debug mode, similar to the current PR's logging improvements

Suggested reviewers

• aronchick

Poem

🐰 Logging Rabbit's Ballad 🔍

Trace levels dancing, states in flight,
Executions logged with rabbit's might
From job to plan, each transition clear
Debug's whispers now ring loud and near
A planner's tale, in zerolog's embrace

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

pkg/orchestrator/planner/logging_planner.go (3)

13-14: Use a configurable log level instead of hardcoding.
Hardcoding defaultLogLevel to Trace might introduce overly verbose logging in non-debugging environments. Consider making this configurable to accommodate different logging needs.

---

30-39: Avoid repeated global log level checks.
Storing the condition zerolog.GlobalLevel() <= defaultLogLevel in a local variable may improve clarity and prevent repeated function calls if more logic is introduced.

---

100-122: Refine naming to maintain consistency.
The attributes “OldState” and “NewState” map to desired states, while “OldComputeState” and “NewComputeState” reference compute states. Consider clarifying the naming for better consistency, e.g. “OldDesiredState”/“NewDesiredState.”

- .Str("OldState", update.Execution.DesiredState.StateType.String()).
+ .Str("OldDesiredState", update.Execution.DesiredState.StateType.String()).

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between eeceb0f and b3f97ea.

📒 Files selected for processing (1)

• pkg/orchestrator/planner/logging_planner.go (2 hunks)

🔇 Additional comments (4)

pkg/orchestrator/planner/logging_planner.go (4)

15-23: Comprehensive and clear documentation.
These doc comments provide a concise overview of the purpose and levels of logging. This clarity is helpful for future maintainers.

---

87-99: Ensure no sensitive data is logged.
Double-check that JobID and NodeID fields do not contain sensitive or private information. If needed, sanitize or redact them before logging.

---

124-138: Well-structured and verbose logging.
Including fields like “WaitUntil” and “TriggeredBy” offers crucial insight during debugging. This method cleanly integrates the relevant data into the logs.

---

Line range hint 43-85: Handle potential nil references in Plan objects.
If there's no guarantee that plan.Job or DesiredJobState is always non-nil, consider adding guards or returning early to avoid panics.