Class: Google::Cloud::Logging::V2::LoggingServiceV2Client
- Inherits:
-
Object
- Object
- Google::Cloud::Logging::V2::LoggingServiceV2Client
- Defined in:
- lib/google/cloud/logging/v2/logging_service_v2_client.rb
Overview
Service for ingesting and querying logs.
Constant Summary collapse
- SERVICE_ADDRESS =
The default address of the service.
"logging.googleapis.com".freeze
- DEFAULT_SERVICE_PORT =
The default port of the service.
443
- GRPC_INTERCEPTORS =
The default set of gRPC interceptors.
[]
- DEFAULT_TIMEOUT =
30
- ALL_SCOPES =
The scopes needed to make gRPC calls to all of the methods defined in this service.
[ "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" ].freeze
Class Method Summary collapse
-
.log_path(project, log) ⇒ String
Returns a fully-qualified log resource name string.
-
.project_path(project) ⇒ String
Returns a fully-qualified project resource name string.
Instance Method Summary collapse
-
#delete_log(log_name, options: nil) {|result, operation| ... } ⇒ Object
Deletes all the log entries in a log.
-
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ LoggingServiceV2Client
constructor
A new instance of LoggingServiceV2Client.
-
#list_log_entries(resource_names, project_ids: nil, filter: nil, order_by: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Logging::V2::LogEntry>
Lists log entries.
-
#list_logs(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<String>
Lists the logs in projects, organizations, folders, or billing accounts.
-
#list_monitored_resource_descriptors(page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Api::MonitoredResourceDescriptor>
Lists the descriptors for monitored resource types used by Stackdriver Logging.
-
#write_log_entries(entries, log_name: nil, resource: nil, labels: nil, partial_success: nil, dry_run: nil, options: nil) {|result, operation| ... } ⇒ Google::Logging::V2::WriteLogEntriesResponse
Writes log entries to Stackdriver Logging.
Constructor Details
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ LoggingServiceV2Client
Returns a new instance of LoggingServiceV2Client
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 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/google/cloud/logging/v2/logging_service_v2_client.rb', line 154 def initialize \ credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "" # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "google/gax/grpc" require "google/logging/v2/logging_services_pb" credentials ||= Google::Cloud::Logging::V2::Credentials.default if credentials.is_a?(String) || credentials.is_a?(Hash) updater_proc = Google::Cloud::Logging::V2::Credentials.new(credentials).updater_proc end if credentials.is_a?(GRPC::Core::Channel) channel = credentials end if credentials.is_a?(GRPC::Core::ChannelCredentials) chan_creds = credentials end if credentials.is_a?(Proc) updater_proc = credentials end if credentials.is_a?(Google::Auth::Credentials) updater_proc = credentials.updater_proc end package_version = Gem.loaded_specs['google-cloud-logging'].version.version google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}" google_api_client << " grpc/#{GRPC::VERSION}" google_api_client.freeze headers = { :"x-goog-api-client" => google_api_client } headers.merge!() unless .nil? client_config_file = Pathname.new(__dir__).join( "logging_service_v2_client_config.json" ) defaults = client_config_file.open do |f| Google::Gax.construct_settings( "google.logging.v2.LoggingServiceV2", JSON.parse(f.read), client_config, Google::Gax::Grpc::STATUS_CODE_NAMES, timeout, bundle_descriptors: BUNDLE_DESCRIPTORS, page_descriptors: PAGE_DESCRIPTORS, errors: Google::Gax::Grpc::API_ERRORS, metadata: headers ) end # Allow overriding the service path/port in subclasses. service_path = self.class::SERVICE_ADDRESS port = self.class::DEFAULT_SERVICE_PORT interceptors = self.class::GRPC_INTERCEPTORS @logging_service_v2_stub = Google::Gax::Grpc.create_stub( service_path, port, chan_creds: chan_creds, channel: channel, updater_proc: updater_proc, scopes: scopes, interceptors: interceptors, &Google::Logging::V2::LoggingServiceV2::Stub.method(:new) ) @delete_log = Google::Gax.create_api_call( @logging_service_v2_stub.method(:delete_log), defaults["delete_log"], exception_transformer: exception_transformer ) @write_log_entries = Google::Gax.create_api_call( @logging_service_v2_stub.method(:write_log_entries), defaults["write_log_entries"], exception_transformer: exception_transformer ) @list_log_entries = Google::Gax.create_api_call( @logging_service_v2_stub.method(:list_log_entries), defaults["list_log_entries"], exception_transformer: exception_transformer ) @list_monitored_resource_descriptors = Google::Gax.create_api_call( @logging_service_v2_stub.method(:list_monitored_resource_descriptors), defaults["list_monitored_resource_descriptors"], exception_transformer: exception_transformer ) @list_logs = Google::Gax.create_api_call( @logging_service_v2_stub.method(:list_logs), defaults["list_logs"], exception_transformer: exception_transformer ) end |
Class Method Details
.log_path(project, log) ⇒ String
Returns a fully-qualified log resource name string.
109 110 111 112 113 114 |
# File 'lib/google/cloud/logging/v2/logging_service_v2_client.rb', line 109 def self.log_path project, log LOG_PATH_TEMPLATE.render( :"project" => project, :"log" => log ) end |
.project_path(project) ⇒ String
Returns a fully-qualified project resource name string.
119 120 121 122 123 |
# File 'lib/google/cloud/logging/v2/logging_service_v2_client.rb', line 119 def self.project_path project PROJECT_PATH_TEMPLATE.render( :"project" => project ) end |
Instance Method Details
#delete_log(log_name, options: nil) {|result, operation| ... } ⇒ Object
Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.
290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/google/cloud/logging/v2/logging_service_v2_client.rb', line 290 def delete_log \ log_name, options: nil, &block req = { log_name: log_name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Logging::V2::DeleteLogRequest) @delete_log.call(req, , &block) nil end |
#list_log_entries(resource_names, project_ids: nil, filter: nil, order_by: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Logging::V2::LogEntry>
Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 |
# File 'lib/google/cloud/logging/v2/logging_service_v2_client.rb', line 489 def list_log_entries \ resource_names, project_ids: nil, filter: nil, order_by: nil, page_size: nil, options: nil, &block req = { resource_names: resource_names, project_ids: project_ids, filter: filter, order_by: order_by, page_size: page_size }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Logging::V2::ListLogEntriesRequest) @list_log_entries.call(req, , &block) end |
#list_logs(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<String>
Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.
605 606 607 608 609 610 611 612 613 614 615 616 |
# File 'lib/google/cloud/logging/v2/logging_service_v2_client.rb', line 605 def list_logs \ parent, page_size: nil, options: nil, &block req = { parent: parent, page_size: page_size }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Logging::V2::ListLogsRequest) @list_logs.call(req, , &block) end |
#list_monitored_resource_descriptors(page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Api::MonitoredResourceDescriptor>
Lists the descriptors for monitored resource types used by Stackdriver Logging.
547 548 549 550 551 552 553 554 555 556 |
# File 'lib/google/cloud/logging/v2/logging_service_v2_client.rb', line 547 def list_monitored_resource_descriptors \ page_size: nil, options: nil, &block req = { page_size: page_size }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Logging::V2::ListMonitoredResourceDescriptorsRequest) @list_monitored_resource_descriptors.call(req, , &block) end |
#write_log_entries(entries, log_name: nil, resource: nil, labels: nil, partial_success: nil, dry_run: nil, options: nil) {|result, operation| ... } ⇒ Google::Logging::V2::WriteLogEntriesResponse
Writes log entries to Stackdriver Logging. This API method is the only way to send log entries to Stackdriver Logging. This method is used, directly or indirectly, by the Stackdriver Logging agent (fluentd) and all logging libraries configured to use Stackdriver Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'lib/google/cloud/logging/v2/logging_service_v2_client.rb', line 394 def write_log_entries \ entries, log_name: nil, resource: nil, labels: nil, partial_success: nil, dry_run: nil, options: nil, &block req = { entries: entries, log_name: log_name, resource: resource, labels: labels, partial_success: partial_success, dry_run: dry_run }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Logging::V2::WriteLogEntriesRequest) @write_log_entries.call(req, , &block) end |