Skip to content

Conversation

@wangfakang
Copy link
Collaborator

@wangfakang wangfakang commented Nov 25, 2025

Summary by Sourcery

Update diagnose defaults to use a longer interval and larger sync step for diagnostic cycles.

Enhancements:

  • Increase the default diagnostic interval from 10 to 20 seconds and align related environment variable documentation.
  • Raise the default diagnostic sync step from 100 to 580 steps and update associated comments and docstrings.

Co-authored-by: 毅松 <fakang.wfk@antgroup.com>
Signed-off-by: wangfakang <fakangwang@gmail.com>
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Nov 25, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Update Diagnose’s default diagnostic interval and sync step configuration from 10s/100 steps to 20s/580 steps, keeping code, comments, and docstrings consistent with the new defaults.

Class diagram for updated Diagnose defaults

classDiagram
    class Diagnose {
        +ProcessGroup group
        +int interval = 20
        +bool enable_ll_diagnose
        +bool enable_normal_diagnose
        +bool enable_async
        +uint64 sync_step = 580
        +Event stop_diagnose

        +Diagnose(group, interval, enable_ll_diagnose, enable_normal_diagnose, enable_async)
        +diagnose_ll_sync(diagnose_step)
        +diagnose_normal_sync(diagnose_step)
    }

    class EnvironmentVariables {
        +int DEEPEP_DIAGNOSE_ENABLE = 1
        +int DEEPEP_DIAGNOSE_INTERVAL = 20
        +uint64 DEEPEP_DIAGNOSE_SYNC_STEP = 580
        +string DEEPEP_DIAGNOSE_LOG_PATH = .
        +string DEEPEP_DIAGNOSE_LOG_DETAILS = 0
    }

    Diagnose ..> EnvironmentVariables : reads_defaults_from
Loading

File-Level Changes

Change Details Files
Increase the default diagnose interval and sync step values and align all related documentation and comments.
  • Change DEEPEP_DIAGNOSE_INTERVAL environment variable documentation to use 20 seconds as the default interval.
  • Update Diagnose.init default interval parameter from 10 to 20 and adjust the constructor docstring accordingly.
  • Update inline comment describing the diagnose interval default from 10 to 20 seconds.
  • Correct the inline comment for the diagnose sync step default from 100 to 580 to match the actual default value used for DEEPEP_DIAGNOSE_SYNC_STEP.
  • Update docstring notes for diagnose_ll_sync and diagnose_normal_sync to reference calling every 580 steps instead of every 100 steps.
src/deepxtrace/diagnose.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@wangfakang wangfakang changed the title update the default value of diagnostic cycle from 10 to 20 seconds. update the default value of diagnostic cycle from 10 to 20 seconds Nov 25, 2025
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @wangfakang, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request adjusts the default timing and synchronization parameters within the diagnostic system. The primary goal is to modify the frequency of diagnostic cycles and update the reference for synchronous diagnostic steps, which could influence the system's monitoring behavior and resource usage.

Highlights

  • Diagnostic Interval Default Update: The default diagnostic cycle period has been increased from 10 seconds to 20 seconds. This affects both the DEEPEP_DIAGNOSE_INTERVAL environment variable and the interval parameter in the Diagnose class constructor.
  • Diagnostic Sync Step Reference Update: The default value for DEEPEP_DIAGNOSE_SYNC_STEP has been updated from 100 to 580. This change is reflected in comments and documentation examples for synchronous diagnostic functions.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes - here's some feedback:

  • In the docstrings for diagnose_ll_sync and diagnose_normal_sync, the example step count (580) is hard-coded; consider referencing the configured sync_step (or describing it relative to that value) to avoid the docs drifting again if the default changes in the future.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the docstrings for diagnose_ll_sync and diagnose_normal_sync, the example step count (580) is hard-coded; consider referencing the configured sync_step (or describing it relative to that value) to avoid the docs drifting again if the default changes in the future.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the default diagnostic interval from 10 to 20 seconds and aligns documentation with the default values. The changes are correct and improve consistency. My review includes a suggestion to define the default values as constants to enhance maintainability.

@wangfakang wangfakang merged commit 99236b0 into main Nov 25, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants