Class: Google::Cloud::Logging::Project

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/logging/project.rb

Overview

Project

Projects are top-level containers in Google Cloud Platform. They store information about billing and authorized users, and they control access to Stackdriver Logging resources. Each project has a friendly name and a unique ID. Projects can be created only in the Google Developers Console. See Google::Cloud#logging.

See Google::Cloud#logging

Examples:

require "google/cloud"

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

Instance Method Summary collapse

Instance Method Details

#create_metric(name, filter, description: nil) ⇒ Google::Cloud::Logging::Metric Also known as: new_metric

Creates a new logs-based metric for Google Cloud Monitoring.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
logging = gcloud.logging
metric = logging.create_metric "errors", "severity>=ERROR"

Parameters:

  • name (String) —

    The client-assigned metric identifier. Metric identifiers are limited to 1000 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/\. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.

  • filter (String) —

    An advanced logs filter.

  • description (String, nil) —

    A description of this metric, which is used in documentation.

Returns:

See Also:



600
601
602
603
604
 
# File 'lib/google/cloud/logging/project.rb', line 600

def create_metric name, filter, description: nil
  ensure_service!
  grpc = service.create_metric name, filter, description
  Metric.from_grpc grpc, service
end

#create_sink(name, destination, filter: nil, version: :unspecified) ⇒ Google::Cloud::Logging::Sink Also known as: new_sink

Creates a new project sink. When you create a sink, only new log entries that match the sink's filter are exported. Stackdriver Logging does not send previously-ingested log entries to the sink's destination.

Before creating the sink, ensure that you have granted cloud-logs@google.com permission to write logs to the destination. See Permissions for writing exported logs.

Examples:

require "google/cloud"

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

bucket = storage.create_bucket "my-logs-bucket"

# Grant owner permission to Stackdriver Logging service
email = "cloud-logs@google.com"
bucket.acl.add_owner "group-#{email}"

sink = logging.create_sink "my-sink",
                           "storage.googleapis.com/#{bucket.id}"

Parameters:

  • name (String) —

    The client-assigned sink identifier. Sink identifiers are limited to 1000 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-..

  • destination (String) —

    The resource name of the export destination. See About sinks for examples.

  • filter (String, nil) —

    An advanced logs filter that defines the log entries to be exported. The filter must be consistent with the log entry format designed by the version parameter, regardless of the format of the log entry that was originally written to Stackdriver Logging.

  • version (Symbol) —

    The log entry version used when exporting log entries from this sink. This version does not have to correspond to the version of the log entry when it was written to Stackdriver Logging. Accepted values are :unspecified, :v2, and :v1. Version 2 is currently the preferred format. An unspecified version format currently defaults to V2 in the service. The default value is :unspecified.

Returns:

See Also:



495
496
497
498
499
500
 
# File 'lib/google/cloud/logging/project.rb', line 495

def create_sink name, destination, filter: nil, version: :unspecified
  version = Sink.resolve_version version
  ensure_service!
  grpc = service.create_sink name, destination, filter, version
  Sink.from_grpc grpc, service
end

#delete_log(name) ⇒ Boolean

Deletes a log and all its log entries. The log will reappear if it receives new entries.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
logging = gcloud.logging
logging.delete_log "my_app_log"

Parameters:

  • name (String) —

    The name of the log, which may be the full path including the project ID (projects/<project-id>/logs/<log-id>), or just the short name (<log-id>), in which case the beginning of the path will be automatically prepended, using the ID of the current project.

Returns:

  • (Boolean) —

    Returns true if the log and all its log entries were deleted.



326
327
328
329
330
 
# File 'lib/google/cloud/logging/project.rb', line 326

def delete_log name
  ensure_service!
  service.delete_log name
  true
end

#entries(projects: nil, filter: nil, order: nil, token: nil, max: nil) ⇒ Array<Google::Cloud::Logging::Entry> Also known as: find_entries

Lists log entries. Use this method to retrieve log entries from Cloud Logging.

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

