search

y-scope / clp

Compressed Log Processor (CLP) is a free log management tool capable of compressing logs and searching the compressed logs without decompression.
https://yscope.com
Apache License 2.0
871 stars 70 forks source link

feat(clp-package): Add support for extracting JSON streams from archives. #569

Closed haiqi96 closed 13 hours ago

haiqi96 commented 2 weeks ago

Description

This PR adds json extraction task for the clp-package to prepare for the log-viewer support. The PR contains the following changes:

  1. Added a new JsonExtractionJob to the query-scheduler.
  2. Refactor the query scheduler and extract_task so that they support both IR extraction and Json extraction
  3. Rename the extraction jobs. Such that IR extraction and Json extraction jobs are categorized as "Stream extraction job". Refactor multiple places in the code base to use the new naming standard.
  4. Support submitting a Json extraction job from decompress.sh script

Validation performed

For CLP-unstructured. Confirmed that a compressed file and be opened in the log-viewer via CLP webui.

For CLP-Json Confirmed that a Jsonl file gets can be extracted when submitting a job via decompress.sh script

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The pull request introduces significant changes across multiple files to support JSON extraction alongside existing IR extraction functionalities. Key modifications include the addition of new constants, classes, and methods, as well as renaming attributes and functions to reflect a shift from "IR" to "stream" terminology. These updates enhance command handling, job configuration, and overall flexibility in data extraction processes, ensuring that both IR and JSON types can be processed effectively.

Changes

File Change Summary
components/clp-package-utils/clp_package_utils/general.py Added constant EXTRACT_JSON_CMD, renamed ir_output_dir to stream_output_dir, updated references in generate_container_config and validate_worker_config to accommodate new naming conventions.
components/clp-package-utils/clp_package_utils/scripts/decompress.py Renamed handle_extract_ir_cmd to handle_extract_stream_cmd, added support for JSON extraction, updated command handling logic, and introduced a new parser for JSON extraction commands.
components/clp-package-utils/clp_package_utils/scripts/native/decompress.py Renamed submit_and_monitor_ir_extraction_job_in_db to submit_and_monitor_extraction_job_in_db, updated to handle multiple extraction job types, and modified command handling to support both IR and JSON extraction.
components/job-orchestration/job_orchestration/scheduler/constants.py Added new enum value EXTRACT_JSON to QueryJobType.
components/job-orchestration/job_orchestration/scheduler/job_config.py Introduced ExtractJsonJobConfig class with attributes archive_id and target_chunk_size.
components/job-orchestration/job_orchestration/scheduler/query/query_scheduler.py Added StreamExtractionHandle, IrExtractionHandle, and JsonExtractionHandle classes, updated job handling logic to support both extraction types, and improved error handling with new utility functions.
components/job-orchestration/job_orchestration/scheduler/scheduler_data.py Added ExtractJsonJob class and modified ExtractIrJob class to remove specific properties.
components/clp-package-utils/clp_package_utils/scripts/start_clp.py Updated parameter names from "ir" to "stream" in various functions, reflecting a shift in terminology.
components/clp-py-utils/clp_py_utils/clp_config.py Renamed ir_output to stream_output, introduced StreamOutput class, and updated validation logic accordingly.
components/clp-py-utils/clp_py_utils/create-results-cache-indices.py Changed command-line argument from --ir-collection to --stream-collection, updating associated logic.
components/job-orchestration/job_orchestration/executor/query/celeryconfig.py Updated import and task routing from extract_ir_task to extract_stream_task.
components/job-orchestration/job_orchestration/executor/query/extract_stream_task.py Updated make_command function to handle both IR and JSON extraction, renamed extract_ir to extract_stream, and modified parameters accordingly.
components/log-viewer-webui/server/settings.json Renamed MongoDB configuration keys from MongoDbIrFilesCollectionName to MongoDbStreamFilesCollectionName and updated directory paths.
components/log-viewer-webui/server/src/DbManager.js Renamed variables and methods to reflect changes from IR to stream, added new method submitAndWaitForExtractStreamJob.
components/log-viewer-webui/server/src/app.js Updated MongoDB collection name from irFilesCollectionName to streamFilesCollectionName.
components/log-viewer-webui/server/src/routes/static.js Renamed irFilesDir to streamFilesDir and updated static file serving logic accordingly.
components/package-template/src/etc/clp-config.yml Changed ir_collection_name to stream_collection_name and removed ir_output section, adding a new stream_output section.
components/log-viewer-webui/server/.env Removed IR_DATA_DIR and added STREAMS_DATA_DIR with updated path.
components/log-viewer-webui/client/src/ui/QueryStatus.jsx Introduced functionality for handling JSON extraction queries, modified control flow to accommodate new parameters.

Possibly related PRs

Suggested reviewers

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 1d1599e1d7aac0900834ee5b6655233e2d3b8425 and a5eb21796ab4c76fc8a96c78d150ca2eea3ab752.
📒 Files selected for processing (1) * `components/package-template/src/etc/clp-config.yml` (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * components/package-template/src/etc/clp-config.yml

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
kirkrodrigues commented 3 days ago

Sorry for the delay, still in the process of putting together my review.