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

[pull] master from netdata:master #332

Merged
merged 1 commit into from
Jan 31, 2025
Merged

Conversation

pull[bot]
Copy link

@pull pull bot commented Jan 31, 2025

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Add a new function pgd_fatal to log fatal errors related to page data structures. Replace calls to fatal with pgd_fatal to provide more context when errors occur.

@pull pull bot added the ⤵️ pull label Jan 31, 2025
Copy link

sourcery-ai bot commented Jan 31, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new pgd_fatal function to centralize the formatting of fatal error messages related to PGD (Page Data) structures. This function enhances the clarity of error messages by including detailed information about the PGD structure's state, type, and options. Additionally, the existing fatal calls within the pgd_append_point and pgdc_seek functions were updated to use the new pgd_fatal function.

Sequence diagram for error handling in page operations

sequenceDiagram
    participant Client
    participant PGD
    participant Buffer

    Client->>PGD: pgd_append_point()
    alt Page in invalid state
        PGD->>Buffer: buffer_create()
        PGD->>Buffer: buffer_vsprintf()
        PGD->>Buffer: buffer_strcat() for type
        PGD->>Buffer: buffer_strcat() for state
        PGD->>Buffer: buffer_strcat() for options
        PGD->>Buffer: buffer_tostring()
        PGD-->>Client: fatal error with detailed PGD info
    end
Loading

Class diagram for PGD structure and error handling

classDiagram
    class PGD {
        +type
        +used
        +slots
        +partition
        +states
        +options
        +gorilla
    }

    class PGDState {
        <<enumeration>>
        PGD_STATE_CREATED_FROM_COLLECTOR
        PGD_STATE_CREATED_FROM_DISK
        PGD_STATE_SCHEDULED_FOR_FLUSHING
        PGD_STATE_FLUSHED_TO_DISK
    }

    class PageType {
        <<enumeration>>
        RRDENG_PAGE_TYPE_ARRAY_32BIT
        RRDENG_PAGE_TYPE_ARRAY_TIER1
        RRDENG_PAGE_TYPE_GORILLA_32BIT
    }

    class PageOptions {
        <<enumeration>>
        PAGE_OPTION_ALL_VALUES_EMPTY
        PAGE_OPTION_ARAL_MARKED
        PAGE_OPTION_ARAL_UNMARKED
    }

    note for PGD "Added pgd_fatal() function
for detailed error reporting"
Loading

File-Level Changes

Change Details Files
Introduction of pgd_fatal function for detailed PGD error messages.
  • Added a new static function pgd_fatal that takes a PGD pointer and a format string.
  • The function constructs a detailed error message including the page type, used slots, partition, state, and options.
  • The function uses a buffer to format the message before calling the fatal function.
src/database/engine/page.c
Refactor existing fatal calls to use pgd_fatal.
  • Replaced direct fatal calls in pgd_append_point with calls to pgd_fatal.
  • Replaced direct fatal calls in pgdc_seek with calls to pgd_fatal.
  • The calls now pass the PGD structure to pgd_fatal to include its details in the error message.
src/database/engine/page.c

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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

@pull pull bot merged commit d542b30 into webfutureiorepo:master Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant