feat: a brief placeholder document for log-query endpoint #1489

waynexia · 2025-01-22T14:30:05Z

What's Changed in this PR

Describe the change in this PR

A brief document for the new log query endpoint. Since this endpoint is on a very early experimental stage, the document doesn't contains many details.

Checklist

Please confirm that all corresponding versions of the documents have been revised.
Please ensure that the content in sidebars.ts matches the current document structure when you changed the document structure.
This change requires follow-up update in localized docs.

Signed-off-by: Ruihang Xia <[email protected]>

coderabbitai · 2025-01-22T14:30:13Z

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.

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.

cloudflare-workers-and-pages · 2025-01-22T14:35:35Z

Deploying greptime-docs with Cloudflare Pages

Latest commit:	`9b73032`
Status:	✅ Deploy successful!
Preview URL:	https://2f1bd8c8.greptime-docs.pages.dev
Branch Preview URL:	https://log-query.greptime-docs.pages.dev

View logs

Copilot

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

docs/user-guide/query-data/log-query.md

Co-authored-by: Yiran <[email protected]> Co-authored-by: Copilot <[email protected]>

Signed-off-by: Ruihang Xia <[email protected]>

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

nicecui · 2025-01-23T09:03:20Z

docs/user-guide/query-data/log-query.md

+## Request Format
+
+The request body should be a JSON object (this is subject to change in patch version within the experimental phase). For the latest request format, please refer to the [implementation](https://github.com/GreptimeTeam/greptimedb/blob/main/src/log-query/src/log_query.rs):
+


please explain all the keys of the JSON object

They are likely to be changed. This document is only a placeholder for the new experimental endpoint. I'll fill details when it turns stable

fengjiachun

EN part LGTM

nicecui

please add the ZH doc

feat: a brief placeholder document for log-query endpoint

6fc4ec3

Signed-off-by: Ruihang Xia <[email protected]>

waynexia requested a review from paomian January 22, 2025 14:30

waynexia requested review from fengjiachun and nicecui as code owners January 22, 2025 14:30

waynexia requested a review from Copilot January 22, 2025 16:02

Copilot AI reviewed Jan 22, 2025

View reviewed changes

docs/user-guide/query-data/log-query.md Outdated Show resolved Hide resolved

nicecui reviewed Jan 23, 2025

View reviewed changes

docs/user-guide/query-data/log-query.md Outdated Show resolved Hide resolved

docs/user-guide/query-data/log-query.md Outdated Show resolved Hide resolved

docs/user-guide/query-data/log-query.md Show resolved Hide resolved

waynexia and others added 2 commits January 23, 2025 11:30

Apply suggestions from code review

b3c95a9

Co-authored-by: Yiran <[email protected]> Co-authored-by: Copilot <[email protected]>

add cURL example

9b73032

Signed-off-by: Ruihang Xia <[email protected]>

waynexia requested review from nicecui and Copilot January 23, 2025 03:49

Copilot AI reviewed Jan 23, 2025

View reviewed changes

nicecui reviewed Jan 23, 2025

View reviewed changes

fengjiachun reviewed Jan 24, 2025

View reviewed changes

nicecui reviewed Jan 24, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: a brief placeholder document for log-query endpoint #1489

feat: a brief placeholder document for log-query endpoint #1489

waynexia commented Jan 22, 2025 •

edited by nicecui

Loading

coderabbitai bot commented Jan 22, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

cloudflare-workers-and-pages bot commented Jan 22, 2025 •

edited

Loading

Copilot AI left a comment

nicecui Jan 23, 2025

waynexia Jan 23, 2025

fengjiachun left a comment

nicecui left a comment

		## Request Format

		The request body should be a JSON object (this is subject to change in patch version within the experimental phase). For the latest request format, please refer to the [implementation](https://github.com/GreptimeTeam/greptimedb/blob/main/src/log-query/src/log_query.rs):

feat: a brief placeholder document for log-query endpoint #1489

Are you sure you want to change the base?

feat: a brief placeholder document for log-query endpoint #1489

Conversation

waynexia commented Jan 22, 2025 • edited by nicecui Loading

What's Changed in this PR

Checklist

coderabbitai bot commented Jan 22, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

cloudflare-workers-and-pages bot commented Jan 22, 2025 • edited Loading

Deploying greptime-docs with Cloudflare Pages

Copilot AI left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicecui Jan 23, 2025

Choose a reason for hiding this comment

waynexia Jan 23, 2025

Choose a reason for hiding this comment

fengjiachun left a comment

Choose a reason for hiding this comment

nicecui left a comment

Choose a reason for hiding this comment

waynexia commented Jan 22, 2025 •

edited by nicecui

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

cloudflare-workers-and-pages bot commented Jan 22, 2025 •

edited

Loading