1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
# Copyright 2016 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
##
# This file is here to be autorequired by bundler, so that the
# Google::Cloud.logging and Google::Cloud#logging methods can be available, but
# the library and all dependencies won't be loaded until required and used.
gem "google-cloud-core"
require "google/cloud" unless defined? Google::Cloud.new
require "google/cloud/config"
require "googleauth"
module Google
module Cloud
##
# 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
# {file:AUTHENTICATION.md Authentication Guide}.
#
# @param [String, Array<String>] scope 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](https://developers.google.com/identity/protocols/OAuth2).
#
# The default scope is:
#
# * `https://www.googleapis.com/auth/logging.admin`
#
# @param [Integer] timeout Default timeout to use in requests. Optional.
#
# @return [Google::Cloud::Logging::Project]
#
# @example
# 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
#
# @example 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
#
def logging scope: nil, timeout: nil
timeout ||= @timeout
Google::Cloud.logging @project, @keyfile, scope: scope,
timeout: timeout
end
##
# 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
# {file:AUTHENTICATION.md Authentication Guide}.
#
# @param [String] project_id Project identifier for the Stackdriver Logging
# service you are connecting to. If not present, the default project for
# the credentials is used.
# @param [Google::Auth::Credentials] 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
# )
# @param [String, Array<String>] scope 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](https://developers.google.com/identity/protocols/OAuth2).
#
# The default scope is:
#
# * `https://www.googleapis.com/auth/logging.admin`
#
# @param [Integer] timeout Default timeout to use in requests. Optional.
#
# @return [Google::Cloud::Logging::Project]
#
# @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
#
def self.logging project_id = nil, credentials = nil, scope: nil, timeout: nil
require "google/cloud/logging"
Google::Cloud::Logging.new project_id: project_id,
credentials: credentials,
scope: scope, timeout: timeout
end
end
end
# Add logging to top-level configuration
Google::Cloud.configure do |config|
unless config.field? :use_logging
config.add_field! :use_logging, nil, enum: [true, false]
end
end
# Set the default logging configuration
Google::Cloud.configure.add_config! :logging do |config|
default_project = Google::Cloud::Config.deferred do
ENV["LOGGING_PROJECT"]
end
default_creds = Google::Cloud::Config.deferred do
Google::Cloud::Config.credentials_from_env \
"LOGGING_CREDENTIALS", "LOGGING_CREDENTIALS_JSON",
"LOGGING_KEYFILE", "LOGGING_KEYFILE_JSON"
end
default_scopes = [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
"https://www.googleapis.com/auth/logging.admin",
"https://www.googleapis.com/auth/logging.read",
"https://www.googleapis.com/auth/logging.write"
]
config.add_field! :project_id, default_project, match: String, allow_nil: true
config.add_alias! :project, :project_id
config.add_field! :credentials, default_creds,
match: [String, Hash, Google::Auth::Credentials],
allow_nil: true
config.add_alias! :keyfile, :credentials
config.add_field! :scope, default_scopes, match: [String, Array]
config.add_field! :quota_project, nil, match: String
config.add_field! :timeout, nil, match: Integer
config.add_field! :endpoint, "logging.googleapis.com", match: String
config.add_field! :log_name, nil, match: String
config.add_field! :log_name_map, nil, match: Hash
config.add_field! :labels, nil, match: Hash
config.add_config! :monitored_resource do |mrconfig|
mrconfig.add_field! :type, nil, match: String
mrconfig.add_field! :labels, nil, match: Hash
end
config.add_field! :set_default_logger_on_rails_init, nil, enum: [true, false]
config.add_field! :on_error, nil, match: Proc
end
|
