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.

Sign up for GitHub

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

Jump to bottom

refactor: support to flatten json object in greptime_identity pipeline #5358

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor: support to flatten json object in greptime_identity pipeline #5358

wants to merge 1 commit into from

Conversation

zyy17
Copy link
Collaborator

@zyy17 zyy17 commented Jan 14, 2025

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Resolve #5346.

Support to flatten JSON object in greptime_identity pipeline.

PR Checklist

Please convert it to a draft if some of the following conditions are not met.

  • I have written the necessary rustdoc comments.
  • I have added the necessary unit tests and integration tests.
  • This PR requires documentation updates.
  • API changes are backward compatible.
  • Schema or data changes are backward compatible.

@zyy17 zyy17 requested a review from a team as a code owner January 14, 2025 11:25
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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.

@zyy17 zyy17 changed the title refactor: support to flatten json object in greptime_identity pipeline refactor: support to flatten json object in greptime_identity pipeline Jan 14, 2025
@github-actions github-actions bot added the docs-required This change requires docs update. label Jan 14, 2025
This was referenced Jan 14, 2025
Open
Open
@zyy17 zyy17 requested review from sunng87, paomian, waynexia and shuiyisong and removed request for a team January 14, 2025 11:27
@codecov Codecov
Copy link

codecov bot commented Jan 14, 2025

Codecov Report

Attention: Patch coverage is 99.13793% with 1 line in your changes missing coverage. Please review.

Project coverage is 83.93%. Comparing base (95b2059) to head (bb72e14).

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #5358      +/-   ##
==========================================
- Coverage   84.15%   83.93%   -0.23%     
==========================================
  Files        1182     1182              
  Lines      221463   221578     +115     
==========================================
- Hits       186377   185979     -398     
- Misses      35086    35599     +513

@sunng87
Copy link
Member

sunng87 commented Jan 14, 2025

This is going to be a breaking change if we modify this identity pipeline directly. An alternative solution is to create a new built-in pipeline, say greptime_json_flattern. WDYT?

@zyy17
Copy link
Collaborator Author

zyy17 commented Jan 15, 2025

This is going to be a breaking change if we modify this identity pipeline directly. An alternative solution is to create a new built-in pipeline, say greptime_json_flattern. WDYT?

Make sense. But I am still considering whether we should flatten JSON object by default, as it would make it easier to use.

@shuiyisong
Copy link
Contributor

shuiyisong commented Jan 15, 2025 •
edited
Loading

How about a processor that flattens a field from input JSON or all fields if the field parameter is absent?

Now that we support the JSON datatype in the database, it's possible that the user wants to store the nested raw JSON data in one column, for example, some extra optional commenting data with JSON format(like structured metadata in the Loki protocol, which doesn't need to be indexed and is only used for display upon query).

@zyy17
Copy link
Collaborator Author

zyy17 commented Jan 15, 2025 •
edited
Loading

@shuiyisong We can add flatten() in the pipeline processor based on the current code. However, always creating a new pipeline is not practical. Flattening the JSON object and adding the index for some hot fields will improve performance.

I decided to add the new internal pipeline, an easy and compatible method. Let the users choose which to use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sunng87 sunng87 Awaiting requested review from sunng87

@paomian paomian Awaiting requested review from paomian

@waynexia waynexia Awaiting requested review from waynexia

@shuiyisong shuiyisong Awaiting requested review from shuiyisong

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
docs-required This change requires docs update.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Support to flatten JSON logs in internal pipeline
3 participants
@zyy17 @sunng87 @shuiyisong