This repository was archived by the owner on Apr 3, 2024. It is now read-only.
Add a configuration section to the README#170
Merged
DominicKramer merged 4 commits intogoogleapis:masterfrom Nov 2, 2016
Merged
Add a configuration section to the README#170DominicKramer merged 4 commits intogoogleapis:masterfrom
DominicKramer merged 4 commits intogoogleapis:masterfrom
Conversation
googlebot
added
the
cla: yes
Contributor
Author
|
PTAL |
ofrobots
suggested changes
Nov 1, 2016
README.md
Outdated
| * `GCLOUD_DEBUG_LOGLEVEL` specifies the debug level | ||
| * `GCLOUD_DEBUG_REPO_APP_PATH` specifies the path within your repository to the directory containing the `package.json` for your deployed application | ||
| * `GAE_MODULE_NAME` specifies the service name of the deployed application | ||
| * `GAE_MODULE_VERSION` specifies the version of the deployed application |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
README.md
Outdated
|
|
||
| Last, you can also provide configuration through a config file. You can start by copying the default config file and modifying it to suit your needs. The `GCLOUD_DIAGNOSTICS_CONFIG` environment variable should point to your configuration file. | ||
|
|
||
| Note that configuration options specified through environment variables take precedence over options passed to the start command, which take precedence over options specified in a config file. |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
The README file was updated so that only the configuration object passed to the `start()` method is the documented way to specify a configuration.
ofrobots
reviewed
Nov 1, 2016
README.md
Outdated
|
|
||
| See [the default configuration](config.js) for a list of possible configuration options. These options can be passed to the agent through the object argument to the start command as shown below: | ||
| ``` | ||
| require('@google/cloud-debug').start({logLevel: 2}); |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a configuration section to the README file that should have been added in PR #167.