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 #231

Merged
merged 4 commits into from
Feb 26, 2025
Merged

[pull] master from netdata:master #231

merged 4 commits into from
Feb 26, 2025

Conversation

pull[bot]
Copy link

@pull pull bot commented Feb 26, 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

This pull request enhances the daemon status file, improves memory management in the ARAL library, and fixes a crash reporting issue. It introduces a hash-based deduplication mechanism for crash reports, preventing redundant notifications. The daemon status file format is updated to include a version number, error number, and a hash of the status file contents. The ARAL library is refactored to use mmap for larger allocations. Error reporting for required directories is also improved.

Bug Fixes:

  • Fix a crash reporting issue where the same crash would be reported multiple times by implementing a hash-based deduplication mechanism for crash reports, preventing redundant notifications.

Enhancements:

  • Improve the daemon status file by adding a version number and including the error number in the fatal error information.
  • Refactor the ARAL library to use mmap for allocations above a certain size, improving memory management.
  • Update the daemon status file format to include a hash of the status file contents for deduplication purposes, and track the number of restarts.
  • Improve error reporting for required directories by including the environment variable name in the error message.

* deduplicate all crash reports

* fatal messages also log errno; verify required directory logs also the env variable
@pull pull bot added the ⤵️ pull label Feb 26, 2025
@pull pull bot merged commit b71bc97 into Stars1233:master Feb 26, 2025
Copy link

gitstream-cm bot commented Feb 26, 2025

🚨 gitStream Monthly Automation Limit Reached 🚨

Your organization has exceeded the number of pull requests allowed for automation with gitStream.
Monthly PRs automated: 2337/250

To continue automating your PR workflows and unlock additional features, please contact LinearB.

Copy link

sourcery-ai bot commented Feb 26, 2025

Reviewer's Guide by Sourcery

This pull request includes several important updates and optimizations. It updates the daemon status file format, introduces a hashing mechanism to prevent duplicate crash reports, improves error reporting for required directories, optimizes memory allocation in ARAL, adjusts netdata configuration profiles, and modifies the logging mechanism to include errno information.

Sequence diagram for crash report deduplication

sequenceDiagram
    participant Netdata
    participant Daemon Status File
    participant Crash Reporting

    Netdata->>Daemon Status File: Register fatal event
    Daemon Status File->>Daemon Status File: Update session status with fatal event details
    Netdata->>Daemon Status File: Check for crash
    Daemon Status File->>Daemon Status File: Calculate hash of current status
    Daemon Status File->>Daemon Status File: Compare hash with last session's hash and timestamp
    alt Hash matches and timestamp is recent
        Daemon Status File-->>Netdata: Disable crash report
    else Hash does not match or timestamp is old
        Daemon Status File-->>Netdata: Enable crash report
    end
    Netdata->>Crash Reporting: Post crash report (if enabled)
    Crash Reporting-->>Daemon Status File: Acknowledge
    Daemon Status File->>Daemon Status File: Update session status with new hash and timestamp
    Daemon Status File->>Daemon Status File: Save status file
Loading

Updated class diagram for DAEMON_STATUS_FILE

classDiagram
    class DAEMON_STATUS_FILE {
        time_t timestamp
        DAEMON_STATUS status
        EXIT_REASON exit_reason
        fatal fatal
        dedup dedup
    }

    class fatal {
        long line
        string filename
        string function
        string errno_str
        string stack_trace
        string message
    }

    class dedup {
        XXH64_hash_t hash
        usec_t timestamp_ut
        size_t restarts
    }

    DAEMON_STATUS_FILE -- fatal : has
    DAEMON_STATUS_FILE -- dedup : has
    note for fatal "errno_str added"
    note for dedup "timestamp changed to timestamp_ut, hash and restarts added"
Loading

Updated class diagram for ARAL

classDiagram
    class ARAL {
        config config
        ops ops
    }

    class config {
        bool mmap_enabled
        size_t element_size
        int options
    }

    class ops {
        size_t allocation_size
    }

    ARAL -- config : has
    ARAL -- ops : has
    note for ARAL "Optimized memory allocation using mmap based on size and system limits"
Loading

File-Level Changes

Change Details Files
Updates the daemon status file format to version 3, including changes to the dedup section and the addition of errno to the fatal section.
  • Incremented STATUS_FILE_VERSION to 3.
  • Added errno to the fatal information stored in the status file.
  • Replaced timestamp, status, and exit_reason in the dedup section with @timestamp, hash, and restarts.
  • Updated the daemon_status_file_to_json function to include the new fields and version number.
  • Updated the daemon_status_file_from_json function to parse the new fields and handle different versions of the status file.
  • The timestamp in dedup is now stored in microseconds.
  • Added a hash to the dedup section to avoid posting the same crash report multiple times.
src/daemon/daemon-status-file.c
src/daemon/daemon-status-file.h
Introduces a hashing mechanism for daemon status files to prevent duplicate crash reports.
  • Added a daemon_status_file_hash function to calculate a hash of the daemon status file's content.
  • The hash is calculated using XXH3_64bits algorithm.
  • The hash is stored in the dedup section of the daemon status file.
  • The daemon_status_file_check_crash function now checks the hash of the last session status against the current status to avoid posting duplicate crash reports.
src/daemon/daemon-status-file.c
src/daemon/daemon-status-file.h
Improves error reporting for required directories by including the environment variable name in the error message.
  • Modified the verify_required_directory function to include the environment variable name (if available) in the error messages.
  • Updated the error messages to provide more context about the failing directory.
src/daemon/environment.c
Optimizes memory allocation in ARAL by using mmap for larger allocations and introducing a configurable mmap limit.
  • Added a function os_mmap_limit to read the system's mmap limit from /proc/sys/vm/max_map_count on Linux.
  • Added a function aral_malloc_use_mmap to determine if mmap should be used based on the allocation size and the mmap limit.
  • Modified aral_create_page___no_lock_needed to use mmap for allocations exceeding ARAL_MALLOC_USE_MMAP_ABOVE and the mmap limit.
  • Added src/libnetdata/os/mmap_limit.c and src/libnetdata/os/mmap_limit.h to implement the mmap limit functionality.
src/libnetdata/aral/aral.c
src/libnetdata/os/mmap_limit.c
src/libnetdata/os/mmap_limit.h
Removes several keys from being excluded from facets in the systemd-journal plugin.
  • Removed *_RAW, *_USEC, *_NSEC, *_ID, and *_ID_* from the SYSTEMD_KEYS_EXCLUDED_FROM_FACETS macro.
src/collectors/systemd-journal.plugin/systemd-journal.c
Adjusts netdata configuration profiles, specifically reducing malloc arenas for IoT profiles and increasing them for parent profiles.
  • Set nd_profile.malloc_arenas to 1 for IoT profiles.
  • Set nd_profile.malloc_arenas to 4 for parent profiles.
src/daemon/config/netdata-conf-profile.c
Modifies the logging mechanism to include errno information and introduces a logfmt annotator.
  • Modified the nd_log_event function to include errno information when registering a fatal event.
  • Modified the daemon_status_file_register_fatal function to accept and store the errno string.
  • Modified the log_event_t to include errno_str.
  • Added logfmt_annotator to log_field_strdupz.
src/libnetdata/log/nd_log-field-formatters.c
src/libnetdata/log/nd_log.c
src/libnetdata/log/nd_log.h
src/daemon/daemon-status-file.c
src/daemon/daemon-status-file.h

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

Copy link

coderabbitai bot commented Feb 26, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

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