You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 3, 2024. It is now read-only.
* Update branding to Stackdriver Debugger.
* It is no longer a requirement that source be uploaded to the cloud
repo.
* Provide documentation on alternative ways to make the source code
accessible.
Copy file name to clipboardExpand all lines: README.md
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Node.js agent for Google Cloud Debug
1
+
# Stackdriver Debugger agent for Node.js
2
2
3
3
[![NPM Version][npm-image]][npm-url]
4
4
[![Build Status][travis-image]][travis-url]
@@ -8,29 +8,28 @@
8
8
9
9
> *This module is experimental, and should be used by early adopters. This module uses APIs there may be undocumented and may be subject to change without notice.*
10
10
11
-
This module provides Cloud Debug support for Node.js applications. [Google Cloud Debug](https://cloud.google.com/tools/cloud-debugger/) is a feature of [Google Cloud Platform](https://cloud.google.com/) that lets you debug your applications in production without stopping or pausing your application. Here's an introductory video:
11
+
This module provides Stackdriver Debugger support for Node.js applications. [Stackdriver Debugger](https://cloud.google.com/tools/cloud-debugger/) is a feature of [Google Cloud Platform](https://cloud.google.com/) that lets you debug your applications in production without stopping or pausing your application. Here's an introductory video:
* Your application will need to be using Node.js version 0.12 or greater. Node.js v5+ is recommended.
17
-
* The source of your application is uploaded to a [cloud source repository](https://cloud.google.com/tools/cloud-repositories/docs/). The Debugger UI needs the source to be available in order to set snapshots.
16
+
* Stackdriver Debugger is comptible with Node.js version 0.12 or greater. Node.js v5+ is recommended.
18
17
19
-
## Quick Start (Node.js v4.x+)
18
+
## Quick Start
20
19
```shell
21
20
# Install with `npm` or add to your `package.json`.
22
21
npm install --save @google/cloud-debug
23
22
24
23
# Require the agent at the top of your main script (but after '@google/cloud-trace' if you are also using it).
25
24
require('@google/cloud-debug');
26
25
```
27
-
Deploy your application, and navigate to the [Debug tab][debug-tab] within the [Google Cloud Console][dev-console] to set snapshots and start debugging.
26
+
Deploy your application, and navigate to the [Strackdriver Debug view][debug-tab] within the [Google Cloud Console][dev-console] to set snapshots and start debugging.
28
27
29
28
## Running on Google Cloud Platform
30
29
31
30
There are three different services that can host Node.js application to Google Cloud Platform.
32
31
33
-
### Google App Engine Flexible Environment
32
+
### Google App Engine Flexible Environment
34
33
35
34
If you are using [Google App Engine Flexible Environment ](https://cloud.google.com/appengine/docs/flexible/), you do not have to do any additional configuration.
36
35
@@ -48,7 +47,7 @@ Container Engine nodes need to also be created with the `cloud-platform` scope,
48
47
49
48
## Running elsewhere
50
49
51
-
If your application is running outside of Google Cloud Platform, such as locally, on-premise, or on another cloud provider, you can still use Cloud Debug.
50
+
If your application is running outside of Google Cloud Platform, such as locally, on-premise, or on another cloud provider, you can still use Stackdriver Debugger.
52
51
53
52
1. You will need to specify your project name. Your project name is visible in the [Google Cloud Console][cloud-console-projects], it may be something like `particular-future-12345`. If your application is [running on Google Cloud Platform](running-on-google-cloud-platform), you don't need to specify the project name.
54
53
@@ -72,7 +71,9 @@ Once your application is running (deployed, or elsewhere), you should be able to
72
71
73
72
74
73
75
-
You can browse the code, and 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.
74
+
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).
75
+
76
+
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.
0 commit comments