| 1 | [//]: # "This README.md file is auto-generated, all changes to this file will be lost."
|
| 2 | [//]: # "To regenerate it, use `python -m synthtool`."
|
| 3 | <img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
|
| 4 |
|
| 5 | # [Stackdriver Debugger: Node.js Client](https://github.com/googleapis/cloud-debug-nodejs)
|
| 6 |
|
| 7 | [](https://cloud.google.com/terms/launch-stages)
|
| 8 | [](https://www.npmjs.org/package/@google-cloud/debug-agent)
|
| 9 | [](https://codecov.io/gh/googleapis/cloud-debug-nodejs)
|
| 10 |
|
| 11 |
|
| 12 |
|
| 13 |
|
| 14 | Stackdriver Debug Agent for Node.js
|
| 15 |
|
| 16 |
|
| 17 | * [Stackdriver Debugger Node.js Client API Reference][client-docs]
|
| 18 | * [Stackdriver Debugger Documentation][product-docs]
|
| 19 | * [github.com/googleapis/cloud-debug-nodejs](https://github.com/googleapis/cloud-debug-nodejs)
|
| 20 |
|
| 21 | Read more about the client libraries for Cloud APIs, including the older
|
| 22 | Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
| 23 |
|
| 24 | [explained]: https://cloud.google.com/apis/docs/client-libraries-explained
|
| 25 |
|
| 26 | **Table of contents:**
|
| 27 |
|
| 28 |
|
| 29 | * [Quickstart](#quickstart)
|
| 30 | * [Before you begin](#before-you-begin)
|
| 31 | * [Installing the client library](#installing-the-client-library)
|
| 32 |
|
| 33 | * [Samples](#samples)
|
| 34 | * [Versioning](#versioning)
|
| 35 | * [Contributing](#contributing)
|
| 36 | * [License](#license)
|
| 37 |
|
| 38 | ## Quickstart
|
| 39 |
|
| 40 | ### Before you begin
|
| 41 |
|
| 42 | 1. [Select or create a Cloud Platform project][projects].
|
| 43 | 1. [Enable the Stackdriver Debugger API][enable_api].
|
| 44 | 1. [Set up authentication with a service account][auth] so you can access the
|
| 45 | API from your local workstation.
|
| 46 |
|
| 47 | ### Installing the client library
|
| 48 |
|
| 49 | ```bash
|
| 50 | npm install @google-cloud/debug-agent
|
| 51 | ```
|
| 52 |
|
| 53 |
|
| 54 |
|
| 55 |
|
| 56 | ## Samples
|
| 57 |
|
| 58 | Samples are in the [`samples/`](https://github.com/googleapis/cloud-debug-nodejs/tree/master/samples) directory. The samples' `README.md`
|
| 59 | has instructions for running the samples.
|
| 60 |
|
| 61 | | Sample | Source Code | Try it |
|
| 62 | | --------------------------- | --------------------------------- | ------ |
|
| 63 | | App | [source code](https://github.com/googleapis/cloud-debug-nodejs/blob/master/samples/app.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/cloud-debug-nodejs&page=editor&open_in_editor=samples/app.js,samples/README.md) |
|
| 64 | | Snippets | [source code](https://github.com/googleapis/cloud-debug-nodejs/blob/master/samples/snippets.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/cloud-debug-nodejs&page=editor&open_in_editor=samples/snippets.js,samples/README.md) |
|
| 65 |
|
| 66 |
|
| 67 |
|
| 68 | The [Stackdriver Debugger Node.js Client API Reference][client-docs] documentation
|
| 69 | also contains samples.
|
| 70 |
|
| 71 | ## Versioning
|
| 72 |
|
| 73 | This library follows [Semantic Versioning](http://semver.org/).
|
| 74 |
|
| 75 |
|
| 76 |
|
| 77 | This library is considered to be in **beta**. This means it is expected to be
|
| 78 | mostly stable while we work toward a general availability release; however,
|
| 79 | complete stability is not guaranteed. We will address issues and requests
|
| 80 | against beta libraries with a high priority.
|
| 81 |
|
| 82 |
|
| 83 |
|
| 84 |
|
| 85 | More Information: [Google Cloud Platform Launch Stages][launch_stages]
|
| 86 |
|
| 87 | [launch_stages]: https://cloud.google.com/terms/launch-stages
|
| 88 |
|
| 89 | ## Contributing
|
| 90 |
|
| 91 | Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/cloud-debug-nodejs/blob/master/CONTRIBUTING.md).
|
| 92 |
|
| 93 | ## License
|
| 94 |
|
| 95 | Apache Version 2.0
|
| 96 |
|
| 97 | See [LICENSE](https://github.com/googleapis/cloud-debug-nodejs/blob/master/LICENSE)
|
| 98 |
|
| 99 | [client-docs]: https://googleapis.dev/nodejs/debugger/latest/
|
| 100 | [product-docs]: https://cloud.google.com/debugger
|
| 101 | [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
|
| 102 | [projects]: https://console.cloud.google.com/project
|
| 103 | [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
|
| 104 | [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=clouddebugger.googleapis.com
|
| 105 | [auth]: https://cloud.google.com/docs/authentication/getting-started
|