Skip to content
This repository has been archived by the owner on Apr 3, 2024. It is now read-only.

Commit

Permalink
doc: fix broken images in README (#501)
Browse files Browse the repository at this point in the history
  • Loading branch information
kjin authored and DominicKramer committed Aug 8, 2018
1 parent 4552ab8 commit d023735
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -133,17 +133,17 @@ require('@google-cloud/debug-agent').start({

Once your application is running (deployed, or elsewhere), you should be able to use the [Debug UI][debug-tab] in your Cloud [developer console][dev-console]. You can find the Debug UI in the 'STACKDRIVER -> Debug' section in the navigation panel, or by simply searching for 'Debug' in the cloud console.

<img src="/doc/images/debug-ui.png" alt="Debug UI" />
<img src="https://raw.githubusercontent.com/GoogleCloudPlatform/cloud-debug-nodejs/master/doc/images/debug-ui.png" alt="Debug UI" />

If your source is hosted in a [cloud source repository](https://cloud.google.com/tools/cloud-repositories/docs/), Stackdriver Debugger will display the source code of your application automatically. Alternatively, you can also point the debugger to local files, a GitHub or Bitbucket repository, through a Source Capture, or you can simply type in a filename and line number. More details are on source options are [available here](https://cloud.google.com/debugger/docs/source-options).

If you have the source available, you can set a snapshot by clicking in the gutter (line number area). Once you set a snapshot, the debug agent will insert a momentary breakpoint at the code location in the running instances of the application.

<img src="/doc/images/breakpoint-set.png" alt="Breakpoint Set" />
<img src="https://raw.githubusercontent.com/GoogleCloudPlatform/cloud-debug-nodejs/master/doc/images/breakpoint-set.png" alt="Breakpoint Set" />

As soon as that line of code is reached in any of the running instances of your application, the stack traces, local variables, and watch expressions are captured, and your application continues.

<img src="/doc/images/breakpoint-hit.png" alt="Breakpoint Hit" />
<img src="https://raw.githubusercontent.com/GoogleCloudPlatform/cloud-debug-nodejs/master/doc/images/breakpoint-hit.png" alt="Breakpoint Hit" />

**Note:** The directory layout of the code that is being debugged does not have to exactly match the source code specified in the Debug UI. This is because the debug agent resolves a snapshot filename by searching for a file with the longest matching path suffix. If a unique match is found, that file will be used to set the snapshot.

Expand Down

0 comments on commit d023735

Please sign in to comment.