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

feat: re-enable time-partitioning #1267

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

de-sh
Copy link
Contributor

@de-sh de-sh commented Mar 24, 2025

Fixes #XXXX.

Description


This PR has:

  • been tested to ensure log ingestion and log query works.
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added documentation for new or modified features or behaviors.

Summary by CodeRabbit

  • Refactor
    • Updated event partitioning to use a clear true/false indicator for improved and consistent timestamp handling.
    • Enhanced validations during stream updates to prevent conflicts when selecting partitioning options.
  • Bug Fixes
    • Corrected logic in event processing to ensure timestamps are based on the current time rather than outdated values.
    • Adjusted handling of time partitioning in event ingestion to reflect the new boolean structure.

Copy link

coderabbitai bot commented Mar 24, 2025

Walkthrough

This pull request refactors how time partitioning is represented and processed in event structures. The nullable time_partition field is replaced by a boolean is_time_partitioned across several modules, affecting event formatting, processing, HTTP ingestion, and stream creation. The changes include updating the logic for timestamp assignment, validating partition parameters, and adding safeguard checks against conflicting partition configurations.

Changes

File(s) Change Summary
src/event/format/json.rs
src/event/mod.rs
Replaced the nullable time_partition field with a boolean is_time_partitioned in the Event struct. The transformation now uses a check (is_some()) to set the flag, and updates the event processing logic accordingly.
src/handlers/http/ingest.rs Updated the initialization in push_logs_unchecked to use is_time_partitioned: false instead of a nullable time_partition: None, aligning with the new boolean-based handling of time partitions.
src/parseable/mod.rs Modified the create_update_stream method to validate partition parameters. Removed the error condition for non-empty time_partition/time_partition_limit, introduced a time_partition_in_days variable, and added a check for simultaneous use of time and custom partitions.
src/parseable/streams.rs Changed the logic in the push method to use the current UTC time (Utc::now()) for defining the time range in DiskWriter, replacing the previous reliance on a potentially outdated parsed_timestamp.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Client
    participant HTTP as HTTP Ingest Handler
    participant EventProc as Event Processor
    participant TimeGen as Utc::now

    Client->>HTTP: Submit event log
    HTTP->>EventProc: Call push_logs_unchecked (with is_time_partitioned = false)
    EventProc->>TimeGen: If is_time_partitioned is true, request current timestamp
    TimeGen-->>EventProc: Return current timestamp
    EventProc-->>HTTP: Processed event returned
    HTTP-->>Client: Response sent
Loading
sequenceDiagram
    participant Client as Client
    participant Parser as Parseable Module
    participant StreamMgr as Stream Manager

    Client->>Parser: Request stream creation/update
    Parser->>Parser: Validate time_partition_limit and custom_partition
    Parser->>StreamMgr: Call create_stream with time_partition_in_days (if applicable)
    StreamMgr-->>Parser: Stream creation/update response
    Parser-->>Client: Return outcome of stream creation/update
Loading

Possibly related PRs

Suggested labels

for next release

Suggested reviewers

  • nikhilsinhaparseable

Poem

I'm a bouncing rabbit in the code burrow deep,
Hopping with joy while the time partitions leap.
From None to true/false, our fields now gleam,
Clear and precise like a well-crafted dream.
With a twitch of my nose, I cheer this feat—
CodeRabbit leaps forward on happy, swift feet!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 89edfc8 and a516cc0.

📒 Files selected for processing (1)
  • src/parseable/streams.rs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/parseable/streams.rs
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: coverage
  • GitHub Check: Quest Smoke and Load Tests for Standalone deployments
  • GitHub Check: Quest Smoke and Load Tests for Distributed deployments
  • GitHub Check: Build Kafka aarch64-apple-darwin
  • GitHub Check: Build Default x86_64-unknown-linux-gnu
  • GitHub Check: Build Default x86_64-pc-windows-msvc
  • GitHub Check: Build Default aarch64-unknown-linux-gnu
  • GitHub Check: Build Default x86_64-apple-darwin
  • GitHub Check: Build Default aarch64-apple-darwin
  • GitHub Check: Build Kafka x86_64-unknown-linux-gnu

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

@de-sh de-sh marked this pull request as ready for review March 24, 2025 10:55
coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 24, 2025
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/parseable/streams.rs (1)

147-148: Timestamp source changed from parsed_timestamp to current time

The code now uses Utc::now() instead of the provided parsed_timestamp when creating the time range for the DiskWriter. This change is part of re-enabling time-partitioning and shifts from event time to ingestion time for determining partition boundaries.

Consider adding a comment explaining the reasoning behind using the current time rather than the parsed timestamp to make the intent clearer to future developers.

+    // Use current time for partitioning to ensure consistent partition boundaries
+    // based on ingestion time rather than event timestamps
     let range =
         TimeRange::granularity_range(Utc::now(), OBJECT_STORE_DATA_GRANULARITY);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 179d78c and dfeca75.

📒 Files selected for processing (1)
  • src/parseable/streams.rs (1 hunks)
🧰 Additional context used
🧬 Code Definitions (1)
src/parseable/streams.rs (1)
src/utils/time.rs (1)
  • granularity_range (267-282)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Build Default aarch64-unknown-linux-gnu
  • GitHub Check: Build Default x86_64-apple-darwin
  • GitHub Check: Build Default x86_64-pc-windows-msvc
  • GitHub Check: Build Default aarch64-apple-darwin
  • GitHub Check: Build Kafka x86_64-unknown-linux-gnu
  • GitHub Check: Build Default x86_64-unknown-linux-gnu
  • GitHub Check: Build Kafka aarch64-apple-darwin
  • GitHub Check: Quest Smoke and Load Tests for Distributed deployments
  • GitHub Check: coverage
  • GitHub Check: Quest Smoke and Load Tests for Standalone deployments

coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 24, 2025
coderabbitai[bot]
coderabbitai bot previously approved these changes Mar 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant