Class: Google::Cloud::Logging::V2::LoggingService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Logging::V2::LoggingService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/logging/v2/logging_service/client.rb
Overview
Client for the LoggingService service.
Service for ingesting and querying logs.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the LoggingService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the LoggingService Client instance.
-
#delete_log(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes all the log entries in a log.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new LoggingService client object.
-
#list_log_entries(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogEntry>
Lists log entries.
-
#list_logs(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Logging::V2::ListLogsResponse
Lists the logs in projects, organizations, folders, or billing accounts.
-
#list_monitored_resource_descriptors(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResourceDescriptor>
Lists the descriptors for monitored resource types used by Logging.
-
#write_log_entries(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Logging::V2::WriteLogEntriesResponse
Writes log entries to Logging.
Methods included from Paths
#billing_account_path, #folder_path, #log_path, #organization_path, #project_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new LoggingService client object.
Examples
To create a new LoggingService client with the default configuration:
client = ::Google::Cloud::Logging::V2::LoggingService::Client.new
To create a new LoggingService client with a custom configuration:
client = ::Google::Cloud::Logging::V2::LoggingService::Client.new do |config|
config.timeout = 10.0
end
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 |
# File 'lib/google/cloud/logging/v2/logging_service/client.rb', line 154 def initialize # 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 "gapic/grpc" require "google/logging/v2/logging_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials credentials ||= Credentials.default scope: @config.scope if credentials.is_a?(String) || credentials.is_a?(Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @logging_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Logging::V2::LoggingServiceV2::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the LoggingService Client class.
See Configuration for a description of the configuration fields.
Example
To modify the configuration for all LoggingService clients:
::Google::Cloud::Logging::V2::LoggingService::Client.configure do |config|
config.timeout = 10.0
end
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 |
# File 'lib/google/cloud/logging/v2/logging_service/client.rb', line 57 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Logging", "V2"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const&.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.delete_log.timeout = 60.0 default_config.rpcs.delete_log.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["DEADLINE_EXCEEDED", "INTERNAL", "UNAVAILABLE"] } default_config.rpcs.write_log_entries.timeout = 60.0 default_config.rpcs.write_log_entries.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["DEADLINE_EXCEEDED", "INTERNAL", "UNAVAILABLE"] } default_config.rpcs.list_log_entries.timeout = 60.0 default_config.rpcs.list_log_entries.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["DEADLINE_EXCEEDED", "INTERNAL", "UNAVAILABLE"] } default_config.rpcs.list_monitored_resource_descriptors.timeout = 60.0 default_config.rpcs.list_monitored_resource_descriptors.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["DEADLINE_EXCEEDED", "INTERNAL", "UNAVAILABLE"] } default_config.rpcs.list_logs.timeout = 60.0 default_config.rpcs.list_logs.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: ["DEADLINE_EXCEEDED", "INTERNAL", "UNAVAILABLE"] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the LoggingService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
129 130 131 132 |
# File 'lib/google/cloud/logging/v2/logging_service/client.rb', line 129 def configure yield @config if block_given? @config end |
#delete_log(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_log(log_name: nil) ⇒ ::Google::Protobuf::Empty
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. Entries received after the delete operation with a timestamp before the operation will be deleted.
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 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/google/cloud/logging/v2/logging_service/client.rb', line 230 def delete_log request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::DeleteLogRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_log..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Logging::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "log_name" => request.log_name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_log.timeout, metadata: , retry_policy: @config.rpcs.delete_log.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @logging_service_stub.call_rpc :delete_log, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_log_entries(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogEntry> #list_log_entries(resource_names: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Logging::V2::LogEntry>
Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs.
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 |
# File 'lib/google/cloud/logging/v2/logging_service/client.rb', line 464 def list_log_entries request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::ListLogEntriesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_log_entries..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Logging::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_log_entries.timeout, metadata: , retry_policy: @config.rpcs.list_log_entries.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @logging_service_stub.call_rpc :list_log_entries, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @logging_service_stub, :list_log_entries, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_logs(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::ListLogsResponse #list_logs(parent: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::Logging::V2::ListLogsResponse
Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 |
# File 'lib/google/cloud/logging/v2/logging_service/client.rb', line 608 def list_logs request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::ListLogsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_logs..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Logging::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_logs.timeout, metadata: , retry_policy: @config.rpcs.list_logs.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @logging_service_stub.call_rpc :list_logs, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_monitored_resource_descriptors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResourceDescriptor> #list_monitored_resource_descriptors(page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Api::MonitoredResourceDescriptor>
Lists the descriptors for monitored resource types used by Logging.
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 |
# File 'lib/google/cloud/logging/v2/logging_service/client.rb', line 532 def list_monitored_resource_descriptors request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::ListMonitoredResourceDescriptorsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_monitored_resource_descriptors..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Logging::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_monitored_resource_descriptors.timeout, metadata: , retry_policy: @config.rpcs.list_monitored_resource_descriptors.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @logging_service_stub.call_rpc :list_monitored_resource_descriptors, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @logging_service_stub, :list_monitored_resource_descriptors, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#write_log_entries(request, options = nil) ⇒ ::Google::Cloud::Logging::V2::WriteLogEntriesResponse #write_log_entries(log_name: nil, resource: nil, labels: nil, entries: nil, partial_success: nil, dry_run: nil) ⇒ ::Google::Cloud::Logging::V2::WriteLogEntriesResponse
Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 |
# File 'lib/google/cloud/logging/v2/logging_service/client.rb', line 367 def write_log_entries request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Logging::V2::WriteLogEntriesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.write_log_entries..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Logging::V2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.write_log_entries.timeout, metadata: , retry_policy: @config.rpcs.write_log_entries.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @logging_service_stub.call_rpc :write_log_entries, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |