fix(ingest/config): move memray to click

[pie1nthesky]

I propose moving memray option from config.flags to click option. It seems to me that profilers belong to click, not to recipe.

I'm going to add cpu profiler here too, and stumbled on memray being in config.flags.

Checklist

• [ ] The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
• [ ] Links to related issues (if applicable)
• [ ] Tests for the changes have been added/updated (if applicable)
• [ ] Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
• [ ] For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

• New Features

  • Introduced a --memory-profiles CLI option to generate memory dumps during ingestion runs.

• Improvements

  • Updated pipeline configuration to enhance memory profiling capabilities.
  • Defaulted system metadata setting to True for better data handling.

[coderabbitai[bot]]

Walkthrough

The recent updates introduce a memory profiling feature to the DataHub ingestion CLI, allowing users to generate memory dumps during ingestion runs. Key modifications include adding a --memory-profiles option to the ingest command, updating the Pipeline class to accept this parameter, and removing the generate_memory_profiles flag from the FlagsConfig class.

Changes

File Path	Change Summary
metadata-ingestion/.../ingest_cli.py	Added --memory-profiles CLI option, updated run(), and run_ingestion_and_check_upgrade() to accept this parameter.
metadata-ingestion/.../pipeline.py	Updated Pipeline class to include memory_profiles parameter and adjusted logic to handle memory profiling.
metadata-ingestion/.../pipeline_config.py	Removed generate_memory_profiles from FlagsConfig and set set_system_metadata default to True.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Pipeline

    User->>CLI: Run ingestion with --memory-profiles option
    CLI->>Pipeline: Pass memory_profiles parameter to Pipeline
    Pipeline->>Pipeline: Initialize with memory profiling enabled
    Pipeline->>CLI: Return profiling data (if applicable)
    CLI->>User: Display results with memory profiling information

Poem

In the land of code where data flows,
A new feature in the CLI grows.
Memory profilers join the run,
Capturing snapshots one by one.
Data streams and bytes align,
Now we can trace every sign.
Cheers to progress, here’s a tune,
For our pipeline’s bright new boon! 🚀🐇

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[hsheth2]

@pie1nthesky We probably can't accept this PR - the main reason it's in the config flags is that we want to be able to use it from UI ingestion as well. We definitely can't just remove the generate_memory_profiles config option, since that's a breaking change.

If you specifically want to use it from the CLI, you can always do memray run ... directly - doesn't feel like a huge improvement to make it a datahub CLI flag.