Skip to content

Conversation

@Subhra264
Copy link
Contributor

@Subhra264 Subhra264 commented Nov 6, 2024

Fixes #4999

  • Ownership should be set only when writing to metadata streams for the first time.
  • For distinct values, the ownership should set while flush and not write.

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Enhanced logic for schema creation and ownership management in the database.
    • New boolean variable _is_new added to track first-time schema initialization.
  • Bug Fixes

    • Corrected a typo in the shutdown event type from Shutudown to Shutdown.
  • Documentation

    • Updated method signatures to reflect changes in functionality and return types.

@Subhra264 Subhra264 requested a review from hengfeiyang November 6, 2024 04:50
@github-actions github-actions bot added the ☢️ Bug Something isn't working label Nov 6, 2024
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 6, 2024

Walkthrough

The changes involve updates to the DistinctValues and TraceListIndex structs in their respective Rust files. A new boolean variable _is_new is introduced in both structs to manage schema creation logic. The flush method in DistinctValues and the write method in TraceListIndex are modified to utilize this variable for setting ownership only during the first schema initialization. Additionally, a typo in the DvEvent struct is corrected. The return type of the set_db_schema method in TraceListIndex is also changed to indicate schema creation status.

Changes

File Path Change Summary
src/service/metadata/distinct_values.rs - Updated flush method to include _is_new for schema creation logic.
- Corrected typo from Shutudown to Shutdown in DvEventType enum.
- Adjusted shutdown method to reflect the updated enum variant.
- Removed old conditional compilation for ownership in write, replaced with _is_new check in flush.
src/service/metadata/trace_list_index.rs - Introduced _is_new variable to track first-time schema initialization.
- Modified write method to use _is_new for ownership setting.
- Changed return type of set_db_schema from Result<()> to Result<bool>, indicating new schema creation status.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant DistinctValues
    participant TraceListIndex

    Client->>DistinctValues: Call flush()
    DistinctValues->>DistinctValues: Check if _is_new
    alt _is_new is true
        DistinctValues->>Database: Set ownership
    end
    DistinctValues->>Client: Return result

    Client->>TraceListIndex: Call write()
    TraceListIndex->>TraceListIndex: Check if _is_new
    alt _is_new is true
        TraceListIndex->>Database: Set ownership
    end
    TraceListIndex->>Client: Return result
Loading

Assessment against linked issues

Objective Addressed Explanation
Ownership should be set only when writing to metadata streams for the first time. (#[4999])
For distinct values, the ownership should set while flush and not write. (#[4999])

Possibly related PRs

  • fix: list only permitted for enrichment tables list #4480: The changes in this PR also modify the src/service/metadata/distinct_values.rs file, specifically adding a conditional block related to ownership management for the DistinctValues struct, which aligns with the ownership logic updates in the main PR.

Suggested reviewers

  • hengfeiyang
  • oasisk

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between eb8b373 and 3b1d842.

📒 Files selected for processing (2)
  • src/service/metadata/distinct_values.rs (2 hunks)
  • src/service/metadata/trace_list_index.rs (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • src/service/metadata/distinct_values.rs
  • src/service/metadata/trace_list_index.rs

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

Copy link
Contributor

@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

🧹 Outside diff range and nitpick comments (3)
src/service/metadata/trace_list_index.rs (2)

86-88: Consider using a more descriptive variable name.

The variable name is_new could be more specific, like is_schema_newly_created to better convey its purpose.


137-138: Enhance the comment clarity.

The current comment "set ownership only in the first time" could be more descriptive.

-            // set ownership only in the first time
+            // Set ownership only during initial schema creation
src/service/metadata/distinct_values.rs (1)

267-271: Consider adding error handling for ownership setting.

The set_ownership_if_not_exists call could fail silently. Consider logging any errors that occur during ownership setting to aid in troubleshooting.

-                    set_ownership_if_not_exists(
-                        &org_id,
-                        &format!("{}:{}", StreamType::Metadata, STREAM_NAME),
-                    )
-                    .await;
+                    if let Err(e) = set_ownership_if_not_exists(
+                        &org_id,
+                        &format!("{}:{}", StreamType::Metadata, STREAM_NAME),
+                    )
+                    .await
+                    {
+                        log::error!("[DISTINCT_VALUES] Failed to set ownership: {}", e);
+                    }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0c29118 and eb8b373.

📒 Files selected for processing (2)
  • src/service/metadata/distinct_values.rs (2 hunks)
  • src/service/metadata/trace_list_index.rs (4 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
src/service/metadata/distinct_values.rs (1)

Pattern **/*.rs: You are a smart rustlang pull request reviewer.
You are going to review all the rustlang files.
Be concise, and add a brief explanation to your suggestions

Make sure the responses are not too verbose and keep the suggestions to the point i.e. actionable.

src/service/metadata/trace_list_index.rs (1)

Pattern **/*.rs: You are a smart rustlang pull request reviewer.
You are going to review all the rustlang files.
Be concise, and add a brief explanation to your suggestions

Make sure the responses are not too verbose and keep the suggestions to the point i.e. actionable.

🔇 Additional comments (3)
src/service/metadata/trace_list_index.rs (1)

Line range hint 180-222: Consider potential race condition in schema initialization.

While the db_schema_init atomic flag helps prevent multiple schema checks, there's still a potential race condition between checking if db_schema.fields().is_empty() and actually creating the schema. Multiple concurrent calls could lead to multiple schema creation attempts.

Consider using a database transaction or a distributed lock to ensure atomic schema creation.

src/service/metadata/distinct_values.rs (2)

205-207: LGTM: Clean implementation of schema initialization tracking.

The is_new flag effectively tracks first-time schema creation, which is crucial for the ownership setting logic.


258-273: LGTM: Well-structured enterprise feature implementation.

Good implementation of conditional ownership setting:

  • Properly gated behind enterprise feature flag
  • Only sets ownership on first schema creation
  • Clear documentation of intent with "set ownership only in the first time" comment

@Subhra264 Subhra264 merged commit 04402ae into main Nov 6, 2024
28 checks passed
@Subhra264 Subhra264 deleted the distinct_values_rbac_fix branch November 6, 2024 05:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

☢️ Bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Whenever data is written to metadata streams, on each write, openobserve tries to set ofga ownership of metadata stream

3 participants