Add debug documentation and configuration (opensearch-project#9435)

* Add debug documentation and configuration Signed-off-by: Daniel Rowe <rowdane@amazon.com> * Changeset file for PR opensearch-project#9435 created/updated * Change step ordering Signed-off-by: daniel <51932404+d-buckner@users.noreply.github.com> * Update DEVELOPER_GUIDE.md Signed-off-by: daniel <51932404+d-buckner@users.noreply.github.com> --------- Signed-off-by: Daniel Rowe <rowdane@amazon.com> Signed-off-by: daniel <51932404+d-buckner@users.noreply.github.com> Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com> Co-authored-by: Justin Kim <jungkm@amazon.com>
ruchidh · Feb 27, 2025 · 85547a2 · 85547a2
1 parent 06748d2
commit 85547a2
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/.vscode/launch.json 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
@@ -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.
+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.
@@ -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
 

diff --git a/changelogs/fragments/9435.yml 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))
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))