You can use a filter to narrow results to a single log.

require "google/cloud"

gcloud = Google::Cloud.new
logging = gcloud.logging
entries = logging.entries filter: "log:syslog"
entries.each do |e|
  puts "[#{e.timestamp}] #{e.payload.inspect}"
end

You can also order the results by timestamp.

require "google/cloud"

gcloud = Google::Cloud.new
logging = gcloud.logging
entries = logging.entries order: "timestamp desc"
entries.each do |e|
  puts "[#{e.timestamp}] #{e.log_name} #{e.payload.inspect}"
end

Retrieve all log entries: (See Entry::List#all)

require "google/cloud"

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

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

Parameters:

  • projects (String, Array) —

    One or more project IDs or project numbers from which to retrieve log entries. If nil, the ID of the receiving project instance will be used.

  • filter (String) —

    An advanced logs filter. The filter is compared against all log entries in the projects specified by projects. Only entries that match the filter are retrieved. An empty filter matches all log entries.

  • order (String) —

    How the results should be sorted. Presently, the only permitted values are "timestamp" (default) and "timestamp desc".

  • token (String) —

    A previously-returned page token representing part of the larger set of results to view.

  • max (Integer) —

    Maximum number of entries to return.

Returns:



147
148
149
150
151
152
153
154
 
# File 'lib/google/cloud/logging/project.rb', line 147

def entries projects: nil, filter: nil, order: nil, token: nil, max: nil
  ensure_service!
  list_grpc = service.list_entries projects: projects, filter: filter,
                                   order: order, token: token, max: max
  Entry::List.from_grpc list_grpc, service,
                        projects: projects, max: max,
                        filter: filter, order: order
end

#entry(log_name: nil, resource: nil, timestamp: nil, severity: nil, insert_id: nil, labels: nil, payload: nil) ⇒ Google::Cloud::Logging::Entry Also known as: new_entry

Creates an new Entry instance that may be populated and written to the Stackdriver Logging service. The Entry#resource attribute is pre-populated with a new Resource instance. Equivalent to calling Google::Cloud::Logging::Entry.new.

Examples:

require "google/cloud"

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

entry = logging.entry severity: :INFO, payload: "Job started."

logging.write_entries entry

Parameters:

  • log_name (String) —

    The resource name of the log to which this log entry belongs. See also Entry#log_name=.

  • resource (Resource) —

    The monitored resource associated with this log entry. See also Entry#resource.

  • timestamp (Time) —

    The time the event described by the log entry occurred. If omitted, Stackdriver Logging will use the time the log entry is written. See also Entry#timestamp.

  • severity (Symbol) —

    The severity level of the log entry. The default value is DEFAULT. See also Entry#severity.

  • insert_id (String) —

    A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same log with the same ID as duplicates which can be removed. If omitted, Stackdriver Logging will generate a unique ID for this log entry. See also Entry#insert_id.

  • labels (Hash{Symbol,String => String}) —

    A hash of user-defined key:value pairs that provide additional information about the log entry. See also Entry#labels=.

  • payload (String, Hash) —

    The log entry payload, represented as either a string, a hash (JSON), or a hash (protocol buffer). See also Entry#payload.

Returns:



196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/google/cloud/logging/project.rb', line 196

def entry log_name: nil, resource: nil, timestamp: nil, severity: nil,
          insert_id: nil, labels: nil, payload: nil
  e = Entry.new
  e.log_name = log_name if log_name
  e.resource = resource if resource
  e.timestamp = timestamp if timestamp
  e.severity = severity if severity
  e.insert_id = insert_id if insert_id
  e.labels = labels if labels
  e.payload = payload if payload
  e
end

#logger(log_name, resource, labels = {}) ⇒ Google::Cloud::Logging::Logger

Creates a logger instance that is API-compatible with Ruby's standard library Logger.

Examples:

require "google/cloud"

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

resource = logging.resource "gae_app",
                            module_id: "1",
                            version_id: "20150925t173233"

logger = logging.logger "my_app_log", resource, env: :production
logger.info "Job started."

Parameters:

  • log_name (String) —

    A log resource name to be associated with the written log entries.

  • resource (Google::Cloud::Logging::Resource) —

    The monitored resource to be associated with written log entries.

  • labels (Hash) (defaults to: {}) —

    A set of user-defined data to be associated with written log entries.

Returns:



302
303
304
 
# File 'lib/google/cloud/logging/project.rb', line 302

def logger log_name, resource, labels = {}
  Logger.new self, log_name, resource, labels
end

#metric(name) ⇒ Google::Cloud::Logging::Metric? Also known as: get_metric, find_metric

Retrieves metric by name.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
logging = gcloud.logging
metric = logging.metric "existing_metric"

By default nil will be returned if metric does not exist.

require "google/cloud"

gcloud = Google::Cloud.new
logging = gcloud.logging
metric = logging.metric "non_existing_metric" #=> nil

Parameters:

  • name (String) —

    Name of a metric.

Returns:



629
630
631
632
633
634
635
 
# File 'lib/google/cloud/logging/project.rb', line 629

def metric name
  ensure_service!
  grpc = service.get_metric name
  Metric.from_grpc grpc, service
rescue Google::Cloud::NotFoundError
  nil
end

#metrics(token: nil, max: nil) ⇒ Array<Google::Cloud::Logging::Metric> Also known as: find_metrics

Retrieves the list of metrics belonging to the project.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
logging = gcloud.logging
metrics = logging.metrics
metrics.each do |m|
  puts "#{m.name}: #{m.filter}"
end

Retrieve all metrics: (See Metric::List#all)

require "google/cloud"

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

metrics.all do |m|
  puts "#{m.name}: #{m.filter}"
end

Parameters:

  • token (String) —

    A previously-returned page token representing part of the larger set of results to view.

  • max (Integer) —

    Maximum number of metrics to return.

Returns:



566
567
568
569
570
 
# File 'lib/google/cloud/logging/project.rb', line 566

def metrics token: nil, max: nil
  ensure_service!
  grpc = service.list_metrics token: token, max: max
  Metric::List.from_grpc grpc, service, max
end

#project ⇒ String

The ID of the current project.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new "my-project", "/path/to/keyfile.json"
logging = gcloud.logging

logging.project #=> "my-project"

Returns:

  • (String) —

    the Google Cloud project ID



71
72
73
 
# File 'lib/google/cloud/logging/project.rb', line 71

def project
  service.project
end

#resource(type, labels = {}) ⇒ Google::Cloud::Logging::Resource Also known as: new_resource

Creates a new monitored resource instance.

Examples:

require "google/cloud"

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

resource = logging.resource "gae_app",
                            "module_id" => "1",
                            "version_id" => "20150925t173233"

Returns:



390
391
392
393
394
395
 
# File 'lib/google/cloud/logging/project.rb', line 390

def resource type, labels = {}
  Resource.new.tap do |r|
    r.type = type
    r.labels = labels
  end
end

#resource_descriptors(token: nil, max: nil) ⇒ Array<Google::Cloud::Logging::ResourceDescriptor> Also known as: find_resource_descriptors

Retrieves the list of monitored resource descriptors that are used by Stackdriver Logging.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
logging = gcloud.logging
resource_descriptors = logging.resource_descriptors
resource_descriptors.each do |rd|
  label_keys = rd.labels.map(&:key).join(", ")
  puts "#{rd.type} (#{label_keys})"
end

Pagination:

require "google/cloud"

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

resource_descriptors.all do |rd|
  puts rd.type
end

Parameters:

  • token (String) —

    A previously-returned page token representing part of the larger set of results to view.

  • max (Integer) —

    Maximum number of resource descriptors to return.

Returns:

See Also:



368
369
370
371
372
 
# File 'lib/google/cloud/logging/project.rb', line 368

def resource_descriptors token: nil, max: nil
  ensure_service!
  list_grpc = service.list_resource_descriptors token: token, max: max
  ResourceDescriptor::List.from_grpc list_grpc, service, max
end

#sink(sink_name) ⇒ Google::Cloud::Logging::Sink? Also known as: get_sink, find_sink

Retrieves a sink by name.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
logging = gcloud.logging
sink = logging.sink "existing-sink"

By default nil will be returned if the sink does not exist.

require "google/cloud"

gcloud = Google::Cloud.new
logging = gcloud.logging
sink = logging.sink "non-existing-sink" #=> nil

Parameters:

  • sink_name (String) —

    Name of a sink.

Returns:



525
526
527
528
529
530
531
 
# File 'lib/google/cloud/logging/project.rb', line 525

def sink sink_name
  ensure_service!
  grpc = service.get_sink sink_name
  Sink.from_grpc grpc, service
rescue Google::Cloud::NotFoundError
  nil
end

#sinks(token: nil, max: nil) ⇒ Array<Google::Cloud::Logging::Sink> Also known as: find_sinks

Retrieves the list of sinks belonging to the project.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
logging = gcloud.logging
sinks = logging.sinks
sinks.each do |s|
  puts "#{s.name}: #{s.filter} -> #{s.destination}"
end

Retrieve all sinks: (See Sink::List#all)

require "google/cloud"

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

sinks.all do |s|
  puts "#{s.name}: #{s.filter} -> #{s.destination}"
end

Parameters:

  • token (String) —

    A previously-returned page token representing part of the larger set of results to view.

  • max (Integer) —

    Maximum number of sinks to return.

Returns:



429
430
431
432
433
 
# File 'lib/google/cloud/logging/project.rb', line 429

def sinks token: nil, max: nil
  ensure_service!
  list_grpc = service.list_sinks token: token, max: max
  Sink::List.from_grpc list_grpc, service, max
end

#write_entries(entries, log_name: nil, resource: nil, labels: nil) ⇒ Boolean

Writes log entries to the Stackdriver Logging service.

If you write a collection of log entries, you can provide the log name, resource, and/or labels hash to be used for all of the entries, and omit these values from the individual entries.

Examples:

require "google/cloud"

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

entry = logging.entry payload: "Job started.",
                      log_name: "my_app_log"
entry.resource.type = "gae_app"
entry.resource.labels[:module_id] = "1"
entry.resource.labels[:version_id] = "20150925t173233"

logging.write_entries entry

Optionally pass log name, resource, and labels for entries.

require "google/cloud"

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

entry1 = logging.entry payload: "Job started."
entry2 = logging.entry payload: "Job completed."

labels = { job_size: "large", job_code: "red" }
resource = logging.resource "gae_app",
                            "module_id" => "1",
                            "version_id" => "20150925t173233"

logging.write_entries [entry1, entry2],
                      log_name: "my_app_log",
                      resource: resource,
                      labels: labels

Parameters:

  • entries (Google::Cloud::Logging::Entry, Array<Google::Cloud::Logging::Entry>) —

    One or more entry objects to write. The log entries must have values for all required fields.

  • log_name (String) —

    A default log ID for those log entries in entries that do not specify their own log_name. See also Entry#log_name=.

  • resource (Resource) —

    A default monitored resource for those log entries in entries that do not specify their own resource. See also Entry#resource.

  • labels (Hash{Symbol,String => String}) —

    User-defined key:value items that are added to the labels field of each log entry in entries, except when a log entry specifies its own key:value item with the same key. See also Entry#labels=.

Returns:

  • (Boolean) —

    Returns true if the entries were written.



267
268
269
270
271
272
273
 
# File 'lib/google/cloud/logging/project.rb', line 267

def write_entries entries, log_name: nil, resource: nil, labels: nil
  ensure_service!
  service.write_entries Array(entries).map(&:to_grpc),
                        log_name: log_name, resource: resource,
                        labels: labels
  true
end