feat: trace the workflow tenant

[morgante]

Summary by CodeRabbit

• New Features
  • Enhanced logging capabilities to include command-line arguments and tenant-specific information for improved observability during command execution.
• Bug Fixes
  • Improved clarity in logging by renaming tracing spans associated with the plumbing functionality.

[coderabbitai]

Walkthrough

Walkthrough

The pull request introduces enhancements to the logging functionality within the run_command and run_plumbing functions. It adds a new key-value pair to the logging span in run_command, capturing command-line arguments, and incorporates a new environment variable, GRIT_TENANT_ID, in run_plumbing, improving the context provided in logs. These changes aim to enhance the observability of command execution and workflow processes.

Changes

Files	Change Summary
crates/cli/src/commands/mod.rs	Modified the run_command function to include command-line arguments in the logging span, enhancing logging detail for command execution.
crates/cli/src/commands/plumbing.rs	Updated the run_plumbing function to log the new environment variable GRIT_TENANT_ID alongside GRIT_EXECUTION_ID, improving logging for workflow execution.

Possibly related PRs

• feat: add better plumbing logging #473: Modifies the run_command function in mod.rs, focusing on enhancing the logging configuration, related to the logging improvements in this PR.
• fix: remove some of the most verbose logs #499: Introduces a builder pattern for logging configuration in the run_command function in mod.rs, aligning with the logging enhancements in this PR.

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 50690a3 and a1691a9.

Files selected for processing (2)

• crates/cli/src/commands/mod.rs (1 hunks)
• crates/cli/src/commands/plumbing.rs (4 hunks)

Additional comments not posted (5)

crates/cli/src/commands/plumbing.rs (4)

307-308: LGTM!

The code correctly retrieves the value of the GRIT_TENANT_ID environment variable and provides a default empty string if the variable is not set. This is a safe and appropriate way to handle the tenant ID.

---

309-313: LGTM!

The code appropriately logs an informational message that includes the execution_id and tenant_id. This enhances the logging context and provides valuable information for monitoring and debugging purposes.

---

333-335: LGTM!

The code appropriately updates the tracing span for the authentication process by including the execution_id and tenant_id as attributes. This enhances the tracing context and allows for better correlation and analysis of the authentication process.

---

347-349: LGTM!

The code appropriately updates the tracing spans for finding the workflow file and running the workflow by including the execution_id and tenant_id as attributes. This enhances the tracing context and allows for better correlation and analysis of these processes. The changes are consistent with the updates made to the authentication span.

Also applies to: 381-383

crates/cli/src/commands/mod.rs (1)

397-398: Logging enhancement looks good!

The additional key-value pair in the logging span captures the command-line arguments, providing useful context for tracing and debugging command execution. This change enhances observability without introducing any apparent issues.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 generate interesting stats about this repository and render them as a table.
  -- @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 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.

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.