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

Merged
merged 3 commits into from
Feb 22, 2025
Merged

Conversation

pull[bot]
Copy link

@pull pull bot commented Feb 21, 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 updates the documentation for the database and exporting metrics features. It clarifies the different database modes and their use cases, and it emphasizes Netdata's native long-term retention capabilities and the role of exporters in integrating with other observability tools.

Enhancements:

  • Updated the database documentation to better describe the dbengine, ram, and none modes, including use cases for each.
  • Updated the exporting metrics documentation to clarify Netdata's native long-term retention capabilities and the role of exporters in integrating with other observability tools.

Documentation:

  • Improved the database documentation to highlight the performance and storage efficiency of the dbengine mode.
  • Clarified the purpose of the ram mode, emphasizing its suitability for IoT devices and child nodes streaming metrics to Netdata parents.
  • Refined the exporting metrics documentation to emphasize Netdata's native long-term retention and the role of exporters for integration with other tools.

@pull pull bot added the ⤵️ pull label Feb 21, 2025
Copy link

sourcery-ai bot commented Feb 21, 2025

Reviewer's Guide by Sourcery

This pull request updates the documentation for the database and exporting metrics features. It clarifies the use cases for different database modes and emphasizes Netdata's native long-term retention capabilities. The exporting metrics documentation was updated to reflect the role of exporters in integrating with other tools.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated the description of database modes in the README.md file to provide more clarity on their use cases and capabilities.
  • Revised the description of dbengine mode to highlight its storage efficiency and query speed.
  • Clarified the use case for ram mode, emphasizing its suitability for IoT devices and child nodes streaming metrics to Netdata parents.
  • Removed the section detailing the optimization of dbengine mode for long-term data retention and parent nodes.
  • Removed the suggestion to use ram mode for resource-constrained environments, particularly child nodes.
src/database/README.md
Modified the introduction of the exporting metrics documentation to emphasize Netdata's native long-term retention capabilities and the role of exporters for integration with other tools.
  • Replaced the initial paragraph describing Netdata's exporting engine with a statement about Netdata's native long-term retention.
  • Introduced the concept of exporters for copying metrics to third-party time-series databases.
  • Removed the paragraph about exporting being an important part of Netdata's interoperability efforts.
  • Minor grammatical changes.
docs/exporting-metrics/README.md

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 e31a81b into webfutureiorepo:master Feb 22, 2025
1 check passed
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.

2 participants