google-cloud-debugger 0.40.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b4ce08aa3118de8cc2a1afe7874ca26f6d97a7922f84471caef85fe0aed3640
+  data.tar.gz: a6bc54a758686120fe5898e69179994e3325e72adf5c9e3b8ef4b0b010a5c9d6
+SHA512:
+  metadata.gz: 150edcd3b7d9c16480900ac16d22925eaf08c1629ac40c601d308da5e3db74237dbacd6510c9357861650d8fe519239c53c361448e3f6d005058313c1e442909
+  data.tar.gz: ce89d0b2545e87b7587b8887a6eafe1dead96614616437ce2709f60a83780a38607990687caf74398a219093d019f68bcd615aac469e1b35efec732c71141508

data/.yardopts

@@ -0,0 +1,18 @@
+--no-private
+--title=Stackdriver Debugger
+--exclude _pb\.rb$
+--markup markdown
+--markup-provider redcarpet
+--main OVERVIEW.md
+
+./lib/**/*.rb
+-
+OVERVIEW.md
+AUTHENTICATION.md
+INSTRUMENTATION.md
+LOGGING.md
+CONTRIBUTING.md
+TROUBLESHOOTING.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+LICENSE

data/AUTHENTICATION.md

@@ -0,0 +1,178 @@
+# Authentication
+
+In general, the google-cloud-debugger library uses [Service
+Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
+credentials to connect to Google Cloud services. When running within [Google
+Cloud Platform environments](#google-cloud-platform-environments)
+the credentials will be discovered automatically. When running on other
+environments, the Service Account credentials can be specified by providing the
+path to the [JSON
+keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
+the account (or the JSON itself) in [environment
+variables](#environment-variables). Additionally, Cloud SDK credentials can also
+be discovered automatically, but this is only recommended during development.
+
+## Quickstart
+
+1. [Create a service account and credentials](#creating-a-service-account).
+2. Set the [environment variable](#environment-variables).
+
+```sh
+export DEBUGGER_CREDENTIALS=/path/to/json`
+```
+
+3. Initialize the client.
+
+```ruby
+require "google/cloud/debugger"
+
+client = Google::Cloud::Debugger.new
+```
+
+## Project and Credential Lookup
+
+The google-cloud-debugger library aims to make authentication
+as simple as possible, and provides several mechanisms to configure your system
+without providing **Project ID** and **Service Account Credentials** directly in
+code.
+
+**Project ID** is discovered in the following order:
+
+1. Specify project ID in method arguments
+2. Specify project ID in configuration
+3. Discover project ID in environment variables
+4. Discover GCE project ID
+5. Discover project ID in credentials JSON
+
+**Credentials** are discovered in the following order:
+
+1. Specify credentials in method arguments
+2. Specify credentials in configuration
+3. Discover credentials path in environment variables
+4. Discover credentials JSON in environment variables
+5. Discover credentials file in the Cloud SDK's path
+6. Discover GCE credentials
+
+### Google Cloud Platform environments
+
+When running on Google Cloud Platform (GCP), including Google Compute Engine (GCE),
+Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions
+(GCF) and Cloud Run, the **Project ID** and **Credentials** and are discovered
+automatically. Code should be written as if already authenticated.
+
+### Environment Variables
+
+The **Project ID** and **Credentials JSON** can be placed in environment
+variables instead of declaring them directly in code. Each service has its own
+environment variable, allowing for different service accounts to be used for
+different services. (See the READMEs for the individual service gems for
+details.) The path to the **Credentials JSON** file can be stored in the
+environment variable, or the **Credentials JSON** itself can be stored for
+environments such as Docker containers where writing files is difficult or not
+encouraged.
+
+The environment variables that google-cloud-debugger checks for project ID are:
+
+1. `DEBUGGER_PROJECT`
+2. `GOOGLE_CLOUD_PROJECT`
+
+The environment variables that google-cloud-debugger checks for credentials are
+configured on `Google::Cloud::Debugger::V2::Debugger::Credentials`:
+
+1. `DEBUGGER_CREDENTIALS` - Path to JSON file, or JSON contents
+2. `DEBUGGER_KEYFILE` - Path to JSON file, or JSON contents
+3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+
+```ruby
+require "google/cloud/debugger"
+
+ENV["DEBUGGER_PROJECT"]     = "my-project-id"
+ENV["DEBUGGER_CREDENTIALS"] = "path/to/keyfile.json"
+
+client = Google::Cloud::Debugger.new
+```
+
+### Configuration
+
+The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+
+```ruby
+require "google/cloud/debugger"
+
+Google::Cloud::Debugger.configure do |config|
+  config.project_id  = "my-project-id"
+  config.credentials = "path/to/keyfile.json"
+end
+
+client = Google::Cloud::Debugger.new
+```
+
+### Cloud SDK
+
+This option allows for an easy way to authenticate during development. If
+credentials are not provided in code or in environment variables, then Cloud SDK
+credentials are discovered.
+
+To configure your system for this, simply:
+
+1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
+2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+3. Write code as if already authenticated.
+
+**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
+*should* only be used during development.
+
+[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
+[dev-console]: https://console.cloud.google.com/project
+
+[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
+
+[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
+[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
+[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
+
+## Creating a Service Account
+
+Google Cloud requires a **Project ID** and **Service Account Credentials** to
+connect to the APIs. You will use the **Project ID** and **JSON key file** to
+connect to most services with google-cloud-debugger.
+
+If you are not running this client within [Google Cloud Platform
+environments](#google-cloud-platform-environments), you need a Google
+Developers service account.
+
+1. Visit the [Google Developers Console][dev-console].
+1. Create a new project or click on an existing project.
+1. Activate the slide-out navigation tray and select **API Manager**. From
+   here, you will enable the APIs that your application requires.
+
+   ![Enable the APIs that your application requires][enable-apis]
+
+   *Note: You may need to enable billing in order to use these services.*
+
+1. Select **Credentials** from the side navigation.
+
+   You should see a screen like one of the following.
+
+   ![Create a new service account][create-new-service-account]
+
+   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
+
+   Find the "Add credentials" drop down and select "Service account" to be
+   guided through downloading a new JSON key file.
+
+   If you want to re-use an existing service account, you can easily generate a
+   new key file. Just select the account you wish to re-use, and click "Generate
+   new JSON key":
+
+   ![Re-use an existing service account][reuse-service-account]
+
+   The key file you download will be used by this library to authenticate API
+   requests and should be stored in a secure location.
+
+## Troubleshooting
+
+If you're having trouble authenticating you can ask for help by following the
+{file:TROUBLESHOOTING.md Troubleshooting Guide}.

data/CHANGELOG.md

@@ -0,0 +1,233 @@
+# Release History
+
+### 0.40.0 / 2020-07-21
+
+This is a major update that removes the "low-level" client interface code, and
+instead adds the new `google-cloud-debugger-v2` gem as a dependency.
+The new dependency is a rewritten low-level client, produced by a next-
+generation client code generator, with improved performance and stability.
+
+This change should have no effect on the high-level interface that most users
+will use. The one exception is that the (mostly undocumented) `client_config`
+argument, for adjusting low-level parameters such as RPC retry settings on
+client objects, has been removed. If you need to adjust these parameters, use
+the configuration interface in `google-cloud-debugger-v2`.
+
+Substantial changes have been made in the low-level interfaces, however. If you
+are using the low-level classes under the `Google::Cloud::Debugger::V2` module,
+please review the docs for the new `google-cloud-debugger-v2` gem. In
+particular:
+
+* Some classes have been renamed, notably the client class itself.
+* The client constructor takes a configuration block instead of configuration
+  keyword arguments.
+* All RPC method arguments are now keyword arguments.
+
+### 0.36.3 / 2020-07-06
+
+#### Bug Fixes
+
+* Fix segfaults on Ruby 2.7
+
+### 0.36.2 / 2020-05-28
+
+#### Documentation
+
+* Fix a few broken links
+
+### 0.36.1 / 2020-05-19
+
+#### Bug Fixes
+
+* Adjusted some default timeout and retry settings
+
+### 0.36.0 / 2020-03-11
+
+#### Features
+
+* Support separate project setting for quota/billing
+
+### 0.35.2 / 2020-01-23
+
+#### Documentation
+
+* Update copyright year
+
+### 0.35.1 / 2019-11-06
+
+#### Bug Fixes
+
+* Update minimum runtime dependencies
+
+### 0.35.0 / 2019-10-29
+
+This release requires Ruby 2.4 or later.
+
+#### Documentation
+
+* Clarify which Google Cloud Platform environments support automatic authentication
+
+#### Performance Improvements
+
+* Update lower-level client network configuration
+
+### 0.34.0 / 2019-08-23
+
+#### Features
+
+* Support overriding of service endpoint
+
+### 0.33.7 / 2019-07-31
+
+* Fix max threads setting in thread pools
+  * Thread pools once again limit the number of threads allocated.
+* Update documentation links
+
+### 0.33.6 / 2019-07-08
+
+* Support overriding service host and port in the low-level client.
+
+### 0.33.5 / 2019-06-11
+
+* Google::Cloud::Env provides additional configuration options including retries and cache control
+* Add VERSION constant
+
+### 0.33.4 / 2019-04-29
+
+* Add AUTHENTICATION.md guide.
+* Update documentation for common types.
+* Extract gRPC header values from request.
+
+### 0.33.3 / 2019-02-13
+
+* Fix bug (typo) in retrieving default on_error proc.
+
+### 0.33.2 / 2019-02-08
+
+* Fix conversion code for ErrorEvent and Debugee.
+  * Prepare for changes in JSON serialization coming in
+    google-protobuf 3.7.
+
+### 0.33.1 / 2019-02-07
+
+* Update concurrent-ruby dependency
+
+### 0.33.0 / 2019-02-01
+
+* Add Debugger on_error configuration.
+* Update Transmitter
+  * Add dependency on current-ruby.
+  * Add Transmitter#on_error method.
+  * Update Transmitter documentation.
+* Make use of Credentials#project_id
+  * Use Credentials#project_id
+    If a project_id is not provided, use the value on the Credentials object.
+    This value was added in googleauth 0.7.0.
+  * Loosen googleauth dependency
+    Allow for new releases up to 0.10.
+    The googleauth devs have committed to maintaining the current API
+    and will not make backwards compatible changes before 0.10.
+
+### 0.32.6 / 2018-11-15
+
+* Update network configuration.
+
+### 0.32.5 / 2018-09-20
+
+* Update documentation.
+  * Change documentation URL to googleapis GitHub org.
+* Fix circular require warning.
+
+### 0.32.4 / 2018-09-12
+
+* Add missing documentation files to package.
+
+### 0.32.3 / 2018-09-10
+
+* Update documentation.
+
+### 0.32.2 / 2018-08-21
+
+* Update documentation.
+
+### 0.32.1 / 2018-07-05
+
+* Fix issue when disabling Stackdriver components with Rails.env.production.
+* Add documentation for enabling gRPC logging.
+
+### 0.32.0 / 2018-05-24
+
+* Delay starting the debugger agent until the first request to ensure it
+  happens after workers are forked. Should prevent grpc from malfunctioning in
+  this case.
+
+### 0.31.0 / 2018-02-27
+
+* Use Google Cloud Shared Configuration.
+* Fix for mutation detection using Ruby 2.5.
+* Support disabling mutation detection in debugger evaluation.
+
+### 0.30.0 / 2017-12-19
+
+* Update google-gax dependency to 1.0.
+
+### 0.29.1 / 2017-11-15
+
+* Fix credentials verification bug in Railtie.
+
+### 0.29.0 / 2017-11-14
+
+* Add `Google::Cloud::Debugger::Credentials` class.
+* Rename constructor arguments to `project_id` and `credentials`.
+  (The previous arguments `project` and `keyfile` are still supported.)
+* Document `Google::Auth::Credentials` as `credentials` value.
+* Add Debugger Agent Design Document.
+* Updated `google-gax` (`grpc`, `google-protobuf`), `googleauth` dependencies.
+
+### 0.28.2 / 2017-09-28
+
+* Improve Breakpoint tracer performance by not tracking C function calls in file tracing.
+* Add a backoff behavior in the debuggee registration to reduce spamming requests when registrations fail.
+
+### 0.28.1 / 2017-09-08
+
+* Print captured exception from asynchronous worker threads.
+
+### 0.28.0 / 2017-08-25
+
+* Support single file Rack-based applications.
+* Support none-Rack-based Ruby applications.
+* API Breaking Change:
+    * `module_name` initialization parameter renamed to `service_name`
+    * `module_version` initialization parameter renamed to `module_version`
+
+### 0.27.0 / 2017-08-07
+
+* Optimize breakpoint evaluation memory usage by adopting shared variable table.
+* Update breakpoint to error state if the breakpoint is set at an invalid position or
+    if condition evaluation fail with an error.
+* Set errored variable evaluation to error state.
+* Restrict the amount of time spent on evaluating breakpoints within each rack application request.
+* Restrict total memory usage on collecting variables within each breakpoint evaluation. Prioritize
+    memory allocation to user defined variables over local variables.
+
+### 0.26.1 / 2017-07-11
+
+* stackdriver-core 1.2.0 release
+
+### 0.26.0 / 2017-07-11
+
+* Update GAPIC configuration to exclude `UNAVAILABLE` errors from automatic retry.
+
+### 0.25.0 / 2017-05-25
+
+* Introduce new `Google::Cloud::Debugger.configure` instrumentation configuration interface.
+
+### 0.24.1 / 2017-04-07
+
+* Fixed Google::Cloud::Debugger::Railtie initialization on non-GCP environments
+    to not interfere with Rails startup
+
+### 0.24.0 / 2017-04-06
+
+* First release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,40 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct. By adopting this Code of Conduct, project
+maintainers commit themselves to fairly and consistently applying these
+principles to every aspect of managing this project. Project maintainers who do
+not follow or enforce the Code of Conduct may be permanently removed from the
+project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the [Contributor
+Covenant](http://contributor-covenant.org), version 1.2.0, available at
+[http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)