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.

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

Add debug documentation and configuration #9435

Merged
merged 5 commits into from
Feb 27, 2025
Merged

Add debug documentation and configuration #9435

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e74cdf8
Add debug documentation and configuration
d-buckner Feb 21, 2025
e6f59f8
Changeset file for PR #9435 created/updated
opensearch-changeset-bot[bot] Feb 21, 2025
87e7f10
Change step ordering
d-buckner Feb 21, 2025
f4e01ff
Update DEVELOPER_GUIDE.md
d-buckner Feb 21, 2025
d0562a9
Merge branch 'main' into debugger-configuration
angle943 Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .vscode/launch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"type": "pwa-node",
"request": "attach",
"name": "attach-to-service",
"port": 9229
}
]
}
7 changes: 6 additions & 1 deletion DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,11 @@ $ wsl -d docker-desktop
$ sysctl -w vm.max_map_count=262144
```

#### Debugging
You can debug the OpenSearch Dashboards server by
1. Attaching your debugger client to the debug port on port `9229`. If you're using VSCode, you can use the `attach-to-server` debug configuration provided.
Copy link
Collaborator

Choose a reason for hiding this comment

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

No love for webstorm? :(

Copy link
Member Author

Choose a reason for hiding this comment

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

I'd love this for webstorm too! Do you know if webstorm has a similar debugging file? We can include as followup.

2. Running `yarn debug`. This will start the OpenSearch Dashboards development server with a debug port open on port `9229`.

### Next Steps

Now that you have a development environment to play with, there are a number of different paths you may take next.
Expand Down Expand Up @@ -265,7 +270,7 @@ $ yarn start --run-examples

#### Join the discussion

See the [communication guide](COMMUNICATION.md)for information on how to join our slack workspace, forum, or developer office hours.
See the [communication guide](COMMUNICATION.md) for information on how to join our slack workspace, forum, or developer office hours.

## Alternative development installations

Expand Down
2 changes: 2 additions & 0 deletions changelogs/fragments/9435.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
doc:
- Add documentation and configuration for server debugging ([#9435](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/9435))
Loading