google-cloud-logging 0.20.0

data/lib/google/cloud/logging/v2/metrics_service_v2_api.rb

@@ -0,0 +1,330 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# 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
+#
+# http://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.
+#
+# EDITING INSTRUCTIONS
+# This file was generated from the file
+# https://github.com/googleapis/googleapis/blob/master/google/logging/v2/logging_metrics.proto,
+# and updates to that file get reflected here through a refresh process.
+# For the short term, the refresh process will only be runnable by Google
+# engineers.
+#
+# The only allowed edits are to method and file documentation. A 3-way
+# merge preserves those additions if the generated source changes.
+
+require "json"
+require "pathname"
+
+require "google/gax"
+require "google/logging/v2/logging_metrics_services_pb"
+
+module Google
+  module Cloud
+    module Logging
+      module V2
+        # Service for configuring logs-based metrics.
+        #
+        # @!attribute [r] stub
+        #   @return [Google::Logging::V2::MetricsServiceV2::Stub]
+        class MetricsServiceV2Api
+          attr_reader :stub
+
+          # The default address of the service.
+          SERVICE_ADDRESS = "logging.googleapis.com".freeze
+
+          # The default port of the service.
+          DEFAULT_SERVICE_PORT = 443
+
+          CODE_GEN_NAME_VERSION = "gapic/0.1.0".freeze
+
+          DEFAULT_TIMEOUT = 30
+
+          PAGE_DESCRIPTORS = {
+            "list_log_metrics" => Google::Gax::PageDescriptor.new(
+              "page_token",
+              "next_page_token",
+              "metrics")
+          }.freeze
+
+          private_constant :PAGE_DESCRIPTORS
+
+          # The scopes needed to make gRPC calls to all of the methods defined in
+          # this service.
+          ALL_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"
+          ].freeze
+
+          PARENT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}"
+          )
+
+          private_constant :PARENT_PATH_TEMPLATE
+
+          METRIC_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/metrics/{metric}"
+          )
+
+          private_constant :METRIC_PATH_TEMPLATE
+
+          # Returns a fully-qualified parent resource name string.
+          # @param project [String]
+          # @return [String]
+          def self.parent_path project
+            PARENT_PATH_TEMPLATE.render(
+              :"project" => project
+            )
+          end
+
+          # Returns a fully-qualified metric resource name string.
+          # @param project [String]
+          # @param metric [String]
+          # @return [String]
+          def self.metric_path project, metric
+            METRIC_PATH_TEMPLATE.render(
+              :"project" => project,
+              :"metric" => metric
+            )
+          end
+
+          # Parses the project from a parent resource.
+          # @param parent_name [String]
+          # @return [String]
+          def self.match_project_from_parent_name parent_name
+            PARENT_PATH_TEMPLATE.match(parent_name)["project"]
+          end
+
+          # Parses the project from a metric resource.
+          # @param metric_name [String]
+          # @return [String]
+          def self.match_project_from_metric_name metric_name
+            METRIC_PATH_TEMPLATE.match(metric_name)["project"]
+          end
+
+          # Parses the metric from a metric resource.
+          # @param metric_name [String]
+          # @return [String]
+          def self.match_metric_from_metric_name metric_name
+            METRIC_PATH_TEMPLATE.match(metric_name)["metric"]
+          end
+
+          # @param service_path [String]
+          #   The domain name of the API remote host.
+          # @param port [Integer]
+          #   The port on which to connect to the remote host.
+          # @param channel [Channel]
+          #   A Channel object through which to make calls.
+          # @param chan_creds [Grpc::ChannelCredentials]
+          #   A ChannelCredentials for the setting up the RPC client.
+          # @param client_config[Hash]
+          #   A Hash for call options for each method. See
+          #   Google::Gax#construct_settings for the structure of
+          #   this data. Falls back to the default config if not specified
+          #   or the specified config is missing data points.
+          # @param timeout [Numeric]
+          #   The default timeout, in seconds, for calls made through this client.
+          # @param app_name [String]
+          #   The codename of the calling service.
+          # @param app_version [String]
+          #   The version of the calling service.
+          def initialize \
+              service_path: SERVICE_ADDRESS,
+              port: DEFAULT_SERVICE_PORT,
+              channel: nil,
+              chan_creds: nil,
+              scopes: ALL_SCOPES,
+              client_config: {},
+              timeout: DEFAULT_TIMEOUT,
+              app_name: "gax",
+              app_version: Google::Gax::VERSION
+            google_api_client = "#{app_name}/#{app_version} " \
+              "#{CODE_GEN_NAME_VERSION} ruby/#{RUBY_VERSION}".freeze
+            headers = { :"x-goog-api-client" => google_api_client }
+            client_config_file = Pathname.new(__dir__).join(
+              "metrics_service_v2_client_config.json"
+            )
+            defaults = client_config_file.open do |f|
+              Google::Gax.construct_settings(
+                "google.logging.v2.MetricsServiceV2",
+                JSON.parse(f.read),
+                client_config,
+                Google::Gax::Grpc::STATUS_CODE_NAMES,
+                timeout,
+                page_descriptors: PAGE_DESCRIPTORS,
+                errors: Google::Gax::Grpc::API_ERRORS,
+                kwargs: headers
+              )
+            end
+            @stub = Google::Gax::Grpc.create_stub(
+              service_path,
+              port,
+              chan_creds: chan_creds,
+              channel: channel,
+              scopes: scopes,
+              &Google::Logging::V2::MetricsServiceV2::Stub.method(:new)
+            )
+
+            @list_log_metrics = Google::Gax.create_api_call(
+              @stub.method(:list_log_metrics),
+              defaults["list_log_metrics"]
+            )
+            @get_log_metric = Google::Gax.create_api_call(
+              @stub.method(:get_log_metric),
+              defaults["get_log_metric"]
+            )
+            @create_log_metric = Google::Gax.create_api_call(
+              @stub.method(:create_log_metric),
+              defaults["create_log_metric"]
+            )
+            @update_log_metric = Google::Gax.create_api_call(
+              @stub.method(:update_log_metric),
+              defaults["update_log_metric"]
+            )
+            @delete_log_metric = Google::Gax.create_api_call(
+              @stub.method(:delete_log_metric),
+              defaults["delete_log_metric"]
+            )
+          end
+
+          # Service calls
+
+          # Lists logs-based metrics.
+          #
+          # @param parent [String]
+          #   Required. The resource name containing the metrics.
+          #   Example: +"projects/my-project-id"+.
+          # @param page_size [Integer]
+          #   The maximum number of resources contained in the underlying API
+          #   response. If page streaming is performed per-resource, this
+          #   parameter does not affect the return value. If page streaming is
+          #   performed per-page, this determines the maximum number of
+          #   resources in a page.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Gax::PagedEnumerable<Google::Logging::V2::LogMetric>]
+          #   An enumerable of Google::Logging::V2::LogMetric instances.
+          #   See Google::Gax::PagedEnumerable documentation for other
+          #   operations such as per-page iteration or access to the response
+          #   object.
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          def list_log_metrics \
+              parent,
+              page_size: nil,
+              options: nil
+            req = Google::Logging::V2::ListLogMetricsRequest.new(
+              parent: parent
+            )
+            req.page_size = page_size unless page_size.nil?
+            @list_log_metrics.call(req, options)
+          end
+
+          # Gets a logs-based metric.
+          #
+          # @param metric_name [String]
+          #   The resource name of the desired metric.
+          #   Example: +"projects/my-project-id/metrics/my-metric-id"+.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Logging::V2::LogMetric]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          def get_log_metric \
+              metric_name,
+              options: nil
+            req = Google::Logging::V2::GetLogMetricRequest.new(
+              metric_name: metric_name
+            )
+            @get_log_metric.call(req, options)
+          end
+
+          # Creates a logs-based metric.
+          #
+          # @param parent [String]
+          #   The resource name of the project in which to create the metric.
+          #   Example: +"projects/my-project-id"+.
+          #
+          #   The new metric must be provided in the request.
+          # @param metric [Google::Logging::V2::LogMetric]
+          #   The new logs-based metric, which must not have an identifier that
+          #   already exists.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Logging::V2::LogMetric]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          def create_log_metric \
+              parent,
+              metric,
+              options: nil
+            req = Google::Logging::V2::CreateLogMetricRequest.new(
+              parent: parent,
+              metric: metric
+            )
+            @create_log_metric.call(req, options)
+          end
+
+          # Creates or updates a logs-based metric.
+          #
+          # @param metric_name [String]
+          #   The resource name of the metric to update.
+          #   Example: +"projects/my-project-id/metrics/my-metric-id"+.
+          #
+          #   The updated metric must be provided in the request and have the
+          #   same identifier that is specified in +metricName+.
+          #   If the metric does not exist, it is created.
+          # @param metric [Google::Logging::V2::LogMetric]
+          #   The updated metric, whose name must be the same as the
+          #   metric identifier in +metricName+. If +metricName+ does not
+          #   exist, then a new metric is created.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Logging::V2::LogMetric]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          def update_log_metric \
+              metric_name,
+              metric,
+              options: nil
+            req = Google::Logging::V2::UpdateLogMetricRequest.new(
+              metric_name: metric_name,
+              metric: metric
+            )
+            @update_log_metric.call(req, options)
+          end
+
+          # Deletes a logs-based metric.
+          #
+          # @param metric_name [String]
+          #   The resource name of the metric to delete.
+          #   Example: +"projects/my-project-id/metrics/my-metric-id"+.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          def delete_log_metric \
+              metric_name,
+              options: nil
+            req = Google::Logging::V2::DeleteLogMetricRequest.new(
+              metric_name: metric_name
+            )
+            @delete_log_metric.call(req, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/logging/v2/metrics_service_v2_client_config.json

@@ -0,0 +1,53 @@
+{
+  "interfaces": {
+    "google.logging.v2.MetricsServiceV2": {
+      "retry_codes": {
+        "retry_codes_def": {
+          "idempotent": [
+            "DEADLINE_EXCEEDED",
+            "UNAVAILABLE"
+          ],
+          "non_idempotent": []
+        }
+      },
+      "retry_params": {
+        "default": {
+          "initial_retry_delay_millis": 100,
+          "retry_delay_multiplier": 1.2,
+          "max_retry_delay_millis": 1000,
+          "initial_rpc_timeout_millis": 2000,
+          "rpc_timeout_multiplier": 1.5,
+          "max_rpc_timeout_millis": 30000,
+          "total_timeout_millis": 45000
+        }
+      },
+      "methods": {
+        "ListLogMetrics": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "GetLogMetric": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        },
+        "CreateLogMetric": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "UpdateLogMetric": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "DeleteLogMetric": {
+          "timeout_millis": 30000,
+          "retry_codes_name": "idempotent",
+          "retry_params_name": "default"
+        }
+      }
+    }
+  }
+}

