-
Notifications
You must be signed in to change notification settings - Fork 3.9k
chore: add shared vscode launch config #20103
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds a shared VS Code launch configuration to help developers debug Loki and its tests. The PR includes an exception to .gitignore to allow the .vscode/launch.json file to be committed to version control. Additionally, it includes an unrelated update to the benchmark configuration file, changing the query engine configuration from the nested querier.engine_v2 structure to the top-level query_engine structure.
Key changes:
- New VS Code launch.json with debug configurations for tests, Loki application, and remote debugging
- Updated .gitignore to allow .vscode/launch.json to be tracked
- Configuration structure update in bench config file (unrelated to main PR purpose)
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
.vscode/launch.json |
New file adding VS Code debug configurations for testing, debugging Loki locally and with custom configs, attaching to processes, and remote debugging via dlv |
.gitignore |
Added exception to allow .vscode/launch.json to be committed while ignoring other VS Code files |
pkg/logql/bench/config.yaml |
Updated query engine configuration from nested querier.engine_v2 to top-level query_engine structure (appears unrelated to PR purpose) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| query_engine: | ||
| enable: true | ||
| batch_size: 8192 |
Copilot
AI
Dec 3, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] This configuration change from querier.engine_v2 to query_engine appears unrelated to the PR's stated purpose of adding a VS Code launch configuration. According to the Loki configuration documentation, query_engine is a top-level configuration block, not nested under querier.
While this change appears to be a valid configuration update (moving from the deprecated nested structure to the current top-level structure), it should ideally be in a separate PR or mentioned in the PR description to clarify why it's included. This helps maintain clear change history and makes reviews easier.
| "id": "port", | ||
| "type": "promptString", | ||
| "description": "Port to connect to", | ||
| "default": 18001 |
Copilot
AI
Dec 3, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The default value for the port input should be a string, not an integer. VS Code's promptString type expects string values. Change "default": 18001 to "default": "18001".
| "default": 18001 | |
| "default": "18001" |
What this PR does / why we need it:
Add a shared launch config for debugging with VS Code and like editors.
Special notes for your reviewer:
Checklist
CONTRIBUTING.mdguide (required)featPRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/sources/setup/upgrade/_index.mddeprecated-config.yamlanddeleted-config.yamlfiles respectively in thetools/deprecated-config-checkerdirectory. Example PR