From e74cdf84c4c5b3a94dcfcec42e3409da24394fec Mon Sep 17 00:00:00 2001 From: Daniel Rowe Date: Fri, 21 Feb 2025 11:13:26 -0800 Subject: [PATCH 1/4] Add debug documentation and configuration Signed-off-by: Daniel Rowe --- .vscode/launch.json | 11 +++++++++++ DEVELOPER_GUIDE.md | 7 ++++++- 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 .vscode/launch.json diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 00000000000..9df61a99863 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,11 @@ +{ + "version": "0.2.0", + "configurations": [ + { + "type": "pwa-node", + "request": "attach", + "name": "attach-to-service", + "port": 9229 + } + ] +} diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 07b884245da..22407bc3392 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -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. Running `yarn debug`. This will start the OpenSearch Dashboards development server with a debug port open on port `9229`. +2. 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. + ### Next Steps Now that you have a development environment to play with, there are a number of different paths you may take next. @@ -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 From e6f59f85ea140f69b5f0e4761fcfdce273d544c0 Mon Sep 17 00:00:00 2001 From: "opensearch-changeset-bot[bot]" <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Date: Fri, 21 Feb 2025 19:17:23 +0000 Subject: [PATCH 2/4] Changeset file for PR #9435 created/updated --- changelogs/fragments/9435.yml | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 changelogs/fragments/9435.yml diff --git a/changelogs/fragments/9435.yml b/changelogs/fragments/9435.yml new file mode 100644 index 00000000000..8b6c97602e9 --- /dev/null +++ b/changelogs/fragments/9435.yml @@ -0,0 +1,2 @@ +doc: +- Add documentation and configuration for server debugging ([#9435](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/9435)) \ No newline at end of file From 87e7f10c95ef677cc3efceb7da66b388e44d6539 Mon Sep 17 00:00:00 2001 From: daniel <51932404+d-buckner@users.noreply.github.com> Date: Fri, 21 Feb 2025 14:12:43 -0800 Subject: [PATCH 3/4] Change step ordering Signed-off-by: daniel <51932404+d-buckner@users.noreply.github.com> --- DEVELOPER_GUIDE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 22407bc3392..7fefd3e0192 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -232,8 +232,8 @@ $ sysctl -w vm.max_map_count=262144 #### Debugging You can debug the OpenSearch Dashboards server by -1. Running `yarn debug`. This will start the OpenSearch Dashboards development server with a debug port open on port `9229`. -2. 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. +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. +3. Running `yarn debug`. This will start the OpenSearch Dashboards development server with a debug port open on port `9229`. ### Next Steps From f4e01ff120b0f1ce5f27685b3d8d1ac2fc78a5c0 Mon Sep 17 00:00:00 2001 From: daniel <51932404+d-buckner@users.noreply.github.com> Date: Fri, 21 Feb 2025 14:13:23 -0800 Subject: [PATCH 4/4] Update DEVELOPER_GUIDE.md Signed-off-by: daniel <51932404+d-buckner@users.noreply.github.com> --- DEVELOPER_GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 7fefd3e0192..3787b87b781 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -233,7 +233,7 @@ $ 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. -3. Running `yarn debug`. This will start the OpenSearch Dashboards development server with a debug port open on port `9229`. +2. Running `yarn debug`. This will start the OpenSearch Dashboards development server with a debug port open on port `9229`. ### Next Steps