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.

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

feat: QS package for integrations #4578

Merged
merged 12 commits into from
Feb 28, 2024
Merged

Conversation

raj-k-singh
Copy link
Collaborator

@raj-k-singh raj-k-singh commented Feb 20, 2024

Summary

Gets the query-service/app/integrations/... package started with integrations.Manager.
This code is expected to evolve further as other pieces of the integration picture get fleshed out.
Up next:
[ ] wiring up of pipelines for installed integrations.
[ ] exposing integrations manager through query service web API for use in UI
[ ] add more integration assets (dashboards, alerts, saved views...)

Related Issues / PR's

Contributes to #4462

Affected Areas and Manually Tested Areas

None. The integrations package is yet to be wired up with live features.

Summary by CodeRabbit

  • New Features
    • Introduced a comprehensive integration management system for the query service application, enabling users to list, install, and uninstall integrations seamlessly.
    • Added support for SQLite database management of installed integrations, enhancing data handling and storage efficiency.
    • Implemented caching for quick retrieval of integration details, improving application performance.

@github-actions github-actions bot added the enhancement New feature or request label Feb 20, 2024
@raj-k-singh raj-k-singh changed the title feat: QS API for integrations feat: QS package for integrations Feb 22, 2024
@raj-k-singh raj-k-singh marked this pull request as ready for review February 22, 2024 05:09
Copy link

coderabbitai bot commented Feb 22, 2024

Walkthrough

The update introduces a comprehensive framework for managing integrations within the query service application. It encompasses the creation of a Readme.md for documentation, development of core functionalities to handle integration processes, and the establishment of a SQLite repository for persistence. The changes facilitate listing, installing, and uninstalling integrations, alongside managing their configurations and ensuring quick access through caching.

Changes

Files Change Summary
.../integrations/Readme.md Introduced to provide information about SigNoz integrations.
.../integrations/manager.go, .../integrations/repo.go, .../integrations/sqlite_repo.go, .../integrations/test_utils.go Added functionalities for managing integrations, including their lifecycle, configurations, and SQLite database management. Included test utilities and integration handling methods.

🐇✨
In the land of code and byte,
A rabbit hopped with sheer delight.
"New integrations far and wide,
Managed with ease, side by side.
With every hop, a bug takes flight!"
🌟📚🔧

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 7bca847 and 5c792a3.
Files selected for processing (6)
  • pkg/query-service/app/integrations/Readme.md (1 hunks)
  • pkg/query-service/app/integrations/manager.go (1 hunks)
  • pkg/query-service/app/integrations/manager_test.go (1 hunks)
  • pkg/query-service/app/integrations/repo.go (1 hunks)
  • pkg/query-service/app/integrations/sqlite_repo.go (1 hunks)
  • pkg/query-service/app/integrations/test_utils.go (1 hunks)
Files skipped from review as they are similar to previous changes (6)
  • pkg/query-service/app/integrations/Readme.md
  • pkg/query-service/app/integrations/manager.go
  • pkg/query-service/app/integrations/manager_test.go
  • pkg/query-service/app/integrations/repo.go
  • pkg/query-service/app/integrations/sqlite_repo.go
  • pkg/query-service/app/integrations/test_utils.go

Copy link

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5c792a3 and b147b82.
Files selected for processing (3)
  • pkg/query-service/app/integrations/manager.go (1 hunks)
  • pkg/query-service/app/integrations/manager_test.go (1 hunks)
  • pkg/query-service/app/integrations/test_utils.go (1 hunks)
Files skipped from review as they are similar to previous changes (3)
  • pkg/query-service/app/integrations/manager.go
  • pkg/query-service/app/integrations/manager_test.go
  • pkg/query-service/app/integrations/test_utils.go

Copy link
Member

@srikanthccv srikanthccv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@raj-k-singh raj-k-singh merged commit ddaa464 into develop Feb 28, 2024
11 checks passed
@raj-k-singh raj-k-singh deleted the feat/qs-integrations-api-0 branch February 28, 2024 04:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants