Github user sjcorbett commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/354#discussion_r21001069
--- Diff: docs/dev/build/debugging-remote-brooklyn.md ---
@@ -0,0 +1,135 @@
+---
+layout: page
+title: Brooklyn Remote Debugging
+toc: /toc.json
+---
+
+Usually during development, you will be running Brooklyn from your IDE
(see [IDE Setup](ide.html)), in which case
+debugging is as simple as setting a breakpoint. There may however be times
when you need to debug an existing remote
+Brooklyn instance (often referred to as Resident Brooklyn, or rBrooklyn)
on another machine, usually in the cloud.
+
+Thankfully, the tools are available to do this, and setting it up is quite
straightforward. The steps are as follows:
+
+* [Getting the right source code version](#sourceCodeVersion)
+* [Starting Brooklyn with a debug listener](#startingBrooklyn)
+* [Creating an SSH tunnel](#sshTunnel)
+* [Connecting your IDE](#connectingIDE)
+
+## <a name="sourceCodeVersion"></a>Getting the right source code version
+The first step is to ensure that your local copy of the source code is at
the version used to build the remote Brooklyn
+instance. The git commit that was used to build Brooklyn is available via
the REST API:
+
+```
+http://<remote-address>:<remote-port>/v1/server/version
+```
+
+This should return details of the build as a JSON string similar to the
following (formatted for clarity):
+
+```JSON
+{
+ version: "0.7.0-SNAPSHOT",
+ buildSha1: "c0fdc15291702281acdebf1b11d431a6385f5224",
+ buildBranch: "UNKNOWN"
--- End diff --
The JSON object names should be quoted too.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
