Enable flamegraphs in Flink

[piyush-zlai]

Summary

This can help us dig into why our Flink jobs are slow. Flink docs

Checklist

• Added Unit Tests
• Covered by existing CI
• Integration tested - Tested by running on Etsy side
• Documentation update

Summary by CodeRabbit

• New Features
  • Enhanced job monitoring through the addition of flame graph generation for improved REST API insights.

[coderabbitai]

Walkthrough

This pull request adds a new configuration property "rest.flamegraph.enabled" -> "true" to the envProps map within the buildFlinkJob method of the DataprocSubmitter class. The update is made alongside an existing property without affecting any public interfaces.

Changes

File	Change Summary
cloud_gcp/.../DataprocSubmitter.scala	Added "rest.flamegraph.enabled" -> "true" to envProps in buildFlinkJob for enabling flame graphs

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant DataprocSubmitter
    participant FlinkRunner

    Caller->>DataprocSubmitter: buildFlinkJob()
    DataprocSubmitter->>DataprocSubmitter: Set envProps (incl. flamegraph enabled)
    DataprocSubmitter->>FlinkRunner: Submit job with envProps

Loading

Possibly related PRs

• Add support to resume Flink job from checkpoint / savepoint #286: Adds a new savepoint URI parameter in buildFlinkJob, directly relating to similar method changes.
• Add flink streaming to run.py + dataprocsubmitter #309: Enhances DataprocSubmitter for Flink job support through updates in buildFlinkJob.
• Flink submit updates to allow Etsy jobs to run #315: Modifies the method signature and logic in DataprocSubmitter.scala for Flink submission, aligning with the new property addition.

Suggested reviewers

• tchow-zlai
• nikhil-zlai

Poem

A spark in our code now glows bright,
A new flag added in the night.
Flamegraphs ignite with a cheer,
Each commit adds magic, clear.
Code sings its song in delight!

Warning

Review ran into problems

🔥 Problems

GitHub Actions and Pipeline Checks: Resource not accessible by integration - https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository.

Please grant the required permissions to the CodeRabbit GitHub App under the organization or repository settings.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 2f50dd4 and 9214e4c.

📒 Files selected for processing (1)

• cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/DataprocSubmitter.scala (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: non_spark_tests
• GitHub Check: non_spark_tests
• GitHub Check: scala_compile_fmt_fix

🔇 Additional comments (1)

cloud_gcp/src/main/scala/ai/chronon/integrations/cloud_gcp/DataprocSubmitter.scala (1)

140-141: LGTM! Good addition for performance debugging.

This change adds flamegraph support to help diagnose slow Flink jobs.

---

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