Skip to content

feat: search_history api #4511

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
Merged
hengfeiyang merged 25 commits into from
Sep 12, 2024
Merged

feat: search_history api #4511

hengfeiyang merged 25 commits into from
Sep 12, 2024

Conversation

@Loaki07
Copy link
Contributor

@Loaki07 Loaki07 commented Sep 10, 2024 •
edited by coderabbitai bot
Loading

Closes: #4452

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Introduced a new endpoint for retrieving search history, allowing users to request and view their search history data.
    • Enhanced request and response structures for search history, improving data integrity and usability.

  • Bug Fixes

    • Improved error handling for invalid search history requests, ensuring better user feedback.

  • Documentation

    • Updated routing and service documentation to reflect the new search history functionality.

@CLAassistant
Copy link

CLAassistant commented Sep 10, 2024 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 10, 2024 •
edited
Loading

Walkthrough

The pull request introduces a new API endpoint for retrieving search history, implementing the SearchHistoryRequest and SearchHistoryHitResponse structures to handle requests and responses. It also adds a new asynchronous function, search_history, to process incoming requests, along with a utility struct, SearchHistoryQueryBuilder, for constructing SQL queries. Error handling and metrics management are included to enhance the functionality of the HTTP handler.

Changes

Files Change Summary
src/config/src/meta/search.rs Introduced SearchHistoryRequest, SearchHistoryHitResponse, and SearchHistoryQueryBuilder structs; added methods for validation, query building, and JSON conversion.
src/handler/http/request/search/mod.rs Added asynchronous function search_history to handle POST requests for search history, including error handling and query execution.
src/handler/http/router/mod.rs Updated get_service_routes to include the new search::search_history service.
src/handler/http/router/openapi.rs Added import for request::search::search_history module to facilitate routing.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Router
    participant Handler
    participant Service
    participant Database

    Client->>Router: POST /{org_id}/_search_history
    Router->>Handler: Forward request
    Handler->>Service: Validate and process request
    Service->>Database: Execute search query
    Database-->>Service: Return search results
    Service-->>Handler: Return formatted response
    Handler-->>Router: Send response
    Router-->>Client: Return response
Loading

Assessment against linked issues

Objective Addressed Explanation
Create an API /api/{org}/_search_history (#[4452]) ✅
Filter data by org_id, stream_type, stream_name, user_id, start_time, end_time, trace_id (#[4452]) ✅
Return specified fields in the response (#[4452]) ✅
Report search usage to _meta org (#[4452]) ❌ No implementation for reporting usage in the new API.
Ensure structured request and response handling (#[4452]) ✅

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

@Loaki07 Loaki07 force-pushed the feat/search_history_api branch from a8346e7 to a597f3f Compare September 11, 2024 02:26
@Loaki07
refactor: error message format
25c8df7
@Loaki07
feat: search history query builder & request validation
85e657c
@Loaki07
refactor: default search history sql
ee85db9
@Loaki07
docs: update swagger docs for search history api
6638668
@Loaki07
modify: remove stream_type as query parameter add in request body, se…
b5d823c 
…arch fn will always have stream_type set to logs
@Loaki07
chore: update logs
f4269a0
@Loaki07
refactor: added to_request method to SearchHistoryRequest and size to…
4a8161d 
… request body
@Loaki07
refactor: added to_request method to SearchHistoryRequest and size to…
931c8fb 
… request body
@Loaki07
modify: restrict search history only to path org_id
dc60f90
@Loaki07
docs: update swagger docs
50f98f3
@Loaki07
docs: update swagger docs
8eb7917
@Loaki07
modify: http report metrics
6ed7a9e
@Loaki07
feat: handle query queue for enterprise and non enterprise feature flags
c79a22f
@Loaki07
refactor: search_history handler
13270f9
@Loaki07
modify: report usage metrics for search_histroy
b618145
@Loaki07
modify: restrict history only to requested user_id
6f56c86
@Loaki07
refactor: function names
aba7988
@Loaki07
Merge branch 'main' of github.com:Loaki07/openobserve into feat/searc…
3076dff 
…h_history_api
@Loaki07 Loaki07 marked this pull request as ready for review September 11, 2024 09:13
@Loaki07 Loaki07 force-pushed the feat/search_history_api branch from 0b4d28c to 3076dff Compare September 11, 2024 09:39
@hengfeiyang hengfeiyang self-requested a review September 11, 2024 12:32
@hengfeiyang hengfeiyang merged commit 17e5054 into openobserve:main Sep 12, 2024
@coderabbitai coderabbitai bot mentioned this pull request Sep 12, 2024
Closed
3 tasks
@coderabbitai coderabbitai bot mentioned this pull request Sep 24, 2024
Merged
This was referenced Oct 1, 2024
Merged
Merged
This was referenced Oct 9, 2024
Merged
Merged
Merged
This was referenced Oct 25, 2024
Merged
Merged
Merged
@coderabbitai coderabbitai bot mentioned this pull request Nov 8, 2024
Merged
7 tasks
This was referenced Dec 2, 2024
Merged
Merged
This was referenced Dec 16, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hengfeiyang hengfeiyang hengfeiyang approved these changes

Assignees

No one assigned

Labels

✏️ Feature

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Search history API

3 participants

@Loaki07 @CLAassistant @hengfeiyang