data/lib/google/cloud/logging/version.rb

@@ -0,0 +1,22 @@
+# Copyright 2016 Google Inc. All rights reserved.
+#
+# 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
+#
+#     http://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.
+
+
+module Google
+  module Cloud
+    module Logging
+      VERSION = "0.20.0"
+    end
+  end
+end

data/lib/google/logging/v2/log_entry_pb.rb

@@ -0,0 +1,44 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/logging/v2/log_entry.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/monitored_resource_pb'
+require 'google/logging/type/http_request_pb'
+require 'google/logging/type/log_severity_pb'
+require 'google/protobuf/any_pb'
+require 'google/protobuf/struct_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.logging.v2.LogEntry" do
+    optional :log_name, :string, 12
+    optional :resource, :message, 8, "google.api.MonitoredResource"
+    optional :timestamp, :message, 9, "google.protobuf.Timestamp"
+    optional :severity, :enum, 10, "google.logging.type.LogSeverity"
+    optional :insert_id, :string, 4
+    optional :http_request, :message, 7, "google.logging.type.HttpRequest"
+    map :labels, :string, :string, 11
+    optional :operation, :message, 15, "google.logging.v2.LogEntryOperation"
+    oneof :payload do
+      optional :proto_payload, :message, 2, "google.protobuf.Any"
+      optional :text_payload, :string, 3
+      optional :json_payload, :message, 6, "google.protobuf.Struct"
+    end
+  end
+  add_message "google.logging.v2.LogEntryOperation" do
+    optional :id, :string, 1
+    optional :producer, :string, 2
+    optional :first, :bool, 3
+    optional :last, :bool, 4
+  end
+end
+
+module Google
+  module Logging
+    module V2
+      LogEntry = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.LogEntry").msgclass
+      LogEntryOperation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.logging.v2.LogEntryOperation").msgclass
+    end
+  end
+end