Merge branch 'master' of github.com:solo-io/squash

README.md

@@ -49,6 +49,8 @@ An annotated version of this demo can be found [here](https://youtu.be/5aNPfwVvL
   - using [IDEs to debug](docs/IDEs.md)
   - using the [command line interface](docs/cli.md)
   - [Debug your java microservices](docs/debuggers/java.md)
+  - [Debug your NodeJS microservices](docs/debuggers/nodejs.md)
+  - [Debug your pyton microservices with VSCode](docs/debuggers/python_vscode.md)
   - [Debug application using service mesh](docs/platforms/istio.md)
 
 - **Developer Documentation**
@@ -64,7 +66,8 @@ An annotated version of this demo can be found [here](https://youtu.be/5aNPfwVvL
  - [gdb](https://www.gnu.org/software/gdb/)
  - [dlv](https://github.com/derekparker/delve)
  - [Java](http://docs.oracle.com/javase/7/docs/technotes/guides/jpda/jdwp-spec.html)
-
+ - [Nodejs](https://nodejs.org/api/debugger.html)
+ - [Python - ptvsd](https://code.visualstudio.com/docs/python/debugging)
 
 ## Supported platforms:
  - [Kubernetes](docs/platforms/kubernetes.md)
@@ -76,10 +79,8 @@ An annotated version of this demo can be found [here](https://youtu.be/5aNPfwVvL
 *We are looking for community help to add support for more debuggers, platforms and IDEs.*
 
 ## Roadmap:
-
-**debuggers**:
-  - [Nodejs](https://nodejs.org/api/debugger.html)
-  - [Python](https://docs.python.org/3/library/pdb.html)
+**debuggers**
+ - [Python](https://docs.python.org/3/library/pdb.html)
 
 **platforms**:
   - [Mesos](http://mesos.apache.org)

docs/debuggers/nodejs.md

@@ -0,0 +1,12 @@
+
+# NodeJS debugger
+
+There are two different debugger options:
+* nodejs - for microservices running Node JS version below 8 (using port 5858)
+* nodejs8 - for Node JS version 8+ (using port (9229)
+
+Additionally, name of the application ("node") often needs to be provided to squash to be able to find the correct process ID.
+* From command line - use `"-p node"`.
+* When using VSCode set `"vs-squash.process-name"` to `"node"` in the workspace settings file (*select "Preferences", "Settings" and click on 
+the "Workspace Settings" tab*)
+

docs/debuggers/python_vscode.md

@@ -0,0 +1,16 @@
+
+# Python debugger for VSCode
+
+Please refer to the following [document](https://code.visualstudio.com/docs/python/debugging#_remote-debugging) 
+for instructions on setting up remote debugging.
+
+Specifically, 
+- Install [ptvsd library](https://pypi.org/project/ptvsd/) 
+- Add code below to the startup .py file, replacing the *passphrase* and *port number* as desired.<br>
+
+> import ptvsd<br>
+> ptvsd.enable_attach("my_secret", address = ('0.0.0.0', 3000))<br>
+
+- In VSCode, set `"vs-squash.pythonSecret"` to the correct passphrase (`"my_secret"` in this case) in the workspace settings 
+file (*select "Preferences", "Settings" and click on the "Workspace Settings" tab*)
+