Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add logging for response deadline filtering #91

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

sjmonson
Copy link
Member

@sjmonson sjmonson commented Feb 4, 2025

Adds logging for filtering out responses that arrived after their deadline. Also replaces NaNs in summery section with null to avoid invalid json.

Closes #90

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced summary displays by replacing problematic values with appropriate defaults for cleaner, more reliable output.
    • Improved error notifications to better indicate when operations exceed their expected timeframes, ensuring clearer feedback.

Copy link
Contributor

coderabbitai bot commented Feb 4, 2025

Walkthrough

The pull request modifies two functions in utils.py. In the write_output function, it adds logic to compute and log the number of requests that did not complete within their designated deadlines, including an error log when none complete. Meanwhile, the get_summary function now replaces NaN values with None in its summary statistics output, ensuring cleaner downstream processing. These changes improve error logging and data clarity without altering the original function interfaces.

Changes

File(s) Change Summary
utils.py Modified write_output to calculate & log the count of deadline-exceeded requests and log errors when none complete; updated get_summary to replace NaN values with None.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Function Caller
    participant WO as write_output
    participant Logger as Logger
    Caller->>WO: Invoke write_output()
    WO->>WO: Calculate req_filtered (count of delayed requests)
    alt Some requests completed
        WO->>Logger: Log count of filtered requests
    else No requests completed
        WO->>Logger: Log error message
    end
    WO->>Caller: Return output
Loading
sequenceDiagram
    participant Caller as Function Caller
    participant GS as get_summary
    Caller->>GS: Call get_summary(df, output_obj, summary_key)
    GS->>GS: Process summary statistics
    GS->>GS: Replace NaN values with None
    GS->>Caller: Return cleaned summary
Loading

Assessment against linked issues

Objective Addressed Explanation
Ensure per-request timeout results in valid summary statistics (#90)

Poem

I'm a rabbit with a joyful hop,
Code logs now never miss a drop.
Requests delayed are counted with care,
NaNs replaced—clean stats to share.
With each change, I dance with glee,
A coding rabbit, proud and free! 🐇✨

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.
✨ 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.

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: 0

🧹 Nitpick comments (1)
utils.py (1)

250-253: Consider using dictionary comprehension for better readability.

The NaN replacement logic is correct and aligns with the objective. However, it can be made more concise using dictionary comprehension.

Consider this optimization:

-    # Replace NaNs with None
-    output_obj["summary"][summary_key].update(
-        {k: None for k, v in output_obj["summary"][summary_key].items() if np.isnan(v)}
-    )
+    # Replace NaNs with None
+    output_obj["summary"][summary_key] = {
+        k: None if np.isnan(v) else v
+        for k, v in output_obj["summary"][summary_key].items()
+    }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 23db634 and 41421c2.

📒 Files selected for processing (1)
  • utils.py (2 hunks)
🔇 Additional comments (1)
utils.py (1)

179-183: LGTM! Enhanced logging for deadline filtering.

The added logging provides valuable insights into filtered requests and helps identify test runs where no requests completed within their deadline.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Flaw in setting a per-request timeout
1 participant