Cloud Logging API - Module Google::Cloud (v2.6.1)

Reference documentation and code samples for the Cloud Logging API module Google::Cloud.

Methods

.logging

def self.logging(project_id = nil, credentials = nil, scope: nil, timeout: nil) -> Google::Cloud::Logging::Project

Creates a new object for connecting to the Stackdriver Logging service. Each call creates a new connection.

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

Parameters
  • project_id (String) — Project identifier for the Stackdriver Logging service you are connecting to. If not present, the default project for the credentials is used.
  • credentials (Google::Auth::Credentials) — A Google::Auth::Credentials object. (See Logging::Credentials) @note Warning: Passing a String to a keyfile path or a Hash of credentials is deprecated. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data.

    @example

    # The recommended way to provide credentials is to use the make_creds method # on the appropriate credentials class for your environment.

    credentials = ::Google::Auth::ServiceAccountCredentials.make_creds( json_key_io: ::File.open("/path/to/keyfile.json") )

    logging = Google::Cloud::Logging.new( project_id: "my-project-id", credentials: credentials )

  • scope (String, Array<String>) (defaults to: nil) —

    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/logging.admin
  • timeout (Integer) (defaults to: nil) — Default timeout to use in requests. Optional.
Returns
Example 
require "google/cloud"

logging = Google::Cloud.logging

entries = logging.entries
entries.each do |e|
  puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
end

#logging

def logging(scope: nil, timeout: nil) -> Google::Cloud::Logging::Project

Creates a new object for connecting to the Stackdriver Logging service. Each call creates a new connection.

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

Parameters
  • scope (String, Array<String>) (defaults to: nil) —

    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/logging.admin
  • timeout (Integer) (defaults to: nil) — Default timeout to use in requests. Optional.
Returns
Examples 
require "google/cloud"

gcloud = Google::Cloud.new
logging = gcloud.logging

entries = logging.entries
entries.each do |e|
  puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
end

The default scope can be overridden with the scope option:

require "google/cloud"

gcloud  = Google::Cloud.new
platform_scope = "https://www.googleapis.com/auth/cloud-platform"
logging = gcloud.logging scope: platform_scope