Module: Google::Cloud

Defined in:
lib/google-cloud-error_reporting.rb,
lib/google/cloud/error_reporting.rb,
lib/google/cloud/error_reporting/rails.rb,
lib/google/cloud/error_reporting/project.rb,
lib/google/cloud/error_reporting/service.rb,
lib/google/cloud/error_reporting/version.rb,
lib/google/cloud/error_reporting/middleware.rb,
lib/google/cloud/error_reporting/credentials.rb,
lib/google/cloud/error_reporting/error_event.rb,
lib/google/cloud/error_reporting/async_error_reporter.rb,
lib/google/cloud/error_reporting/v1beta1/error_group_service_client.rb,
lib/google/cloud/error_reporting/v1beta1/error_stats_service_client.rb,
lib/google/cloud/error_reporting/v1beta1/report_errors_service_client.rb

Defined Under Namespace

Modules: ErrorReporting

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.error_reporting(project = nil, keyfile = nil, scope: nil, timeout: nil, client_config: nil) ⇒ Google::Cloud::ErrorReporting::Project

Create a new object for connecting to the Stackdriver Error Reporting service. Each call creates a new connection.

For more information on connecting to Google Cloud see the Authentication Guide

Examples:

require "google/cloud/error_reporting"

gcloud = Google::Cloud.error_reporting "GCP_Project_ID",
                                       "/path/to/gcp/secretkey.json"

error_event = error_reporting.error_event "Error with Backtrace",
                                          timestamp: Time.now,
                                          service_name: "my_app_name",
                                          service_version: "v8"
error_reporting.report error_event

Parameters:

  • project (String) (defaults to: nil) —

    Google Cloud Platform project identifier for the Stackdriver Error Reporting service you are connecting to. Use Project.default_project if not provided.

  • keyfile (String, Hash) (defaults to: nil) —

    Keyfile downloaded from Google Cloud. If file path the file must be readable.

  • scope (String, Array<String>) —

    The OAuth 2.0 scopes controlling the set of resources and operations that the connection can access. See Using OAuth 2.0 to Access Google APIs.

    The default scope is:

    • https://www.googleapis.com/auth/cloud-platform
  • timeout (Integer) —

    Default timeout to use in requests. Optional.

  • client_config (Hash) —

    A hash of values to override the default behavior of the API client. Optional.

Returns:



104
105
106
107
108
109
110
 
# File 'lib/google-cloud-error_reporting.rb', line 104

def self.error_reporting project = nil, keyfile = nil, scope: nil,
                         timeout: nil, client_config: nil
  require "google/cloud/error_reporting"
  Google::Cloud::ErrorReporting.new project: project, keyfile: keyfile,
                                    scope: scope, timeout: timeout,
                                    client_config: client_config
end

Instance Method Details

#error_reporting(scope: nil, timeout: nil, client_config: nil) ⇒ Google::Cloud::ErrorReporting::Project

Create a new object for connecting to the Stackdriver Error Reporting service. Each call creates a new connection.

For more information on connecting to Google Cloud see the Authentication Guide

Examples:

require "google/cloud/error_reporting"

gcloud = Google::Cloud.new "GCP_Project_ID",
                           "/path/to/gcp/secretkey.json"
error_reporting = gcloud.error_reporting

error_event = error_reporting.error_event "Error with Backtrace",
                                          timestamp: Time.now,
                                          service_name: "my_app_name",
                                          service_version: "v8"
error_reporting.report error_event

Parameters:

  • scope (String, Array<String>) —

    The OAuth 2.0 scopes controlling the set of resources and operations that the connection can access. See Using OAuth 2.0 to Access Google APIs.

    The default scope is:

    • https://www.googleapis.com/auth/cloud-platform
  • timeout (Integer) —

    Default timeout to use in requests. Optional.

  • client_config (Hash) —

    A hash of values to override the default behavior of the API client. Optional.

Returns:



58
59
60
61
62
63
 
# File 'lib/google-cloud-error_reporting.rb', line 58

def error_reporting scope: nil, timeout: nil, client_config: nil
  Google::Cloud.error_reporting @project, @keyfile,
                                scope: scope,
                                timeout: (timeout || @timeout),
                                client_config: client_config
end