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

Commit 3256eed

Browse files
Update options in README (#249)
PR-URL: #249
1 parent 36a0c2c commit 3256eed

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,12 @@ npm install --save @google-cloud/debug-agent
2424

2525
```js
2626
// Require and start in the startup of your application:
27-
require('@google-cloud/debug-agent').start();
27+
require('@google-cloud/debug-agent').start({ allowExpressions: true });
2828
// No auth necessary if your code is running on Google Cloud Platform.
2929

3030
// ... or, if you are running elsewhere, you can manually provide credentials:
3131
require('@google-cloud/debug-agent').start({
32+
allowExpressions: true,
3233
projectId: 'particular-future-12345',
3334
keyFilename: '/path/to/keyfile.json'
3435
});
@@ -56,6 +57,7 @@ If your application is running outside of Google Cloud Platform, such as locally
5657
```JS
5758
// In your app:
5859
var debug = require('@google-cloud/debug-agent').start({
60+
allowExpressions: true,
5961
projectId: 'particular-future-12345',
6062
keyFilename: '/path/to/keyfile.json'
6163
});
@@ -77,6 +79,9 @@ If your application is running outside of Google Cloud Platform, such as locally
7779
```js
7880
// Require and start the agent with configuration options
7981
require('@google-cloud/debug-agent').start({
82+
// Allow the evaluation of watch expressions and snapshot conditions:
83+
allowExpressions: true,
84+
8085
// The path to your key file:
8186
keyFilename: '/path/to/keyfile.json',
8287
@@ -93,20 +98,19 @@ If your application is running outside of Google Cloud Platform, such as locally
9398

9499
## Debugger Agent Settings
95100

96-
You can customize the behaviour of the automatic debugger agent. See [the agent configuration][config-js] for a list of possible configuration options. These options can be passed in the `options.debug` object passed to the `start` function.
101+
You can customize the behaviour of the automatic debugger agent. See [the agent configuration][config-js] for a list of possible configuration options. These options can be passed in the `options` object passed to the `start` function.
97102

98103
```JS
99104
require('@google-cloud/debug-agent').start({
100105
// .. auth settings ..
101106

102107
// debug agent settings:
103-
debug: {
104-
serviceContext: {
105-
service: 'my-service',
106-
version: 'version-1'
107-
},
108-
capture: { maxFrames: 20, maxProperties: 100 }
109-
}
108+
allowExpressions: true,
109+
serviceContext: {
110+
service: 'my-service',
111+
version: 'version-1'
112+
},
113+
capture: { maxFrames: 20, maxProperties: 100 }
110114
});
111115
```
112116

0 commit comments

Comments
 (0)