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

Commit

Permalink
docs: add documentation for common config parameters (#1172)
Browse files Browse the repository at this point in the history
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [x] Make sure to open an issue as a [bug/issue](https://togithub.com/googleapis/cloud-debug-nodejs/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)

Fixes #1008 🦕
  • Loading branch information
mctavish authored Oct 2, 2023
1 parent d477d1e commit 1f772d2
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
13 changes: 12 additions & 1 deletion .readme-partials.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,17 @@ body: |-
* firebaseKeyPath - Default google application credentials are used if not
provided.
Some key configuration options are:
* allowExpressions - Whether or not it is permitted to evaluate
epressions. Functionality is limited when this is not set, but there
is some risk that malicious expressions can mutate program state.
* serviceContext - This information is utilized in the UI to identify all
the running instances of your service. Set this if you do not like the
default values.
* capture - Configuration options on what is captured on a snapshot. Set
this if the default snapshot captures are too limited. Note that
relaxing constraints may cause performance impact.
See [the agent configuration][config-ts] for a list of possible configuration
options.
Expand Down Expand Up @@ -70,6 +81,6 @@ body: |-
* The root directory of your application needs to contain a `package.json`
file.
[config-ts]: https://github.com/googleapis/cloud-debug-nodejs/blob/master/src/agent/config.ts
[config-ts]: https://github.com/googleapis/cloud-debug-nodejs/blob/main/src/agent/config.ts
[extension-page]: https://github.com/GoogleCloudPlatform/snapshot-debugger/tree/main/snapshot_dbg_extension
[snapshot-debugger-readme]: https://github.com/GoogleCloudPlatform/snapshot-debugger#readme
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,17 @@ The following options configure the connection to the Firebase database:
* firebaseKeyPath - Default google application credentials are used if not
provided.

Some key configuration options are:
* allowExpressions - Whether or not it is permitted to evaluate
epressions. Functionality is limited when this is not set, but there
is some risk that malicious expressions can mutate program state.
* serviceContext - This information is utilized in the UI to identify all
the running instances of your service. Set this if you do not like the
default values.
* capture - Configuration options on what is captured on a snapshot. Set
this if the default snapshot captures are too limited. Note that
relaxing constraints may cause performance impact.

See [the agent configuration][config-ts] for a list of possible configuration
options.

Expand Down Expand Up @@ -120,7 +131,7 @@ leaks. See [#811](https://github.com/googleapis/cloud-debug-nodejs/issues/811)
* The root directory of your application needs to contain a `package.json`
file.

[config-ts]: https://github.com/googleapis/cloud-debug-nodejs/blob/master/src/agent/config.ts
[config-ts]: https://github.com/googleapis/cloud-debug-nodejs/blob/main/src/agent/config.ts
[extension-page]: https://github.com/GoogleCloudPlatform/snapshot-debugger/tree/main/snapshot_dbg_extension
[snapshot-debugger-readme]: https://github.com/GoogleCloudPlatform/snapshot-debugger#readme

Expand Down

0 comments on commit 1f772d2

Please sign in to comment.