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

API changes bring us closer to google-cloud#180

Merged
ofrobots merged 4 commits intogoogleapis:masterfrom
ofrobots:rename-module
Dec 9, 2016
Merged

API changes bring us closer to google-cloud#180
ofrobots merged 4 commits intogoogleapis:masterfrom
ofrobots:rename-module

Conversation

@ofrobots
Copy link
Copy Markdown
Contributor

@ofrobots ofrobots commented Dec 7, 2016

This change adapts the primary interface of this module to align it
with the API exposed by all the other Google Cloud API Client
Libraries available via the google-cloud modules [1].

The primary change is that we return a Debug construtor as the return
value from the module. This, in the future, will provide a Client
Library interface to the Debug APIs. This can be used for programatic
access to list or modify breakpoints, logpoints etc. The constructor,
like other API clients, accepts authentication and other general
configuration.

An instantiated debug object exposes a function startAgent that can
be used to activate the process-wide agent that enables the debugging
of an application using the Stackdriver Debug UI in the Google Cloud
console.

Feel free to bike-shed on startAgent vs start.

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Dec 7, 2016
"split": "^1.0.0"
},
"scripts": {
"test": "./bin/run-test.sh",

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

@@ -52,6 +24,7 @@
"changelog-maker": "^2.2.2",
"closure-npc": "*",

This comment was marked as spam.

This comment was marked as spam.


setTimeout(function() {

This comment was marked as spam.

This comment was marked as spam.

"split": "^1.0.0"
},
"scripts": {
"test": "./bin/run-test.sh",

This comment was marked as spam.

@ofrobots ofrobots force-pushed the rename-module branch 2 times, most recently from c758310 to 1e996bb Compare December 7, 2016 23:31
@ofrobots ofrobots added the semver: major Hint for users that this is an API breaking change. label Dec 7, 2016
@ofrobots
Copy link
Copy Markdown
Contributor Author

ofrobots commented Dec 8, 2016

Ready for another look.

src/index.js Outdated
* This module provides an agent that lets you automatically enable debugging
* without changes to your application.
*
* A low level Client Library for the Debug will also be available through

This comment was marked as spam.

* this module, but is not present at the moment.
*
* @constructor
* @alias module:debug

This comment was marked as spam.

This comment was marked as spam.

This change adapts the primary interface of this module to align it
with the API exposed by all the other Google Cloud API Client
Libraries available via the `google-cloud` modules [1].

The primary change is that we return a Debug construtor as the return
value from the module. This, in the future, will provide a Client
Library interface to the Debug APIs. This can be used for programatic
access to list or modify breakpoints, logpoints etc. The constructor,
like other API clients, accepts authentication and other general
configuration.

An instantiated debug object exposes a function `startAgent` that can
be used to activate the process-wide agent that enables the debugging
of an application using the Stackdriver Debug UI in the Google Cloud
console.

[1]: https://github.com/GoogleCloudPlatform/google-cloud-node
@ofrobots ofrobots merged commit e410c36 into googleapis:master Dec 9, 2016
@ofrobots ofrobots deleted the rename-module branch December 9, 2016 23:30
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cla: yes This human has signed the Contributor License Agreement. semver: major Hint for users that this is an API breaking change.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants